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

Update Summary endpoints

CHANGELOG.md

@@ -1,6 +1,9 @@
 # Changelog
 All changes to this project will be documented in this file.
 
+## [2.6.8] - 2024-11-06
+- AI summary updates
+
 ## [2.6.7] - 2024-11-04
 - Analytics updates (ccv, views, ...)
 

docs/api/SummariesApi.md

@@ -15,7 +15,7 @@ All URIs are relative to *https://ws.api.video*
 ## **`create()` - Generate video summary**
 
 
-Generate a title, abstract, and key takeaways for a video.
+Generate an abstract and key takeaways for a video.
 
 ### Parameters
 
@@ -37,7 +37,7 @@ Promise<[**Summary**](../model/Summary.md)>.
 ## **`update()` - 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.
 
 ### Parameters
 

docs/model/SummaryCreationPayload.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **videoId** | **string** | Create a summary of a video using the video ID. | 
 **origin** | [**SummaryCreationPayloadOriginEnum**](#SummaryCreationPayloadOriginEnum) | 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** | [**Array<SummaryCreationPayloadAttributesEnum>**](#Array<SummaryCreationPayloadAttributesEnum>) | 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]
 
 
 
@@ -18,3 +19,12 @@ Auto | 'auto'
 
 
 
+## Enum: Array<SummaryCreationPayloadAttributesEnum>
+
+Name | Value
+---- | -----
+Abstract | 'abstract'
+Takeaways | 'takeaways'
+
+
+

docs/model/SummarySource.md

@@ -5,7 +5,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** | **Array<string>** | A list of 3 key points from the video, in chronological order. |  [optional]
 

docs/model/SummaryUpdatePayload.md

@@ -5,7 +5,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** | **Array<string>** | A list of 3 key points from the video, in chronological order. |  [optional]
 

docs/model/VideoCreationPayload.md

@@ -19,6 +19,7 @@ Name | Type | Description | Notes
 **language** | [**VideoCreationPayloadLanguageEnum**](#VideoCreationPayloadLanguageEnum) | 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** | **boolean** | 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** | **boolean** | 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** | [**Array<VideoCreationPayloadTranscriptSummaryAttributesEnum>**](#Array<VideoCreationPayloadTranscriptSummaryAttributesEnum>) | 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]
 
 
 
@@ -62,3 +63,12 @@ Zh | 'zh'
 
 
 
+## Enum: Array<VideoCreationPayloadTranscriptSummaryAttributesEnum>
+
+Name | Value
+---- | -----
+Abstract | 'abstract'
+Takeaways | 'takeaways'
+
+
+

docs/model/VideoUpdatePayload.md

@@ -16,6 +16,7 @@ Name | Type | Description | Notes
 **language** | [**VideoUpdatePayloadLanguageEnum**](#VideoUpdatePayloadLanguageEnum) | 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** | **boolean** | 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** | **boolean** | 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** | [**Array<VideoUpdatePayloadTranscriptSummaryAttributesEnum>**](#Array<VideoUpdatePayloadTranscriptSummaryAttributesEnum>) | 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]
 
 
 
@@ -59,3 +60,12 @@ Zh | 'zh'
 
 
 
+## Enum: Array<VideoUpdatePayloadTranscriptSummaryAttributesEnum>
+
+Name | Value
+---- | -----
+Abstract | 'abstract'
+Takeaways | 'takeaways'
+
+
+

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@api.video/nodejs-client",
-  "version": "2.6.7",
+  "version": "2.6.8",
   "description": "api.video nodejs API client",
    "keywords": [
     "api.video",

src/HttpClient.ts

@@ -59,7 +59,7 @@ export default class HttpClient {
     this.chunkSize = params.chunkSize;
     this.headers = new AxiosHeaders({
       Accept: 'application/json, */*;q=0.8',
-      'AV-Origin-Client': 'nodejs:2.6.7',
+      'AV-Origin-Client': 'nodejs:2.6.8',
       Authorization: this.apiKey ? `Basic ${encode(`${this.apiKey}:`)}` : '',
       ...(params.applicationName && params.applicationVersion
         ? {

src/ObjectSerializer.ts

@@ -128,10 +128,13 @@ const enumsMap: Set<string> = new Set<string>([
   'SummaryOriginEnum',
   'SummarySourceStatusEnum',
   'SummaryCreationPayloadOriginEnum',
+  'SummaryCreationPayloadAttributesEnum',
   'VideoLanguageOriginEnum',
   'VideoCreationPayloadLanguageEnum',
+  'VideoCreationPayloadTranscriptSummaryAttributesEnum',
   'VideoStatusIngestStatusEnum',
   'VideoUpdatePayloadLanguageEnum',
+  'VideoUpdatePayloadTranscriptSummaryAttributesEnum',
 ]);
 
 const typeMap: { [index: string]: any } = {

src/api/SummariesApi.ts

@@ -29,7 +29,7 @@ export default class SummariesApi {
   }
 
   /**
-   * Generate a title, abstract, and key takeaways for a video.
+   * Generate an abstract and key takeaways for a video.
    * Generate video summary
    * @param summaryCreationPayload
    */
@@ -42,7 +42,7 @@ export default class SummariesApi {
   }
 
   /**
-   * Generate a title, abstract, and key takeaways for a video.
+   * Generate an abstract and key takeaways for a video.
    * Generate video summary
    * @param summaryCreationPayload
    */
@@ -95,7 +95,7 @@ export default class SummariesApi {
   }
 
   /**
-   * Update details for a summary. Note that this operation is only allowed for summary objects where `sourceStatus` is `missing`.
+   * Update details for a summary.
    * Update summary details
    * @param summaryId The unique identifier of the summary source you want to update.
    * @param summaryUpdatePayload
@@ -110,7 +110,7 @@ export default class SummariesApi {
   }
 
   /**
-   * Update details for a summary. Note that this operation is only allowed for summary objects where `sourceStatus` is `missing`.
+   * Update details for a summary.
    * Update summary details
    * @param summaryId The unique identifier of the summary source you want to update.
    * @param summaryUpdatePayload

src/model/SummaryCreationPayload.ts

@@ -20,6 +20,10 @@ export default class SummaryCreationPayload {
    * 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.
    */
   'origin'?: SummaryCreationPayloadOriginEnum;
+  /**
+   * 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.
+   */
+  'attributes'?: Array<SummaryCreationPayloadAttributesEnum>;
 
   static readonly discriminator?: string = undefined;
 
@@ -36,6 +40,12 @@ export default class SummaryCreationPayload {
       type: 'SummaryCreationPayloadOriginEnum',
       format: '',
     },
+    {
+      name: 'attributes',
+      baseName: 'attributes',
+      type: 'Array<SummaryCreationPayloadAttributesEnum>',
+      format: '',
+    },
   ];
 
   static getAttributeTypeMap(): Array<AttributeType> {
@@ -44,3 +54,4 @@ export default class SummaryCreationPayload {
 }
 
 export type SummaryCreationPayloadOriginEnum = 'auto';
+export type SummaryCreationPayloadAttributesEnum = 'abstract' | 'takeaways';

src/model/SummarySource.ts

@@ -12,10 +12,6 @@
 import AttributeType from './AttributeType.js';
 
 export default class SummarySource {
-  /**
-   * A video title, based on the contents of the video.
-   */
-  'title'?: 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.
    */
@@ -28,12 +24,6 @@ export default class SummarySource {
   static readonly discriminator?: string = undefined;
 
   static readonly attributeTypeMap: Array<AttributeType> = [
-    {
-      name: 'title',
-      baseName: 'title',
-      type: 'string',
-      format: '',
-    },
     {
       name: '_abstract',
       baseName: 'abstract',

src/model/SummaryUpdatePayload.ts

@@ -12,10 +12,6 @@
 import AttributeType from './AttributeType.js';
 
 export default class SummaryUpdatePayload {
-  /**
-   * A video title, based on the contents of the video.
-   */
-  'title'?: string;
   /**
    * A short outline of the contents of the video.
    */
@@ -28,12 +24,6 @@ export default class SummaryUpdatePayload {
   static readonly discriminator?: string = undefined;
 
   static readonly attributeTypeMap: Array<AttributeType> = [
-    {
-      name: 'title',
-      baseName: 'title',
-      type: 'string',
-      format: '',
-    },
     {
       name: '_abstract',
       baseName: 'abstract',

src/model/VideoCreationPayload.ts

@@ -65,6 +65,10 @@ export default class VideoCreationPayload {
    * 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.
    */
   'transcriptSummary'?: boolean;
+  /**
+   * 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.
+   */
+  'transcriptSummaryAttributes'?: Array<VideoCreationPayloadTranscriptSummaryAttributesEnum>;
 
   static readonly discriminator?: string = undefined;
 
@@ -153,6 +157,12 @@ export default class VideoCreationPayload {
       type: 'boolean',
       format: '',
     },
+    {
+      name: 'transcriptSummaryAttributes',
+      baseName: 'transcriptSummaryAttributes',
+      type: 'Array<VideoCreationPayloadTranscriptSummaryAttributesEnum>',
+      format: '',
+    },
   ];
 
   static getAttributeTypeMap(): Array<AttributeType> {
@@ -194,3 +204,6 @@ export type VideoCreationPayloadLanguageEnum =
   | 'ur'
   | 'vi'
   | 'zh';
+export type VideoCreationPayloadTranscriptSummaryAttributesEnum =
+  | 'abstract'
+  | 'takeaways';

src/model/VideoUpdatePayload.ts

@@ -57,6 +57,10 @@ export default class VideoUpdatePayload {
    * 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.
    */
   'transcriptSummary'?: boolean;
+  /**
+   * 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.
+   */
+  'transcriptSummaryAttributes'?: Array<VideoUpdatePayloadTranscriptSummaryAttributesEnum>;
 
   static readonly discriminator?: string = undefined;
 
@@ -127,6 +131,12 @@ export default class VideoUpdatePayload {
       type: 'boolean',
       format: '',
     },
+    {
+      name: 'transcriptSummaryAttributes',
+      baseName: 'transcriptSummaryAttributes',
+      type: 'Array<VideoUpdatePayloadTranscriptSummaryAttributesEnum>',
+      format: '',
+    },
   ];
 
   static getAttributeTypeMap(): Array<AttributeType> {
@@ -168,3 +178,6 @@ export type VideoUpdatePayloadLanguageEnum =
   | 'ur'
   | 'vi'
   | 'zh';
+export type VideoUpdatePayloadTranscriptSummaryAttributesEnum =
+  | 'abstract'
+  | 'takeaways';