调用 GetVideoAISummary 接口,获取指定直播间或点播间内,指定视频 AI 总结内容的任务状态和文本内容。
注意事项
- 请求频率:单用户请求频率限制为 120 次/分钟。
- 前提条件:
- 要获取直播间视频的 AI 总结内容,确保您拥有火山引擎主账号或具备直播间的回放管理 > 可查看权限的子账号。有关如何添加子账号,详见子账号管理。
- 要获取点播间视频的 AI 总结内容,确保您拥有火山引擎主账号或具备点播间的视频管理 > 可查看权限的子账号。有关如何添加子账号,详见子账号管理。
请求说明
- 请求方式:GET
- 请求地址:https://livesaas.volcengineapi.com/?Action=GetVideoAISummary&Version=2023-08-01
调试
请求参数
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
Query
| 参数 |
类型 |
是否必选 |
示例值 |
描述 |
| Action |
String |
是 |
GetVideoAISummary |
接口名称。当前 API 的名称为 GetVideoAISummary。 |
| Version |
String |
是 |
2023-08-01 |
接口版本。当前 API 的版本为 2023-08-01。 |
| ActivityId |
Long |
是 |
12321*****253 |
直播间 ID 或点播间 ID。获取方式如下: |
|
|
|
|
* 您可通过调用 ListActivityAPI 接口获取直播间 ID |
|
|
|
|
* 您可通过调用 ListVideoRooms 接口获取点播间 ID |
|
|
|
|
:::tip |
|
|
|
|
使用子账号调用接口时,确保该直播间或点播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理。 |
|
|
|
|
::: |
| Vid |
String |
是 |
v02a49g****tnog65tlutgmtgg |
直播间或点播间中的视频 Vid。获取方式如下: |
|
|
|
|
* 要获取直播间的视频 Vid,您可通过调用 ListActivityMediaAPI 接口获取视频的 Vid 和视频关联的直播间信息 |
|
|
|
|
* 要获取点播间的视频 Vid,您可通过调用 ListVideoRoomMedias 接口获取指定点播间视频的 Vid |
返回参数
| 参数 |
类型 |
示例值 |
描述 |
| VideoAISummaryProgress |
Object of VideoAISummaryProgress |
- |
AI 视频总结的任务进度。 |
| SummaryContent |
String |
视频主题:粉色玫瑰系甜点摆盘展示;视频价值:为甜点摆盘设计提供美学参考与创作灵感 |
视频摘要的中文文本内容。 |
| SummaryContentEn |
String |
Topic: Exquisite Dessert Plating Display. Value: Shows the exquisite texture of desserts and delivers a beautiful visual experience |
视频摘要的英文文本内容。 |
| ParagraphContents |
Array of ParagraphContents |
- |
知识点总结中,分段视频的文本内容。 |
| IsPublished |
Boolean |
true |
视频总结内容的发布状态。取值如下: |
|
|
|
* true:已发布 |
|
|
|
* false:未发布 |
| IsLatest |
Boolean |
true |
当前已发布的视频总结内容是否为最新版本。取值如下: |
|
|
|
* true:当前视频总结内容是最新版本 |
|
|
|
* false:视频总结内容不是最新版本 |
VideoAISummaryProgress
| 参数 |
类型 |
示例值 |
描述 |
| Status |
Integer |
4 |
AI 视频总结任务的状态。取值如下: |
|
|
|
* -1:任务已终止。任务被手动停止,不再继续生成总结 |
|
|
|
* 0:排队中。任务已提交,正在等待系统处理 |
|
|
|
* 1:视频处理中。系统正在分析和处理视频内容 |
|
|
|
* 2:等待生成总结。视频处理已完成,正在等待生成 AI 总结 |
|
|
|
* 3:总结生成中。系统正在生成 AI 总结内容,任务不可被终止 |
|
|
|
* 4:已完成。AI 总结已生成完成 |
|
|
|
* 5:失败。任务执行失败,未能生成 AI 总结 |
| SummaryStatus |
Integer |
1 |
摘要文本的生成状态,取值如下: |
|
|
|
* 0:未生成 |
|
|
|
* 1:已生成 |
| ParagraphStatus |
Integer |
1 |
知识点总结文本的生成状态,取值如下: |
|
|
|
* 0:未生成 |
|
|
|
* 1:已生成 |
| JobStartTime |
Integer |
1715040000 |
AI 视频总结任务的启动时间。Unix 时间戳,单位为秒。 |
ParagraphContents
| 参数 |
类型 |
示例值 |
描述 |
| StartTime |
Integer |
0 |
当前分段视频的开始时刻,单位为毫秒。 |
| EndTime |
Integer |
30000 |
当前分段视频的结束时刻,单位为毫秒。 |
| Title |
String |
常规造型玫瑰主题粉色甜点展示 |
当前分段视频的标题。 |
| Content |
String |
常规造型玫瑰主题粉色甜点以绿色餐盘承载,搭配玫瑰花瓣、花蕾为装饰,置于黑色背景中 |
当前分段视频的总结内容。 |
| TitleEn |
String |
Static Display of Various Pink Dessert Plating |
当前分段视频的英文标题。 |
| ContentEn |
String |
Served on green plates against dark backgrounds, various pinkdesserts including mousse, fluffy styles, and heart-shaped ones are presented. |
当前分段视频的英文总结内容。 |
|
|
|
|
请求示例
GET https://livesaas.volcengineapi.com/?Action=GetVideoAISummary&Version=2023-08-01&ActivityId=12321*****253&Vid=v02a49g10000d66l1tnog65tlutgmtgg
返回示例
{
"ResponseMetadata": {
"RequestId": "20230604110420****100232280022D31",
"Action": "GetVideoAISummary",
"Version": "2023-08-01",
"Service": "livesaas",
"Region": "cn-north-1",
"SystemTime": 1697446406
},
"Result": {
"VideoAISummaryProgress": {
"Status": 4,
"SummaryStatus": 1,
"ParagraphStatus": 1,
"JobStartTime": 1715040000
},
"IsPublished": true,
"IsLatest": true,
"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."
}
]
}
}
错误码
访问公共错误码和错误码获取详细信息。