diff --git a/api/openapi.yaml b/api/openapi.yaml index e11311f..f1ff330 100644 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -16699,7 +16699,8 @@ components: transcriptSummaryAttributes: description: 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. + a full summary with all attributes. The possible values are `abstract` + and `takeaways`. items: enum: - abstract @@ -16730,7 +16731,8 @@ components: attributes: description: 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. + a full summary with all attributes. The possible values are `abstract` + and `takeaways`. items: enum: - abstract @@ -17077,7 +17079,8 @@ components: transcriptSummaryAttributes: description: 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. + a full summary with all attributes. The possible values are `abstract` + and `takeaways`. items: enum: - abstract diff --git a/docs/SummaryCreationPayload.md b/docs/SummaryCreationPayload.md index c136293..921acc2 100644 --- a/docs/SummaryCreationPayload.md +++ b/docs/SummaryCreationPayload.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **VideoId** | **string** | Create a summary of a video using the video ID. | **Origin** | Pointer to **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** | Pointer to **[]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] +**Attributes** | Pointer to **[]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. The possible values are `abstract` and `takeaways`. | [optional] ## Methods diff --git a/docs/VideoCreationPayload.md b/docs/VideoCreationPayload.md index 9ac5ead..846e294 100644 --- a/docs/VideoCreationPayload.md +++ b/docs/VideoCreationPayload.md @@ -18,7 +18,7 @@ Name | Type | Description | Notes **Language** | Pointer to **NullableString** | 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** | Pointer to **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** | Pointer to **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** | Pointer to **[]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] +**TranscriptSummaryAttributes** | Pointer to **[]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. The possible values are `abstract` and `takeaways`. | [optional] ## Methods diff --git a/docs/VideoUpdatePayload.md b/docs/VideoUpdatePayload.md index 5c17f51..cae0cba 100644 --- a/docs/VideoUpdatePayload.md +++ b/docs/VideoUpdatePayload.md @@ -15,7 +15,7 @@ Name | Type | Description | Notes **Language** | Pointer to **NullableString** | 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** | Pointer to **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** | Pointer to **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** | Pointer to **[]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] +**TranscriptSummaryAttributes** | Pointer to **[]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. The possible values are `abstract` and `takeaways`. | [optional] ## Methods diff --git a/model_summary_creation_payload.go b/model_summary_creation_payload.go index ed66131..2824f5a 100644 --- a/model_summary_creation_payload.go +++ b/model_summary_creation_payload.go @@ -20,7 +20,7 @@ type SummaryCreationPayload struct { VideoId string `json:"videoId"` // 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 *string `json:"origin,omitempty"` - // 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 *[]string `json:"attributes,omitempty"` } diff --git a/model_video_creation_payload.go b/model_video_creation_payload.go index b658942..f1047c0 100644 --- a/model_video_creation_payload.go +++ b/model_video_creation_payload.go @@ -42,7 +42,7 @@ type VideoCreationPayload struct { Transcript *bool `json:"transcript,omitempty"` // 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 *bool `json:"transcriptSummary,omitempty"` - // 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 *[]string `json:"transcriptSummaryAttributes,omitempty"` } diff --git a/model_video_update_payload.go b/model_video_update_payload.go index c00446a..142af6a 100644 --- a/model_video_update_payload.go +++ b/model_video_update_payload.go @@ -38,7 +38,7 @@ type VideoUpdatePayload struct { Transcript *bool `json:"transcript,omitempty"` // 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 *bool `json:"transcriptSummary,omitempty"` - // 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 *[]string `json:"transcriptSummaryAttributes,omitempty"` }