Skip to main content

Create Summary

POST 

/bv/cms/v1/summary

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Will be deprecated soon. Do not use this API.

Request

Body

required
    source_id Required. The unique id of the source to generate summary. If type is `SUMMARY_SOURCE_TYPE_LIBRARY`, it should be library_id If type is `SUMMARY_SOURCE_TYPE_VOD`, it should be vod_id (string)required
    type stringrequired

    Possible values: [SUMMARY_SOURCE_TYPE_LIBRARY, SUMMARY_SOURCE_TYPE_VOD, SUMMARY_SOURCE_TYPE_FILE_DOCUMENT]

    Required. The source type to generate summary .

    summary objectrequired
    content string

    Optional. The content of summary, one of content or ai_generate_summary_setting should be set.

    ai_generate_summary_setting object

    Optional. The setting of AI generate summary, one of content or ai_generate_summary_setting should be set.

    format string

    Possible values: [SUMMARY_FORMAT_PARAGRAPH, SUMMARY_FORMAT_BULLET_POINTS]

    Optional. The format of summary to be generated. Default: SUMMARY_FORMAT_PARAGRAPH.

    subtitle_id string

    Optional. The id of the subtitle. It is required when the source type is SUMMARY_SOURCE_TYPE_VOD. The summary will be generated based on the given subtitle.

    content_type string

    Possible values: [SUMMARY_CONTENT_TYPE_GENERAL, SUMMARY_CONTENT_TYPE_NEWS, SUMMARY_CONTENT_TYPE_MEETING, SUMMARY_CONTENT_TYPE_ECOMMERCE]

    Optional. The content type of the source. It is used to determine the appropriate summary generation strategy, and it only supports the summary of subtitle. Default: SUMMARY_CONTENT_TYPE_GENERAL.

    delete_summary boolean

    Optional. If set to true, it will delete the summary.

Responses

A successful response.

Schema

    object

Loading...