Merge pull request #147 from apivideo/ai-summary-updates

bot-api-video · web-flow · commit ffda5ac4a9f4 · 2024-11-08T13:42:34.000+01:00
Update Summary endpoints
diff --git a/.openapi-generator/oas_apivideo.yaml-defaut-cli.sha256 b/.openapi-generator/oas_apivideo.yaml-defaut-cli.sha256
@@ -1 +1 @@
-589578120105165c9f58683fbe2fb917dabfaf9392187865f30956f8e4964d5a
+f2258a85e4233a4243aa1514697cbb72ab9568d8bc147a0ba046e979c1e7bcf9
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,9 @@
 # Changelog
 All changes to this project will be documented in this file.
 
+## [1.6.7] - 2024-11-06
+- AI summary updates
+
 ## [1.6.6] - 2024-11-04
 - Analytics updates (ccv, views, ...)
 
diff --git 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
@@ -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 &#x60;auto&#x60;, 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, &#x60;sourceStatus&#x60; will return &#x60;missing&#x60;, and you have to manually add a summary using the &#x60;PATCH /summaries/{summaryId}/source&#x60; endpoint operation. | [optional] 
+**Attributes** | **List&lt;string&gt;** | 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
@@ -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 &#x60;abstract&#x60; 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&lt;string&gt;** | A list of 3 key points from the video, in chronological order. | [optional] 
 
diff --git 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&lt;string&gt;** | A list of 3 key points from the video, in chronological order. | [optional] 
 
diff --git 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.  &#x60;language&#x60; is a permanent attribute of the video. You can update it to another language using the [&#x60;PATCH /videos/{videoId}&#x60;](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 &#x60;true&#x60;, the API generates a transcript for the video. - The default value is &#x60;false&#x60;. - If you define a video language using the &#x60;language&#x60; 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 &#x60;transcript: true&#x60;.  - When &#x60;true&#x60;, the API generates a summary for the video, based on the transcription. - The default value is &#x60;false&#x60;. - If you define a video language using the &#x60;language&#x60; 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&lt;string&gt;** | 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
@@ -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.  &#x60;language&#x60; is a permanent attribute of the video. You can update it to another language using the [&#x60;PATCH /videos/{videoId}&#x60;](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 &#x60;true&#x60;, the API generates a transcript for the video. - The default value is &#x60;false&#x60;. - If you define a video language using the &#x60;language&#x60; 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 &#x60;true&#x60;, the API generates a summary for the video, based on the transcription. - The default value is &#x60;false&#x60;. - If you define a video language using the &#x60;language&#x60; 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&lt;string&gt;** | 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
@@ -41,7 +41,7 @@ public SummariesApi(ApiClient apiClient)
         }
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <exception cref="ApiVideo.Client.ApiException">Thrown when fails to make API call</exception>
         /// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation. (optional)</param>
@@ -56,7 +56,7 @@ public Task<Summary> createAsync(SummaryCreationPayload summaryCreationPayload,
         }
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <exception cref="ApiVideo.Client.ApiException">Thrown when fails to make API call</exception>
         /// <param name="summaryCreationPayload"></param>
@@ -70,7 +70,7 @@ public Summary create(SummaryCreationPayload summaryCreationPayload)
 
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <exception cref="ApiVideo.Client.ApiException">Thrown when fails to make API call</exception>
         /// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation. (optional)</param>
