CreateAIRecognitionTemplate

Last updated: 2020-08-14 09:40:42

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 Name Required Type Description
Action Yes String Common parameter. The value used for this API: CreateAIRecognitionTemplate.
Version Yes String Common parameter. The value used for this API: 2019-06-12.
Region No String Common parameter. 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, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a template that supports multiple video content recognition tasks

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

Input Example

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

Output Example

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

Example2 Creating a template that supports multiple recognition tasks and specifies the frame capturing interval

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

Input Example

https://mps.tencentcloudapi.com/?Action=CreateAIRecognitionTemplate
&Name=Intelligent recognition template
&Comment=Template 3
&FaceConfigure.Switch=ON
&FaceConfigure.FaceLibrary=All
&<common request parameters>

Output Example

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

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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.Comment Parameter error: template description.
InvalidParameterValue.DefaultLibraryLabelSet Incorrect parameter value: the default face library filter tag is invalid.
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.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?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help