1. 接口描述
接口请求域名: vod.tencentcloudapi.com 。
创建用户自定义音视频内容识别模板,数量上限:50。
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateAIRecognitionTemplate。 |
Version | 是 | String | 公共参数,本接口取值:2018-07-17。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
SubAppId | 否 | Integer | 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。 示例值:1490012345 |
Name | 否 | String | 音视频内容识别模板名称,长度限制:64 个字符。 示例值:视频片头片尾识别任务模板 |
Comment | 否 | String | 音视频内容识别模板描述信息,长度限制:256 个字符。 示例值:模板1 |
HeadTailConfigure | 否 | HeadTailConfigureInfo | 视频片头片尾识别控制参数。 |
SegmentConfigure | 否 | SegmentConfigureInfo | 视频拆条识别控制参数。 |
FaceConfigure | 否 | FaceConfigureInfo | 人脸识别控制参数。 |
OcrFullTextConfigure | 否 | OcrFullTextConfigureInfo | 文本全文识别控制参数。 |
OcrWordsConfigure | 否 | OcrWordsConfigureInfo | 文本关键词识别控制参数。 |
AsrFullTextConfigure | 否 | AsrFullTextConfigureInfo | 语音全文识别控制参数。 |
AsrWordsConfigure | 否 | AsrWordsConfigureInfo | 语音关键词识别控制参数。 |
AsrTranslateConfigure | 否 | AsrTranslateConfigureInfo | 语音翻译控制参数。 |
ObjectConfigure | 否 | ObjectConfigureInfo | 物体识别控制参数。 |
ScreenshotInterval | 否 | Float | 截帧间隔,单位为秒。当不填时,默认截帧间隔为 1 秒,最小值为 0.5 秒。 示例值:1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Definition | Integer | 音视频内容识别模板唯一标识。 示例值:30 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建仅支持视频片头片尾识别的任务模板
创建一个自定义音视频内容识别模板,仅开启视频片头片尾识别任务。
输入示例
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAIRecognitionTemplate
<公共请求参数>
{
"Comment": "模板1",
"HeadTailConfigure": {
"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: CreateAIRecognitionTemplate
<公共请求参数>
{
"AsrTranslateConfigure": {
"Switch": "ON",
"SrcLanguage": "zh",
"DstLanguage": "en",
"SubtitleFormats": [
"vtt"
]
},
"Name": "语音翻译模板_中译英"
}
输出示例
{
"Response": {
"Definition": 31,
"RequestId": "0de23d47-ff58-41d7-80c4-c4fa7dbc6c21"
}
}
示例3 创建支持多项音视频内容识别任务的模板
创建一个自定义音视频内容识别模板,开启拆条任务,同时开启人脸识别任务,人脸库使用默认库,人脸识别过滤分数为 90 分。
输入示例
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAIRecognitionTemplate
<公共请求参数>
{
"Comment": "模板2",
"FaceConfigure": {
"Switch": "ON",
"Score": "90",
"FaceLibrary": "Default"
},
"Name": "智能识别模板",
"SegmentConfigure": {
"Switch": "ON"
}
}
输出示例
{
"Response": {
"Definition": 31,
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}
示例4 创建支持多项识别任务的模板,同时指定截帧间隔
创建一个自定义音视频内容识别模板,开启拆条任务,同时开启人脸识别任务,人脸库使用默认库及用户自定义库,人脸识别过滤分数为 90 分,指定截帧间隔为 1.0 秒。
输入示例
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAIRecognitionTemplate
<公共请求参数>
{
"Comment": "模板3",
"FaceConfigure": {
"Switch": "ON",
"FaceLibrary": "All"
},
"ScreenshotInterval": "1.0",
"Name": "智能识别模板",
"SegmentConfigure": {
"Switch": "ON"
}
}
输出示例
{
"Response": {
"Definition": 32,
"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。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue.Comment | 参数错误:对该模板的描述。 |
InvalidParameterValue.DefaultLibraryLabelSet | 参数值错误:人脸默认库过滤标签非法。 |
InvalidParameterValue.FaceLibrary | 参数值错误:人脸库参数非法。 |
InvalidParameterValue.FaceScore | 参数值错误:人脸分数参数取值非法。 |
InvalidParameterValue.LabelSet | 参数值错误:LabelSet 参数取值非法。 |
InvalidParameterValue.Name | 参数值错误:Name 超过长度限制。 |
InvalidParameterValue.ObjectLibrary | 参数值错误:物体库参数非法。 |
InvalidParameterValue.ScreenshotInterval | 参数值错误:ScreenshotInterval 参数取值非法。 |
InvalidParameterValue.SubtitleFormat | 参数值错误:SubtitleFormat 参数非法。 |
InvalidParameterValue.Switch | 参数值错误:Switch 参数取值非法。 |
InvalidParameterValue.UserDefineLibraryLabelSet | 参数值错误:人脸用户自定义库过滤标签非法。 |
LimitExceeded.TooMuchTemplate | 超过限制值:模板数超过上限 100 个,如需更多请提交工单。 |
UnauthorizedOperation | 未授权操作。 |