Overview
Menu

CreateAIRecognitionTemplate

1. API Description

Domain name for API request: mps.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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: CreateAIRecognitionTemplate.
VersionYesStringCommon Params. The value used for this API: 2019-06-12.
RegionNoStringCommon Params. This parameter is not required for this API.
NameNoStringName of a video content recognition template. Length limit: 64 characters.
CommentNoStringDescription of a video content recognition template. Length limit: 256 characters.
FaceConfigureNoFaceConfigureInfoFace recognition control parameter.
OcrFullTextConfigureNoOcrFullTextConfigureInfoFull text recognition control parameter.
OcrWordsConfigureNoOcrWordsConfigureInfoText keyword recognition control parameter.
AsrFullTextConfigureNoAsrFullTextConfigureInfoFull speech recognition control parameter.
AsrWordsConfigureNoAsrWordsConfigureInfoSpeech keyword recognition control parameter.

3. Output Parameters

Parameter NameTypeDescription
DefinitionIntegerUnique ID of a video content recognition template.
RequestIdStringThe unique request ID, which is returned for each request. 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 content 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.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 recognition template"
}

Output Example

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

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

This example shows you how to create a custom video content 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.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAIRecognitionTemplate
<Common request parameters>

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

Output Example

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

Example3 Creating a speech translation template

Input Example

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

{
    "Name": "test"
}

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 CodeDescription
FailedOperation.InvalidMpsUserOperation failed: unauthorized MPS user.
InternalErrorInternal error.
InvalidParameterParameter error.
InvalidParameterValueIncorrect parameter value.
InvalidParameterValue.CommentParameter error: template description.
InvalidParameterValue.DefaultLibraryLabelSetIncorrect parameter value: the default face library filter tag is invalid.
InvalidParameterValue.DestinationLanguage
InvalidParameterValue.FaceLibraryIncorrect parameter value: invalid face library parameter.
InvalidParameterValue.FaceScoreIncorrect parameter value: the value of the face score parameter is invalid.
InvalidParameterValue.LabelSetIncorrect parameter value: invalid LabelSet value.
InvalidParameterValue.NameIncorrect parameter value: Name exceeds the length limit.
InvalidParameterValue.ObjectLibraryIncorrect parameter value: object library parameter is invalid.
InvalidParameterValue.SourceLanguage
InvalidParameterValue.SubtitleFormatIncorrect parameter value: The value of the SubtitleFormat parameter is invalid.
InvalidParameterValue.SwitchIncorrect parameter value: invalid Switch value.
InvalidParameterValue.UserDefineLibraryLabelSetIncorrect parameter value: the custom face library filter tag is invalid.
LimitExceeded.TooMuchTemplateLimit reached: the number of templates exceeds the limit.