开发指南

服务端 API 文档

有奖征文|投稿上云技术实践,赢取价值5000元大奖> HOT

1. 接口描述

接口请求域名: vod.tencentcloudapi.com 。

创建用户自定义音视频内容分析模板,数量上限:50。

默认接口请求频率限制:10次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateAIAnalysisTemplate。
Version String 公共参数,本接口取值:2018-07-17。
Region String 公共参数,本接口不需要传递此参数。
SubAppId Integer 点播子应用 ID。如果要访问子应用中的资源,则将该字段填写为子应用 ID;否则无需填写该字段。
Name String 音视频内容分析模板名称,长度限制:64 个字符。
Comment String 音视频内容分析模板描述信息,长度限制:256 个字符。
ClassificationConfigure ClassificationConfigureInfo 智能分类任务控制参数。
TagConfigure TagConfigureInfo 智能标签任务控制参数。
CoverConfigure CoverConfigureInfo 智能封面任务控制参数。
FrameTagConfigure FrameTagConfigureInfo 智能按帧标签任务控制参数。
HighlightConfigure HighlightsConfigureInfo 智能精彩集锦任务控制参数。

3. 输出参数

参数名称 类型 描述
Definition Integer 音视频内容分析模板唯一标识。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建指定一项分析任务的模板

创建一个自定义音视频内容分析模板,开启智能分类任务。

输入示例

POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAIAnalysisTemplate
<公共请求参数>

{
    "Comment": "模板1",
    "ClassificationConfigure": {
        "Switch": "ON"
    },
    "Name": "智能分析模板"
}

输出示例

{
    "Response": {
        "Definition": 30,
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
    }
}

示例2 创建指定多项分析任务的模板

创建一个自定义音视频内容分析模板,开启智能分类和智能标签任务。

输入示例

POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAIAnalysisTemplate
<公共请求参数>

{
    "Comment": "模板2",
    "TagConfigure": {
        "Switch": "ON"
    },
    "ClassificationConfigure": {
        "Switch": "ON"
    },
    "Name": "智能分析模板"
}

输出示例

{
    "Response": {
        "Definition": 31,
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
    }
}

示例3 创建开启全部内容分析任务的模板

创建一个自定义音视频内容分析模板,开启全部智能分析任务。

输入示例

POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAIAnalysisTemplate
<公共请求参数>

{
    "Comment": "模板3",
    "ClassificationConfigure": {
        "Switch": "ON"
    },
    "Name": "智能分析模板",
    "TagConfigure": {
        "Switch": "ON"
    },
    "FrameTagConfigure": {
        "Switch": "ON",
        "ScreenshotInterval": "0.5"
    },
    "CoverConfigure": {
        "Switch": "NO"
    }
}

输出示例

{
    "Response": {
        "Definition": 33,
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue.ClassifcationConfigure 智能分类控制字段参数错误。
InvalidParameterValue.Comment 参数错误:对该模板的描述。
InvalidParameterValue.CoverConfigure 智能封面控制字段参数错误。
InvalidParameterValue.Definition 参数错误:Definition。
InvalidParameterValue.FrameTagConfigure 智能按帧标签控制字段参数错误。
InvalidParameterValue.HighlightConfigure 智能精彩集锦控制参数错误。
InvalidParameterValue.Name 参数值错误:Name 超过长度限制。
InvalidParameterValue.TagConfigure 智能标签控制字段参数错误。
LimitExceeded.TooMuchTemplate 超过限制值:模板数超限。
UnauthorizedOperation 未授权操作。
目录