1. API Description

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

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

A maximum of 10 requests can be initiated per second for this API.

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.

3. Output Parameters

4. Example

Example1 Getting the video content recognition template whose ID is 30

This example shows you how to get 10 video content recognition templates with the serial number starting from 0.

Input Example

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

Output Example

{
  "Response": {
    "TotalCount": 1,
    "AIRecognitionTemplateSet": [
      {
        "Definition": 30,
        "Name": "Template 1",
        "Comment": "Intelligent recognition template",
        "HeadTailConfigure": {
          "Switch": "ON"
        },
        "SegmentConfigure": {
          "Switch": "ON"
        },
        "FaceConfigure": {
          "Switch": "ON",
          "FaceLibrary": "All"
        },
        "OcrFullTextConfigure": {
          "Switch": "ON"
        },
        "OcrWordsConfigure": {
          "Switch": "OFF",
          "LabelSet": null
        },
        "AsrFullTextConfigure": {
          "Switch": "ON"
        },
        "AsrWordsConfigure": {
          "Switch": "OFF",
          "LabelSet": null
        },
        "ObjectConfigure": {
          "Switch": "ON",
          "ObjectLibrary": "All"
        },
        "CreateTime": "2019-01-01T12:00:00Z",
        "UpdateTime": "2019-01-01T16:00:00Z"
      }
    ],
    "RequestId": "19ae8d8e-dce3-4151-9d4b-5594384987a9"
  }
}

Example2 Getting a specified number of video content recognition templates

This example shows you how to get 10 video content recognition templates with the serial number starting from 0.

Input Example

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

Output Example

{
    "Response": {
        "TotalCount":2,
        "AIRecognitionTemplateSet":[
            {
                "Definition":30,
                "Name":"Template 1",
                "Comment":"Intelligent recognition template",
                "HeadTailConfigure":{
                    "Switch":"ON"
                },
                "SegmentConfigure":{
                    "Switch":"ON"
                },
                "FaceConfigure":{
                    "Switch":"ON",
                    "FaceLibrary":"All",
                    "LabelSet":[

                    ]
                },
                "OcrFullTextConfigure":{
                    "Switch":"ON"
                },
                "OcrWordsConfigure":{
                    "Switch":"OFF",
                    "LabelSet": null
                },
                "AsrFullTextConfigure":{
                    "Switch":"ON"
                },
                "AsrWordsConfigure":{
                    "Switch":"OFF",
                    "LabelSet": null
                },
                "ObjectConfigure":{
                    "Switch":"ON",
                    "ObjectLibrary":"All"
                },
                "CreateTime":"2019-01-01T12:00:00Z",
                "UpdateTime":"2019-01-01T16:00:00Z"
            },
            {
                "Definition":31,
                "Name":"Template 2",
                "Comment":"Intelligent recognition template",
                "HeadTailConfigure":{
                    "Switch":"ON"
                },
                "SegmentConfigure":{
                    "Switch":"OFF"
                },
                "FaceConfigure":{
                    "Switch":"OFF"
                    "FaceLibrary":"All",
                    "LabelSet":[

                    ]
                },
                "OcrFullTextConfigure":{
                    "Switch":"OFF"
                },
                "OcrWordsConfigure":{
                    "Switch":"OFF"
                    "LabelSet": null
                },
                "AsrFullTextConfigure":{
                    "Switch":"OFF"
                },
                "AsrWordsConfigure":{
                    "Switch":"OFF"
                    "LabelSet": null
                },
                "ObjectConfigure":{
                    "Switch":"ON",
                    "ObjectLibrary":"All"
                },
                "CreateTime":"2019-01-01T11:00:00Z",
                "UpdateTime":"2019-01-01T12: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.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for NodeJS
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

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.