diff --git a/docs/model/SummaryCreationPayload.md b/docs/model/SummaryCreationPayload.md index a893f6d..ff37063 100644 --- a/docs/model/SummaryCreationPayload.md +++ b/docs/model/SummaryCreationPayload.md @@ -7,7 +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] +**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. The possible values are `abstract` and `takeaways`. | [optional] diff --git a/docs/model/VideoCreationPayload.md b/docs/model/VideoCreationPayload.md index 35b6e2a..a4f7450 100644 --- a/docs/model/VideoCreationPayload.md +++ b/docs/model/VideoCreationPayload.md @@ -19,7 +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] +**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. The possible values are `abstract` and `takeaways`. | [optional] diff --git a/docs/model/VideoUpdatePayload.md b/docs/model/VideoUpdatePayload.md index 7bbb08b..d65f122 100644 --- a/docs/model/VideoUpdatePayload.md +++ b/docs/model/VideoUpdatePayload.md @@ -16,7 +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] +**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. The possible values are `abstract` and `takeaways`. | [optional] diff --git a/src/model/SummaryCreationPayload.ts b/src/model/SummaryCreationPayload.ts index 0cb9479..6cedcf3 100644 --- a/src/model/SummaryCreationPayload.ts +++ b/src/model/SummaryCreationPayload.ts @@ -21,7 +21,7 @@ export default class SummaryCreationPayload { */ '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. + * 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. The possible values are `abstract` and `takeaways`. */ 'attributes'?: Array; diff --git a/src/model/VideoCreationPayload.ts b/src/model/VideoCreationPayload.ts index 15fb608..4666ea8 100644 --- a/src/model/VideoCreationPayload.ts +++ b/src/model/VideoCreationPayload.ts @@ -66,7 +66,7 @@ export default class VideoCreationPayload { */ '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. + * 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. The possible values are `abstract` and `takeaways`. */ 'transcriptSummaryAttributes'?: Array; diff --git a/src/model/VideoUpdatePayload.ts b/src/model/VideoUpdatePayload.ts index 22127cc..050888e 100644 --- a/src/model/VideoUpdatePayload.ts +++ b/src/model/VideoUpdatePayload.ts @@ -58,7 +58,7 @@ export default class VideoUpdatePayload { */ '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. + * 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. The possible values are `abstract` and `takeaways`. */ 'transcriptSummaryAttributes'?: Array;