RunVideoAnalysis_百炼全妙轻应用_API文档

接口说明

百炼轻应用-视频理解：基于这接口，可以传入一个视频，进行字幕提取、视频内容分析、视频总结、标题抽取、思维导图生成等任务，也可以通过自定义 prompt 来实现差异化的视频内容生成。

欢迎前往轻应用-影视传媒视频理解直接体验。

通过 SDK 方式调用 API 可参考视频理解控制台“API”下的示例。

API-SDK 调用说明

API 接口说明

调用前必看：！！！

调用前必看：！！！

调用前必看：！！！

调用视频理解 API 有 2 种方式，对应 2 个接口

• 调用离线异步 API（推荐）：最多支持 10 并发，无需等待执行结束，异步调度，sdk 支持绝大部分开发语言，openapi 门户可以直接调试和使用，也可以到轻应用-影视传媒视频理解控制台，切换到“API” 页签下查看调用 demo。

• 调用在线同步 API（不推荐）：本文档对应接口，全局只有 1 并发，需保持链接等待结果，sdk 支持的语言有限（java、python），openapi 门户页面不支持调试和调用（sse）（copy 出来代码无法直接使用），一般少量体验用，调用需到轻应用-影视传媒视频理解控制台，切换到“API” 页签下查看调用 demo。

在线同步 API 调用说明

可以通过 SDK 调用当前 API，因“调试”-OpenAPI 门户对 SSE 协议支持还不够完善，建议参考调用示例，详见轻应用-影视传媒视频理解-切换 API 页签下。

推荐Java（异步 sdk）、Python语言的 SDK，其中 Java（异步 sdk）依赖如下：

<dependency>
   <groupId>com.aliyun</groupId>
   <artifactId>alibabacloud-quanmiaolightapp20240801</artifactId>
   <version>取最新版本</version>
 </dependency>

• 获取Java（异步）最新版本依赖。

• 获取AccessKey ID、AccessKey Secret。

• 获取 workspaceId 。

权限说明

前置条件

• 登录下百炼控制台，确认百炼是可以访问状态
• 主账号调用：默认有所有 API 调用权限。
• 子账号调用：子账号默认无权限（AccessForbid）调用当前 API，需要同时在 RAM 控制台和百炼控制台中做授权。

RAM 控制台授权说明

去 RAM 控制台授权，具体 RAM 授权操作，参考 RAM 文档，步骤如下：

1、自定义授权策略：菜单“权限管理-权限策略”下，创建权限策略，脚本编辑方式录入如下任意一个方案中 json。

• 方案一：授权子账号访问 quanmiaolightapp 下所有接口权限，包括视频理解 --建议

{
    "Version": "1",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": "quanmiaolightapp:*",
            "Resource": "*"
        }
    ]
}

• 方案二：授权子子账号指定接口，比如视频理解“RunVideoAnalysis”

{
    "Version": "1",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": "quanmiaolightapp:RunVideoAnalysis",
            "Resource": "*"
        }
    ]
}

2、给子账号授权：菜单“身份管理-用户”下，找到对应用户，新增授权，切换自定义授权，添加上面自定义的授权策略。

百炼控制台授权说明

使用主账号或有百炼管理员权限的子账号，登录百炼控制台，在权限管理-用户管理页面添加子账号，并进行授权管理员权限。

接口部分入参取值说明

抽帧配置字段（frameSampleMethod）

用于调整抽帧的参数，包括抽帧间隔、抽帧像素。抽帧方式默认为标准方式，目前共提供三种方式可供选择，标准、快速/更低成本、自定义。

• 使用“标准”方式进行抽帧时，应用系统内置参数进行抽帧，抽帧间隔与抽帧像素无需用户自定义。标准方式抽帧间隔和抽帧像素取值规则为：
  • 根据视频时长取分不同档位，见视频理解控制台，“效果调试”tab 下 -> 高级功能 -> 抽帧方式 -> 自定义中的？提示
  • 视频时长和档位映射关系为：取视频时长和档位时长举例最近的档，如果相同，取档位时长大的
• 使用“快速/更低成本”方式进行抽帧时，应用系统内置参数系数运算后的结果进行抽帧，抽帧间隔与抽帧像素无需用户自定义。
• 使用“自定义”方式时，则需要用户传入抽帧间隔、抽帧像素两个参数，参数的取值范围对不同时长的视频存在不同的限制，取值范围具体计算规则如下：
  • 最小抽帧间隔 = max("标准"方式对应抽帧间隔 - 0.2，1)
  • 最大抽帧间隔 = "标准"方式对应抽帧间隔 + 5
  • 最小抽帧像素 = max("标准"方式对应抽帧像素 - 50，300)
  • 最大抽帧像素 = "标准"方式对应抽帧像素 + 50