From 74b9ad9e87dd6eb1093b07922555faa85e384a85 Mon Sep 17 00:00:00 2001 From: szekelyzol Date: Tue, 5 Nov 2024 20:48:46 +0000 Subject: [PATCH] Update Summary endpoints --- .../oas_apivideo.yaml-defaut-cli.sha256 | 2 +- docs/SummariesApi.md | 4 +-- docs/SummaryCreationPayload.md | 1 + docs/SummarySource.md | 1 - docs/SummaryUpdatePayload.md | 1 - docs/VideoCreationPayload.md | 1 + docs/VideoUpdatePayload.md | 1 + src/Api/SummariesApi.cs | 28 +++++++++---------- src/Api/VideosApi.cs | 12 ++++---- src/Model/SummaryCreationPayload.cs | 8 ++++++ src/Model/SummarySource.cs | 8 ------ src/Model/SummaryUpdatePayload.cs | 8 ------ src/Model/VideoCreationPayload.cs | 8 ++++++ src/Model/VideoUpdatePayload.cs | 8 ++++++ 14 files changed, 50 insertions(+), 41 deletions(-) diff --git a/.openapi-generator/oas_apivideo.yaml-defaut-cli.sha256 b/.openapi-generator/oas_apivideo.yaml-defaut-cli.sha256 index 5e5fa75..d97c87b 100644 --- a/.openapi-generator/oas_apivideo.yaml-defaut-cli.sha256 +++ b/.openapi-generator/oas_apivideo.yaml-defaut-cli.sha256 @@ -1 +1 @@ -3c9f9d1c48428c25a16b809ddeab072c978d6d1c689903a76e3d66a69a36a233 \ No newline at end of file +4ae7edf8587ba07687da3931d634008d47a2232885067a33c603c65c22c82430 \ No newline at end of file diff --git a/docs/SummariesApi.md b/docs/SummariesApi.md index 79f635b..65f6da3 100644 --- a/docs/SummariesApi.md +++ b/docs/SummariesApi.md @@ -17,7 +17,7 @@ Method | HTTP request | Description Generate video summary -Generate a title, abstract, and key takeaways for a video. +Generate an abstract and key takeaways for a video. ### Example ```csharp @@ -84,7 +84,7 @@ Name | Type | Description | Notes Update summary details -Update details for a summary. Note that this operation is only allowed for summary objects where `sourceStatus` is `missing`. +Update details for a summary. ### Example ```csharp diff --git a/docs/SummaryCreationPayload.md b/docs/SummaryCreationPayload.md index 9deccef..b64fe38 100644 --- a/docs/SummaryCreationPayload.md +++ b/docs/SummaryCreationPayload.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **VideoId** | **string** | Create a summary of a video using the video ID. | **Origin** | **string** | Use this parameter to define how the API generates the summary. The only allowed value is `auto`, which means that the API generates a summary automatically. If you do not set this parameter, **the API will not generate a summary automatically**. In this case, `sourceStatus` will return `missing`, and you have to manually add a summary using the `PATCH /summaries/{summaryId}/source` endpoint operation. | [optional] +**Attributes** | **List<string>** | Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SummarySource.md b/docs/SummarySource.md index 8124e9e..6dcfb5b 100644 --- a/docs/SummarySource.md +++ b/docs/SummarySource.md @@ -4,7 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Title** | **string** | A video title, based on the contents of the video. | [optional] **Abstract** | **string** | A short outline of the contents of the video. The length of an `abstract` depends on the amount of content in a video that can be transcribed. The API condenses the contents into minimum 20, maximum 300 words. | [optional] **Takeaways** | **List<string>** | A list of 3 key points from the video, in chronological order. | [optional] diff --git a/docs/SummaryUpdatePayload.md b/docs/SummaryUpdatePayload.md index 48e816b..ab92094 100644 --- a/docs/SummaryUpdatePayload.md +++ b/docs/SummaryUpdatePayload.md @@ -4,7 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Title** | **string** | A video title, based on the contents of the video. | [optional] **Abstract** | **string** | A short outline of the contents of the video. | [optional] **Takeaways** | **List<string>** | A list of 3 key points from the video, in chronological order. | [optional] diff --git a/docs/VideoCreationPayload.md b/docs/VideoCreationPayload.md index 27465e3..d3736a7 100644 --- a/docs/VideoCreationPayload.md +++ b/docs/VideoCreationPayload.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes **Language** | **string** | Use this parameter to set the language of the video. When this parameter is set, the API creates a transcript of the video using the language you specify. You must use the [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. `language` is a permanent attribute of the video. You can update it to another language using the [`PATCH /videos/{videoId}`](https://docs.api.video/reference/api/Videos#update-a-video-object) operation. This triggers the API to generate a new transcript using a different language. | [optional] **Transcript** | **bool** | Use this parameter to enable transcription. - When `true`, the API generates a transcript for the video. - The default value is `false`. - If you define a video language using the `language` parameter, the API uses that language to transcribe the video. If you do not define a language, the API detects it based on the video. - When the API generates a transcript, it will be available as a caption for the video. | [optional] **TranscriptSummary** | **bool** | Use this parameter to enable summarization. We recommend using this parameter together with `transcript: true`. - When `true`, the API generates a summary for the video, based on the transcription. - The default value is `false`. - If you define a video language using the `language` parameter, the API uses that language to summarize the video. If you do not define a language, the API detects it based on the video. | [optional] +**TranscriptSummaryAttributes** | **List<string>** | Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/VideoUpdatePayload.md b/docs/VideoUpdatePayload.md index 5923d5b..563665a 100644 --- a/docs/VideoUpdatePayload.md +++ b/docs/VideoUpdatePayload.md @@ -15,6 +15,7 @@ Name | Type | Description | Notes **Language** | **string** | Use this parameter to set the language of the video. When this parameter is set, the API creates a transcript of the video using the language you specify. You must use the [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. `language` is a permanent attribute of the video. You can update it to another language using the [`PATCH /videos/{videoId}`](https://docs.api.video/reference/api/Videos#update-a-video-object) operation. This triggers the API to generate a new transcript using a different language. | [optional] **Transcript** | **bool** | Use this parameter to enable transcription. - When `true`, the API generates a transcript for the video. - The default value is `false`. - If you define a video language using the `language` parameter, the API uses that language to transcribe the video. If you do not define a language, the API detects it based on the video. - When the API generates a transcript, it will be available as a caption for the video. | [optional] **TranscriptSummary** | **bool** | Use this parameter to enable summarization. - When `true`, the API generates a summary for the video, based on the transcription. - The default value is `false`. - If you define a video language using the `language` parameter, the API uses that language to summarize the video. If you do not define a language, the API detects it based on the video. | [optional] +**TranscriptSummaryAttributes** | **List<string>** | Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/Api/SummariesApi.cs b/src/Api/SummariesApi.cs index 5f7424a..827cbdb 100644 --- a/src/Api/SummariesApi.cs +++ b/src/Api/SummariesApi.cs @@ -41,7 +41,7 @@ public SummariesApi(ApiClient apiClient) } /// - /// Generate video summary Generate a title, abstract, and key takeaways for a video. + /// Generate video summary Generate an abstract and key takeaways for a video. /// /// Thrown when fails to make API call /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. (optional) @@ -56,7 +56,7 @@ public Task createAsync(SummaryCreationPayload summaryCreationPayload, } /// - /// Generate video summary Generate a title, abstract, and key takeaways for a video. + /// Generate video summary Generate an abstract and key takeaways for a video. /// /// Thrown when fails to make API call /// @@ -70,7 +70,7 @@ public Summary create(SummaryCreationPayload summaryCreationPayload) /// - /// Generate video summary Generate a title, abstract, and key takeaways for a video. + /// Generate video summary Generate an abstract and key takeaways for a video. /// /// Thrown when fails to make API call /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. (optional) @@ -85,7 +85,7 @@ public Task> createWithHttpInfoAsync(SummaryCreationPayload if (summaryCreationPayload != null && summaryCreationPayload.videoid == null) { throw new ApiException(400,"Missing required parameter 'summaryCreationPayload.VideoId' when calling SummariesApi->create"); } - + // verify the required parameter 'summaryCreationPayload' is set if (summaryCreationPayload == null) throw new ApiException(400, "Missing required parameter 'summaryCreationPayload' when calling SummariesApi->create"); @@ -143,7 +143,7 @@ public Task> createWithHttpInfoAsync(SummaryCreationPayload /// - /// Generate video summary Generate a title, abstract, and key takeaways for a video. + /// Generate video summary Generate an abstract and key takeaways for a video. /// /// Thrown when fails to make API call /// @@ -157,7 +157,7 @@ public ApiResponse createWithHttpInfo(SummaryCreationPayload summaryCre if (summaryCreationPayload != null && summaryCreationPayload.videoid == null) { throw new ApiException(400,"Missing required parameter 'summaryCreationPayload.VideoId' when calling SummariesApi->create"); } - + // verify the required parameter 'summaryCreationPayload' is set if (summaryCreationPayload == null) throw new ApiException(400, "Missing required parameter 'summaryCreationPayload' when calling SummariesApi->create"); @@ -211,7 +211,7 @@ public ApiResponse createWithHttpInfo(SummaryCreationPayload summaryCre /// - /// Update summary details Update details for a summary. Note that this operation is only allowed for summary objects where `sourceStatus` is `missing`. + /// Update summary details Update details for a summary. /// /// Thrown when fails to make API call /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. (optional) @@ -227,7 +227,7 @@ public Task updateAsync(string summaryId, SummaryUpdatePayload su } /// - /// Update summary details Update details for a summary. Note that this operation is only allowed for summary objects where `sourceStatus` is `missing`. + /// Update summary details Update details for a summary. /// /// Thrown when fails to make API call /// The unique identifier of the summary source you want to update. @@ -242,7 +242,7 @@ public SummarySource update(string summaryId, SummaryUpdatePayload summaryUpdate /// - /// Update summary details Update details for a summary. Note that this operation is only allowed for summary objects where `sourceStatus` is `missing`. + /// Update summary details Update details for a summary. /// /// Thrown when fails to make API call /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. (optional) @@ -255,11 +255,11 @@ public Task> updateWithHttpInfoAsync(string summaryId if (summaryUpdatePayload == null) throw new ApiException(400,"Missing required parameter 'summaryUpdatePayload' when calling SummariesApi->update"); - + if (summaryUpdatePayload == null) throw new ApiException(400,"Missing required parameter 'summaryUpdatePayload' when calling SummariesApi->update"); - + // verify the required parameter 'summaryId' is set if (summaryId == null) throw new ApiException(400, "Missing required parameter 'summaryId' when calling SummariesApi->update"); @@ -321,7 +321,7 @@ public Task> updateWithHttpInfoAsync(string summaryId /// - /// Update summary details Update details for a summary. Note that this operation is only allowed for summary objects where `sourceStatus` is `missing`. + /// Update summary details Update details for a summary. /// /// Thrown when fails to make API call /// The unique identifier of the summary source you want to update. @@ -333,11 +333,11 @@ public ApiResponse updateWithHttpInfo(string summaryId, SummaryUp if (summaryUpdatePayload == null) throw new ApiException(400,"Missing required parameter 'summaryUpdatePayload' when calling SummariesApi->update"); - + if (summaryUpdatePayload == null) throw new ApiException(400,"Missing required parameter 'summaryUpdatePayload' when calling SummariesApi->update"); - + // verify the required parameter 'summaryId' is set if (summaryId == null) throw new ApiException(400, "Missing required parameter 'summaryId' when calling SummariesApi->update"); diff --git a/src/Api/VideosApi.cs b/src/Api/VideosApi.cs index 11662d0..71a6ff0 100644 --- a/src/Api/VideosApi.cs +++ b/src/Api/VideosApi.cs @@ -85,7 +85,7 @@ public Task> createWithHttpInfoAsync(VideoCreationPayload vid if (videoCreationPayload != null && videoCreationPayload.title == null) { throw new ApiException(400,"Missing required parameter 'videoCreationPayload.Title' when calling VideosApi->create"); } - + // verify the required parameter 'videoCreationPayload' is set if (videoCreationPayload == null) throw new ApiException(400, "Missing required parameter 'videoCreationPayload' when calling VideosApi->create"); @@ -157,7 +157,7 @@ public ApiResponse [DataContract] public class SummaryUpdatePayload: DeepObject { - /// - /// A video title, based on the contents of the video. - /// - /// A video title, based on the contents of the video. - [DataMember(Name="title", EmitDefaultValue=false)] - [JsonProperty(PropertyName = "title")] - public string title { get; set; } /// /// A short outline of the contents of the video. /// @@ -42,7 +35,6 @@ public class SummaryUpdatePayload: DeepObject { public override string ToString() { var sb = new StringBuilder(); sb.Append("class SummaryUpdatePayload {\n"); - sb.Append(" Title: ").Append(title).Append("\n"); sb.Append(" Abstract: ").Append(_abstract).Append("\n"); sb.Append(" Takeaways: ").Append(takeaways).Append("\n"); sb.Append("}\n"); diff --git a/src/Model/VideoCreationPayload.cs b/src/Model/VideoCreationPayload.cs index 0386db0..c87c4ef 100644 --- a/src/Model/VideoCreationPayload.cs +++ b/src/Model/VideoCreationPayload.cs @@ -108,6 +108,13 @@ public class VideoCreationPayload: DeepObject { [DataMember(Name="transcriptSummary", EmitDefaultValue=false)] [JsonProperty(PropertyName = "transcriptSummary")] public Nullable transcriptsummary { get; set; } + /// + /// Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes. + /// + /// Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes. + [DataMember(Name="transcriptSummaryAttributes", EmitDefaultValue=false)] + [JsonProperty(PropertyName = "transcriptSummaryAttributes")] + public List transcriptsummaryattributes { get; set; } /// @@ -141,6 +148,7 @@ public override string ToString() { sb.Append(" Language: ").Append(language).Append("\n"); sb.Append(" Transcript: ").Append(transcript).Append("\n"); sb.Append(" TranscriptSummary: ").Append(transcriptsummary).Append("\n"); + sb.Append(" TranscriptSummaryAttributes: ").Append(transcriptsummaryattributes).Append("\n"); sb.Append("}\n"); return sb.ToString(); } diff --git a/src/Model/VideoUpdatePayload.cs b/src/Model/VideoUpdatePayload.cs index a4304f3..2080edf 100644 --- a/src/Model/VideoUpdatePayload.cs +++ b/src/Model/VideoUpdatePayload.cs @@ -104,6 +104,13 @@ public string playerid [DataMember(Name="transcriptSummary", EmitDefaultValue=false)] [JsonProperty(PropertyName = "transcriptSummary")] public Nullable transcriptsummary { get; set; } + /// + /// Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes. + /// + /// Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes. + [DataMember(Name="transcriptSummaryAttributes", EmitDefaultValue=false)] + [JsonProperty(PropertyName = "transcriptSummaryAttributes")] + public List transcriptsummaryattributes { get; set; } /// @@ -124,6 +131,7 @@ public override string ToString() { sb.Append(" Language: ").Append(language).Append("\n"); sb.Append(" Transcript: ").Append(transcript).Append("\n"); sb.Append(" TranscriptSummary: ").Append(transcriptsummary).Append("\n"); + sb.Append(" TranscriptSummaryAttributes: ").Append(transcriptsummaryattributes).Append("\n"); sb.Append("}\n"); return sb.ToString(); }