调用 UpdateVideoAISummary 接口,更新指定直播间或点播间的指定视频的 AI 总结内容,包括摘要和知识点总结中的文本内容。
注意事项
- 请求频率:单用户请求频率限制为 60 次/分钟。
- 前提条件:
- 要更新直播间视频的 AI 总结内容,确保您拥有火山引擎主账号或具备直播间的回放管理 > 可编辑权限的子账号。有关如何添加子账号,详见子账号管理。
- 要更新点播间视频的 AI 总结内容,确保您拥有火山引擎主账号或具备点播间的视频管理 > 可编辑权限的子账号。有关如何添加子账号,详见子账号管理。
- 请确保当前直播间或点播间的 AI 视频总结设置中,
PublishMode 取值为 2,即 AI 总结完手动发布。您可调用 GetActivityVideoAISummaryConfig 确认 PublishMode 的值;调用 UpdateActivityVideoAISummaryConfig 接口更新 PublishMode 的值。
请求说明
- 请求方式:POST
- 请求地址:https://livesaas.volcengineapi.com/?Action=UpdateVideoAISummary&Version=2023-08-01
调试
请求参数
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
Query
| 参数 |
类型 |
是否必选 |
示例值 |
描述 |
| Action |
String |
是 |
UpdateVideoAISummary |
接口名称。当前 API 的名称为 UpdateVideoAISummary。 |
| Version |
String |
是 |
2023-08-01 |
接口版本。当前 API 的版本为 2023-08-01。 |
Body
| 参数 |
类型 |
是否必选 |
示例值 |
描述 |
| Vid |
String |
是 |
v02a49g****tnog65tlutgmtgg |
直播间或点播间中的视频 Vid。获取方式如下: |
|
|
|
|
* 要获取直播间的视频 Vid,您可通过调用 ListActivityMediaAPI 接口获取视频的 Vid 和视频关联的直播间信息 |
|
|
|
|
* 要获取点播间的视频 Vid,您可通过调用 ListVideoRoomMedias 接口获取指定点播间视频的 Vid |
| ActivityId |
Integer |
是 |
12321*****253 |
直播间 ID 或点播间 ID。获取方式如下: |
|
|
|
|
* 您可通过调用 ListActivityAPI 接口获取直播间 ID |
|
|
|
|
* 您可通过调用 ListVideoRooms 接口获取点播间 ID |
|
|
|
|
:::tip |
|
|
|
|
使用子账号调用接口时,确保该直播间或点播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理。 |
|
|
|
|
::: |
| SummaryContent |
String |
否 |
视频主题:粉色玫瑰系甜点摆盘展示;视频价值:为甜点摆盘设计提供美学参考与创作灵感 |
视频摘要的中文文本内容。 |
| SummaryContentEn |
String |
否 |
Topic: Exquisite Dessert Plating Display. Value: Shows the exquisite texture of desserts and delivers a beautiful visual experience |
视频摘要的英文文本内容。 |
|
|
|
|
:::tip |
|
|
|
|
仅当直播间或点播间的 AI 视频总结设置中,IsBilingualEnabled 取值为 true(即开启中英双语生成)时,该参数生效。您可通过 GetActivityVideoAISummaryConfig 接口获取 AI 视频总结设置。 |
|
|
|
|
::: |
| ParagraphContents |
Array of ParagraphContents |
是 |
- |
知识点总结中,分段视频的起始时间和文本内容等信息。 |
| NeedPublish |
Boolean |
是 |
false |
更新 AI 总结的内容后,是否直接将内容发布至观看页。取值如下: |
|
|
|
|
* true:保存并直接将内容发布至观看页 |
|
|
|
|
* false:仅保存内容,不发布至观看页 |
ParagraphContents
| 参数 |
类型 |
是否必选 |
示例值 |
描述 |
| StartTime |
Integer |
是 |
0 |
目标分段视频的开始时刻,单位为毫秒。您需通过调用 GetVideoAISummary 接口,从返回参数 ParagraphContents.StartTime 中获取该字段的值。 |
|
|
|
|
:::warning |
|
|
|
|
此字段仅用于定位视频分段的开始时间,不支持传入自定义的值。 |
|
|
|
|
::: |
| EndTime |
Integer |
否 |
30000 |
目标分段视频的结束时刻,单位为毫秒。您可通过调用 GetVideoAISummary 接口,从返回参数 ParagraphContents.EndTime 中获取该字段的值。 |
|
|
|
|
:::warning |
|
|
|
|
此字段仅用于定位视频分段的结束时间,不支持传入自定义的值。 |
|
|
|
|
::: |
| Title |
String |
否 |
常规造型玫瑰主题粉色甜点展示 |
当前分段视频的标题。默认为空,表示不更新分段视频的标题。 |
| Content |
String |
否 |
常规造型玫瑰主题粉色甜点以绿色餐盘承载,搭配玫瑰花瓣、花蕾为装饰,置于黑色背景中 |
当前分段视频的总结内容。默认为空,表示不更新分段视频的总结内容。 |
| TitleEn |
String |
否 |
Static Display of Various Pink Dessert Plating |
当前分段视频的英文标题。默认为空,表示不更新英文标题。 |
|
|
|
|
:::tip |
|
|
|
|
仅当直播间或点播间的 AI 视频总结设置中,IsBilingualEnabled 取值为 true(即开启中英双语生成)时,该参数生效。您可通过 GetActivityVideoAISummaryConfig 接口获取 AI 视频总结设置。 |
|
|
|
|
::: |
| ContentEn |
String |
否 |
Served on green plates against dark backgrounds, various pinkdesserts including mousse, fluffy styles, and heart-shaped ones are presented. |
当前分段视频的英文总结内容。默认为空,表示不更新英文总结内容。 |
|
|
|
|
:::tip |
|
|
|
|
仅当直播间或点播间的 AI 视频总结设置中,IsBilingualEnabled 取值为 true(即开启中英双语生成)时,该参数生效。您可通过 GetActivityVideoAISummaryConfig 接口获取 AI 视频总结设置。 |
|
|
|
|
::: |
返回参数
| 参数 |
类型 |
示例值 |
描述 |
| Status |
Boolean |
true |
是否更新成功。成功返回 true。 |
|
|
|
|
请求示例
POST https://livesaas.volcengineapi.com/?Action=UpdateVideoAISummary&Version=2023-08-01
{
"Vid": "v02a49g1000****85tlutgmtgg",
"ActivityId": 12321****5646574,
"SummaryContent": "视频主题:粉色玫瑰系甜点摆盘展示;视频价值:为甜点摆盘设计提供美学参考与创作灵感",
"SummaryContentEn": "Topic: Exquisite Dessert Plating Display. Value: Shows the exquisite texture of desserts and delivers a beautiful visual experience",
"ParagraphContents": [
{
"StartTime": 0,
"EndTime": 30000,
"Title": "常规造型玫瑰主题粉色甜点展示",
"Content": "常规造型玫瑰主题粉色甜点以绿色餐盘承载,搭配玫瑰花瓣、花蕾为装饰,置于黑色背景中,包含柔滑质地、慕斯质地等多种类型,摆盘精致诱人",
"TitleEn": "Static Display of Various Pink Dessert Plating",
"ContentEn": "Served on green plates against dark backgrounds, various pinkdesserts including mousse, fluffy styles, and heart-shaped ones are presented, all decorated with rose petals and buds, featuring delicate and beautiful plating."
}
],
"NeedPublish": false
}
返回示例
{
"ResponseMetadata": {
"RequestId": "20230604110420****100232280022D31",
"Action": "UpdateVideoAISummary",
"Version": "2023-08-01",
"Service": "livesaas",
"Region": "cn-north-1",
"SystemTime": 1697446406
},
"Result": {
"Status": true
}
}
错误码
访问公共错误码和错误码获取详细信息。