tencent cloud

All product documents
Media Processing Service
DocumentationMedia Processing ServiceAPI DocumentationMedia AI Template APIsCreateAIRecognitionTemplate
CreateAIRecognitionTemplate
Download PDF
Last updated: 2025-02-19 14:55:58
CreateAIRecognitionTemplate
Last updated: 2025-02-19 14:55:58
Download PDF

1. API Description

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

This API is used to create a custom 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 Name of a video content recognition template. Length limit: 64 characters.
Comment No String Description of a video content recognition template. Length limit: 256 characters.
FaceConfigure No FaceConfigureInfo Face recognition control parameter.
OcrFullTextConfigure No OcrFullTextConfigureInfo Full text recognition control parameter.
OcrWordsConfigure No OcrWordsConfigureInfo Text keyword recognition control parameter.
AsrFullTextConfigure No AsrFullTextConfigureInfo Full speech recognition control parameter.
AsrWordsConfigure No AsrWordsConfigureInfo Speech keyword recognition control parameter.

3. Output Parameters

Parameter Name Type Description
Definition Integer Unique ID 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 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": "test"
}

Output Example

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

Example2 Creating a Template for Multiple Video 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": 32,
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
    }
}

Example3 Creating a Template for Multiple Video Recognition Tasks, with the Frame Capturing 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"
    }
}

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 Incorrect parameter value: the default face library filter tag is invalid.
InvalidParameterValue.DestinationLanguage
InvalidParameterValue.FaceLibrary Incorrect parameter value: invalid face library parameter.
InvalidParameterValue.FaceScore Incorrect parameter value: the value of the face score parameter is invalid.
InvalidParameterValue.LabelSet Incorrect parameter value: invalid LabelSet value.
InvalidParameterValue.Name Incorrect parameter value: Name exceeds the length limit.
InvalidParameterValue.ObjectLibrary Incorrect parameter value: object library parameter is invalid.
InvalidParameterValue.SourceLanguage
InvalidParameterValue.SubtitleFormat Incorrect parameter value: The value of the SubtitleFormat parameter is invalid.
InvalidParameterValue.Switch Incorrect parameter value: invalid Switch value.
InvalidParameterValue.UserDefineLibraryLabelSet Incorrect parameter value: the custom face library filter tag is invalid.
LimitExceeded.TooMuchTemplate Limit reached: the number of templates exceeds the limit.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon