DescribeAIRecognitionTemplates

Last updated: 2023-10-12 16:44:42Download PDF

1. API Description

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

This API is used to get the list of content recognition templates based on unique template ID. The return result includes all eligible custom and preset content recognition templates.

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: DescribeAIRecognitionTemplates.
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.
Definitions.N	No	Array of Integer	Unique ID filter of video content recognition templates. Array length limit: 10.
Offset	No	Integer	Paging offset. Default value: 0.
Limit	No	Integer	Number of returned entries. Default value: 10. Maximum value: 50.
Type	No	String	The filter for querying templates. If this parameter is left empty, both preset and custom templates are returned. Valid values: * Preset * Custom

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Number of eligible entries.
AIRecognitionTemplateSet	Array of AIRecognitionTemplateItem	List of video content recognition template details.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the video recognition template whose ID is 30

Input Example

https://mps.tencentcloudapi.com/?Action=DescribeAIRecognitionTemplates
&Definitions.0=30
&<Common request parameters>

Output Example

{
    "Response": {
        "TotalCount": 1,
        "AIRecognitionTemplateSet":[
            {
                "Definition": 30,
                "Name": "Template 1",
                "Type": "Preset",
                "Comment": "Intelligent content recognition template",
                "FaceConfigure":{
                    "Switch": "ON",
                    "Score": 0.0,
                    "FaceLibrary": "All"
                    "DefaultLibraryLabelSet": [
                        "xx"
                    ],
                    "UserDefineLibraryLabelSet": [
                        "xx"
                    ]
                },
                "OcrFullTextConfigure": {
                    "Switch": "ON"
                },
                "OcrWordsConfigure": {
                    "Switch": "OFF",
                    "LabelSet": [
                        "xx"
                    ]
                },
                "AsrFullTextConfigure": {
                    "Switch": "ON",
                    "SubtitleFormat": "xx"
                },
                "AsrWordsConfigure": {
                    "Switch": "OFF",
                    "LabelSet": [
                        "xx"
                    ]
                },
                "CreateTime": "2019-01-01T12:00:00Z",
                "UpdateTime": "2019-01-01T16:00:00Z"
            }
        ],
        "RequestId": "19ae8d8e-dce3-4151-9d4b-5594384987a9"
    }
}

Example2 Querying a specified number of video recognition templates

This example shows you how to get up to 10 video content recognition templates starting from the first record (offset = 0).

Input Example

https://mps.tencentcloudapi.com/?Action=DescribeAIRecognitionTemplates
&Offset=0
&Limit=10
&<Common request parameters>

Output Example

{
    "Response": {
        "TotalCount": 1,
        "AIRecognitionTemplateSet": [
            {
                "Definition": 30,
                "Name": "Template 1",
                "Comment": "Intelligent content recognition template",
                "Type": "Preset",
                "FaceConfigure": {
                    "Switch": "ON",
                    "Score": 0.0,
                    "FaceLibrary": "All"
                    "DefaultLibraryLabelSet": [
                        "xx"
                    ],
                    "UserDefineLibraryLabelSet": [
                        "xx"
                    ]
                },
                "OcrFullTextConfigure": {
                    "Switch": "ON"
                },
                "OcrWordsConfigure": {
                    "Switch": "OFF",
                    "LabelSet": []
                },
                "AsrFullTextConfigure": {
                    "Switch": "ON",
                    "SubtitleFormat": "xx"
                },
                "AsrWordsConfigure": {
                    "Switch": "OFF",
                    "LabelSet": []
                },
                "CreateTime": "2019-01-01T12:00:00Z",
                "UpdateTime": "2019-01-01T16:00:00Z"
            }
        ],
        "RequestId": "19ae8d8e-dce3-4151-9d4b-5594384987a9"
    }
}

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

Tencent Cloud CLI 3.0

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.Definitions	Parameter error: Definitions.
InvalidParameterValue.Limit	Parameter error: Limit.
ResourceNotFound.TemplateNotExist	The resource does not exist: the template does not exist.