Skip to content

Commit

Permalink
Merge pull request #105 from apivideo/update-summary-request-attribut…
Browse files Browse the repository at this point in the history
…e-description

Add missing description
  • Loading branch information
bot-api-video authored Nov 8, 2024
2 parents 28f4c83 + 93ef748 commit 77ed48a
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 9 deletions.
9 changes: 6 additions & 3 deletions api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/SummaryCreationPayload.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/VideoCreationPayload.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/VideoUpdatePayload.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion model_summary_creation_payload.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion model_video_creation_payload.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion model_video_update_payload.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 77ed48a

Please sign in to comment.