tencent cloud

媒体处理

CreateAIRecognitionTemplate

Download
聚焦模式
字号
最后更新时间: 2026-08-14 16:33:35

1. API Description

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

This API is used to create a user-defined 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: 2019-06-12.
Region No String Common Params. This parameter is not required for this API.
Name No String Video content recognition template name, length limited to 64 characters.
Comment No String Video Content Recognition template description, length limited to 256 characters.
FaceConfigure No FaceConfigureInfo Face Recognition Control Parameter.
OcrFullTextConfigure No OcrFullTextConfigureInfo Full Text Recognition Control Parameter.
OcrWordsConfigure No OcrWordsConfigureInfo Text keyword recognition control.
AsrFullTextConfigure No AsrFullTextConfigureInfo Speech Full-text Recognition Control Parameter.
AsrWordsConfigure No AsrWordsConfigureInfo Voice keyword recognition control parameters.
TranslateConfigure No TranslateConfigureInfo Voice translation control parameters.

3. Output Parameters

Parameter Name Type Description
Definition Integer Unique identifier of a 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 for Multiple Video Content Recognition Tasks

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

Input Example

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

{
    "Comment": "Template 2",
    "FaceConfigure": {
        "Switch": "ON",
        "Score": "90",
        "FaceLibrary": "Default"
    },
    "Name": "Intelligent Identification Template"
}

Output Example

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

Example2 Creating a Template for Multiple Recognition Tasks, with the Frame Extraction Interval Specified

This example shows you how to create a custom video recognition template with face recognition enabled. The default and custom face libraries are used, and the face recognition filter score is 90.

Input Example

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

{
    "Comment": "Template 3",
    "FaceConfigure": {
        "Switch": "ON",
        "FaceLibrary": "All"
    },
    "Name": "Intelligent Identification Template"
}

Output Example

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

Example3 Creating a Speech Translation Template

This example shows you how to create a speech translation template.

Input Example

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

{
    "Name": "recog",
    "TranslateConfigure": {
        "Switch": "ON",
        "SourceLanguage": "en",
        "DestinationLanguage": "zh"
    }
}

Output Example

{
    "Response": {
        "Definition": 278654,
        "RequestId": "62cca75c-7dd3-4819-ad9d-13b48a4b4018"
    }
}

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.InvalidMpsUser Operation failed: unauthorized MPS user.
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.Comment Parameter error: template description.
InvalidParameterValue.DefaultLibraryLabelSet Parameter value error: the filter tag of the default human face library is invalid.
InvalidParameterValue.DestinationLanguage A DestinationLanguage parameter error occurs.
InvalidParameterValue.FaceLibrary Parameter value error: the face library parameter is invalid.
InvalidParameterValue.FaceScore Parameter value error: the Face Score parameter value is invalid.
InvalidParameterValue.LabelSet Incorrect parameter value: invalid LabelSet value.
InvalidParameterValue.Name Incorrect parameter value: Name exceeds the length limit.
InvalidParameterValue.ObjectLibrary Parameter value error: the object library parameter is invalid.
InvalidParameterValue.SourceLanguage A SourceLanguage parameter error occurs.
InvalidParameterValue.SubtitleFormat Parameter value error: the SubtitleFormat parameter is invalid.
InvalidParameterValue.Switch Incorrect parameter value: invalid Switch value.
InvalidParameterValue.UserDefineLibraryLabelSet Parameter value error: the filter tag of the custom face library is invalid.
LimitExceeded.TooMuchTemplate Limit reached: the number of templates exceeds the limit.

帮助和支持

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

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

文档反馈