tencent cloud

云点播

动态与公告
产品动态
公告
产品简介
产品概述
产品特性
产品功能
产品优势
应用场景
解决方案
专业版
云点播专业版简介
快速入门
控制台指南
开发指南
购买指南
计费概述
计费方式
购买指引
账单查询
续费说明
欠费说明
退费说明
快速入门
控制台指南
控制台介绍
服务概览
应用管理
媒体管理
资源包管理
License 管理
实时日志分析
实践教程
媒体上传
如何将点播的媒体文件进行智能降冷
媒体处理
分发播放
如何接收事件通知
如何进行源站迁移
直播录制
如何进行自定义源站回源
直播精彩剪辑固化至云点播 VOD 指引
如何使用 EdgeOne 分发云点播内容
开发指南
媒体上传
媒体加工处理
媒体 AI
事件通知
媒体分发播放
媒体加密与版权保护
播放频道
访问管理
下载媒体文件
应用体系
错误码
播放器 SDK 文档
概述
基本概念
产品功能
Demo 体验
免费测试
购买指南
SDK 下载
License 指引
播放器教程
含 UI 集成方案
无 UI 集成方案
高级功能
API 文档
第三方播放器插件
Player SDK Policy
服务端 API 文档
History
Introduction
API Category
Other APIs
Media Processing APIs
Parameter Template APIs
Task Management APIs
Media Upload APIs
Media Management APIs
Event Notification Relevant API
Media Categorization APIs
Domain Name Management APIs
Distribution APIs
AI-based Sample Management APIs
Region Management APIs
Data Statistics APIs
Carousel-Related APIs
Just In Time Transcode APIs
No longer recommended APIs
Making API Requests
AI-based image processing APIs
Task Flow APIs
Data Types
Error Codes
Video on Demand API 2024-07-18
常见问题
移动端播放问题
费用相关问题
视频上传问题
视频发布问题
视频播放问题
Web 端播放问题
全屏播放问题
数据统计问题
访问管理相关问题
媒资降冷问题
相关协议
Service Level Agreement
VOD 政策
隐私政策
数据处理和安全协议
联系我们
词汇表

CreateAIRecognitionTemplate

PDF
聚焦模式
字号
最后更新时间: 2025-10-30 22:07:20

1. API Description

Domain name for API request: vod.intl.tencentcloudapi.com.

This API is used to create a custom video content recognition template. Up to 50 templates can be created.

A maximum of 10 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CreateAIRecognitionTemplate.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required.
SubAppId No Integer The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
Name No String Video content recognition template name. Length limit: 64 characters.
Comment No String Description of video content recognition template. Length limit: 256 characters.
HeadTailConfigure No HeadTailConfigureInfo Control parameter of video opening and ending credits recognition.
SegmentConfigure No SegmentConfigureInfo Control parameter of video splitting recognition.
FaceConfigure No FaceConfigureInfo Control parameter of face recognition.
OcrFullTextConfigure No OcrFullTextConfigureInfo Control parameter of full text recognition.
OcrWordsConfigure No OcrWordsConfigureInfo Control parameter of text keyword recognition.
AsrFullTextConfigure No AsrFullTextConfigureInfo Control parameter of full speech recognition.
AsrWordsConfigure No AsrWordsConfigureInfo Control parameter of speech keyword recognition.
AsrTranslateConfigure No AsrTranslateConfigureInfo Control parameter of voice translation.
ObjectConfigure No ObjectConfigureInfo Control parameter of object recognition.
ScreenshotInterval No Float Frame capturing interval in seconds. If this parameter is left empty, 1 second will be used by default. Minimum value: 0.5 seconds.

3. Output Parameters

Parameter Name Type Description
Definition Integer Unique ID of video content recognition template.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Creating a template to recognize opening and closing credits

This example shows you how to create a custom video recognition template to recognize opening and closing credits.

Input Example

https://vod.intl.tencentcloudapi.com/?Action=CreateAIRecognitionTemplate
&Name=Opening and closing credits recognition template
&Comment=Template 1
&HeadTailConfigure.Switch=ON
&<Common request parameters>

Output Example

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

Example2 Creating a template to support only voice translation tasks

Create a custom audio and video content recognition template, enabling only the voice translation task.

Input Example

POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAIRecognitionTemplate
<Common request parameters>

{
    "AsrTranslateConfigure": {
        "Switch": "ON",
        "SrcLanguage": "zh",
        "DstLanguage": "en",
        "SubtitleFormats": [
            "vtt"
        ]
    },
    "Name": "VoiceTranslationTemplateChineseToEnglish"
}

Output Example

{
    "Response": {
        "Definition": 31,
        "RequestId": "0de23d47-ff58-41d7-80c4-c4fa7dbc6c21"
    }
}

Example3 Creating a template for multiple video content recognition tasks

This example shows you how to create a custom video content recognition template for a splitting task and a face recognition task. The default face library is used, and the face recognition filter score is 90.

Input Example

https://vod.intl.tencentcloudapi.com/?Action=CreateAIRecognitionTemplate
&Name=Intelligent content recognition template
&Comment=Template 2
&SegmentConfigure.Switch=ON
&FaceConfigure.Switch=ON
&FaceConfigure.FaceLibrary=Default
&FaceConfigure.Score=90
&<Common request parameters>

Output Example

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

Example4 Creating a template for multiple content recognition tasks, with the frame capturing interval specified

This example shows you how to create a custom video content recognition template for a splitting task and a face recognition task. The default and custom face libraries are used, the face recognition filter score is 90, and the frame capturing interval is 1.0 second.

Input Example

https://vod.intl.tencentcloudapi.com/?Action=CreateAIRecognitionTemplate
&Name=Intelligent content recognition template
&Comment=Template 3
&SegmentConfigure.Switch=ON
&FaceConfigure.Switch=ON
&FaceConfigure.FaceLibrary=All
&ScreenshotInterval=1.0
&<Common request parameters>

Output Example

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

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue.Comment Invalid parameter: template description.
InvalidParameterValue.DefaultLibraryLabelSet Incorrect parameter value: the default face library filter tag is invalid.
InvalidParameterValue.FaceLibrary Incorrect parameter value: the face library parameter is invalid.
InvalidParameterValue.FaceScore Incorrect parameter value: the value of the face score parameter is invalid.
InvalidParameterValue.LabelSet Incorrect parameter value: the value of the LabelSet parameter is invalid.
InvalidParameterValue.Name Incorrect parameter value: Name exceeds the length limit.
InvalidParameterValue.ObjectLibrary Incorrect parameter value: the value of the object library parameter is invalid.
InvalidParameterValue.ScreenshotInterval Incorrect parameter value: the value of the ScreenshotInterval parameter is invalid.
InvalidParameterValue.SubtitleFormat Incorrect parameter value: the value of the SubtitleFormat parameter is invalid.
InvalidParameterValue.Switch Incorrect parameter value: the value of the Switch parameter is invalid.
InvalidParameterValue.UserDefineLibraryLabelSet Incorrect parameter value: the custom face library filter tag is invalid.
LimitExceeded.TooMuchTemplate Limit exceeded: The number of templates exceeds the upper limit of 100. If you need more, pleaseSubmit a ticket.
UnauthorizedOperation Unauthorized operation.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