@@ -85,7 +85,7 @@ public Task<ApiResponse<Summary>> 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<ApiResponse<Summary>> createWithHttpInfoAsync(SummaryCreationPayload
 
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <exception cref="ApiVideo.Client.ApiException">Thrown when fails to make API call</exception>
         /// <param name="summaryCreationPayload"></param>
@@ -157,7 +157,7 @@ public ApiResponse<Summary> 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<Summary> createWithHttpInfo(SummaryCreationPayload summaryCre
 
         
         /// <summary>
-        /// Update summary details Update details for a summary. Note that this operation is only allowed for summary objects where &#x60;sourceStatus&#x60; is &#x60;missing&#x60;.
+        /// Update summary details Update details for a summary.
         /// </summary>
         /// <exception cref="ApiVideo.Client.ApiException">Thrown when fails to make API call</exception>
         /// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation. (optional)</param>
@@ -227,7 +227,7 @@ public Task<SummarySource> updateAsync(string summaryId, SummaryUpdatePayload su
         }
 
         /// <summary>
-        /// Update summary details Update details for a summary. Note that this operation is only allowed for summary objects where &#x60;sourceStatus&#x60; is &#x60;missing&#x60;.
+        /// Update summary details Update details for a summary.
         /// </summary>
         /// <exception cref="ApiVideo.Client.ApiException">Thrown when fails to make API call</exception>
         /// <param name="summaryId">The unique identifier of the summary source you want to update.</param>
@@ -242,7 +242,7 @@ public SummarySource update(string summaryId, SummaryUpdatePayload summaryUpdate
 
 
         /// <summary>
-        /// Update summary details Update details for a summary. Note that this operation is only allowed for summary objects where &#x60;sourceStatus&#x60; is &#x60;missing&#x60;.
+        /// Update summary details Update details for a summary.
         /// </summary>
         /// <exception cref="ApiVideo.Client.ApiException">Thrown when fails to make API call</exception>
         /// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation. (optional)</param>
@@ -255,11 +255,11 @@ public Task<ApiResponse<SummarySource>> 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<ApiResponse<SummarySource>> updateWithHttpInfoAsync(string summaryId
 
 
         /// <summary>
-        /// Update summary details Update details for a summary. Note that this operation is only allowed for summary objects where &#x60;sourceStatus&#x60; is &#x60;missing&#x60;.
+        /// Update summary details Update details for a summary.
         /// </summary>
         /// <exception cref="ApiVideo.Client.ApiException">Thrown when fails to make API call</exception>
         /// <param name="summaryId">The unique identifier of the summary source you want to update.</param>
@@ -333,11 +333,11 @@ public ApiResponse<SummarySource> 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
@@ -85,7 +85,7 @@ public Task<ApiResponse<Video>> 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<Video> createWithHttpInfo(VideoCreationPayload videoCreationP
             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");
@@ -1242,11 +1242,11 @@ public Task<ApiResponse<Video>> updateWithHttpInfoAsync(string videoId, VideoUpd
             if (videoUpdatePayload == null) 
                 throw new ApiException(400,"Missing required parameter 'videoUpdatePayload' when calling VideosApi->update");
             
-                                                                                                                                    
+                                                                                                                                                
             if (videoUpdatePayload == null) 
                 throw new ApiException(400,"Missing required parameter 'videoUpdatePayload' when calling VideosApi->update");
             
-                                                                                                                                    
+                                                                                                                                                
             // verify the required parameter 'videoId' is set
             if (videoId == null)
                 throw new ApiException(400, "Missing required parameter 'videoId' when calling VideosApi->update");
@@ -1326,11 +1326,11 @@ public ApiResponse<Video> updateWithHttpInfo(string videoId, VideoUpdatePayload
             if (videoUpdatePayload == null) 
                 throw new ApiException(400,"Missing required parameter 'videoUpdatePayload' when calling VideosApi->update");
             
-                                                                                                                                    
+                                                                                                                                                
             if (videoUpdatePayload == null) 
                 throw new ApiException(400,"Missing required parameter 'videoUpdatePayload' when calling VideosApi->update");
             
-                                                                                                                                    
+                                                                                                                                                
             // verify the required parameter 'videoId' is set
             if (videoId == null)
                 throw new ApiException(400, "Missing required parameter 'videoId' when calling VideosApi->update");
diff --git a/src/ApiVideo.csproj b/src/ApiVideo.csproj
@@ -13,7 +13,7 @@ The version of the OpenAPI document: 1
     <OutputType>Library</OutputType>
     <PackOnBuild>true</PackOnBuild>
     <PackageId>ApiVideo</PackageId>
-    <PackageVersion>1.6.6</PackageVersion>
+    <PackageVersion>1.6.7</PackageVersion>
     <Authors>api.video</Authors>
     <Description>api.video csharp API client</Description>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
diff --git a/src/Client/ApiClient.cs b/src/Client/ApiClient.cs
@@ -95,7 +95,7 @@ public ApiClient(IRestClient client) {
         private void Initialize(IRestClient client)
         {
             this.RestClient = client;
-            setName("AV-Origin-Client", "csharp", "1.6.6");
+            setName("AV-Origin-Client", "csharp", "1.6.7");
         }
 
         /// <summary>
diff --git a/src/Model/SummaryCreationPayload.cs b/src/Model/SummaryCreationPayload.cs
diff --git a/src/Model/SummarySource.cs b/src/Model/SummarySource.cs
diff --git a/src/Model/SummaryUpdatePayload.cs b/src/Model/SummaryUpdatePayload.cs
diff --git a/src/Model/VideoCreationPayload.cs b/src/Model/VideoCreationPayload.cs
diff --git a/src/Model/VideoUpdatePayload.cs b/src/Model/VideoUpdatePayload.cs

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-589578120105165c9f58683fbe2fb917dabfaf9392187865f30956f8e4964d5a`
	`1`	`+f2258a85e4233a4243aa1514697cbb72ab9568d8bc147a0ba046e979c1e7bcf9`