diff --git a/.openapi-generator/oas_apivideo.yaml-defaut-cli.sha256 b/.openapi-generator/oas_apivideo.yaml-defaut-cli.sha256 index 19c0001..659df4b 100644 --- a/.openapi-generator/oas_apivideo.yaml-defaut-cli.sha256 +++ b/.openapi-generator/oas_apivideo.yaml-defaut-cli.sha256 @@ -1 +1 @@ -f2258a85e4233a4243aa1514697cbb72ab9568d8bc147a0ba046e979c1e7bcf9 \ No newline at end of file +0fe2cac0381637a3a558fb49517a143bede9af02a98487c03e3500dd6ce49387 \ No newline at end of file diff --git a/docs/SummaryCreationPayload.md b/docs/SummaryCreationPayload.md index b64fe38..31efc33 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** | **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] +**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. The possible values are `abstract` and `takeaways`. | [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/VideoCreationPayload.md b/docs/VideoCreationPayload.md index d3736a7..8ccfd64 100644 --- a/docs/VideoCreationPayload.md +++ b/docs/VideoCreationPayload.md @@ -18,7 +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] +**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. The possible values are `abstract` and `takeaways`. | [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 563665a..2034e34 100644 --- a/docs/VideoUpdatePayload.md +++ b/docs/VideoUpdatePayload.md @@ -15,7 +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] +**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. The possible values are `abstract` and `takeaways`. | [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/Model/SummaryCreationPayload.cs b/src/Model/SummaryCreationPayload.cs index c22184d..4fa9342 100644 --- a/src/Model/SummaryCreationPayload.cs +++ b/src/Model/SummaryCreationPayload.cs @@ -27,9 +27,9 @@ public class SummaryCreationPayload: DeepObject { [JsonProperty(PropertyName = "origin")] public string origin { 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. The possible values are `abstract` and `takeaways`. /// - /// 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`. [DataMember(Name="attributes", EmitDefaultValue=false)] [JsonProperty(PropertyName = "attributes")] public List attributes { get; set; } diff --git a/src/Model/VideoCreationPayload.cs b/src/Model/VideoCreationPayload.cs index c87c4ef..7605b2f 100644 --- a/src/Model/VideoCreationPayload.cs +++ b/src/Model/VideoCreationPayload.cs @@ -109,9 +109,9 @@ public class VideoCreationPayload: DeepObject { [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. The possible values are `abstract` and `takeaways`. /// - /// 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`. [DataMember(Name="transcriptSummaryAttributes", EmitDefaultValue=false)] [JsonProperty(PropertyName = "transcriptSummaryAttributes")] public List transcriptsummaryattributes { get; set; } diff --git a/src/Model/VideoUpdatePayload.cs b/src/Model/VideoUpdatePayload.cs index 2080edf..c017495 100644 --- a/src/Model/VideoUpdatePayload.cs +++ b/src/Model/VideoUpdatePayload.cs @@ -105,9 +105,9 @@ public string playerid [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. The possible values are `abstract` and `takeaways`. /// - /// 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`. [DataMember(Name="transcriptSummaryAttributes", EmitDefaultValue=false)] [JsonProperty(PropertyName = "transcriptSummaryAttributes")] public List transcriptsummaryattributes { get; set; }