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.
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: DescribeAIRecognitionTemplates. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-07-17. |
| Region | No | String | Common parameter. 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: 100. |
| Offset | No | Integer | Pagination offset. Default value: 0. |
| Limit | No | Integer | Number of returned entries. Default value: 10. Maximum value: 100. |
| SubAppId | No | Integer | Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty. |
| 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. |
This example shows you how to get 10 video content recognition templates with the serial number starting from 0.
https://vod.tencentcloudapi.com/?Action=DescribeAIRecognitionTemplates
&Definitions.0=30
&<Common request parameters>
{
"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"
}
}
This example shows you how to get 10 video content recognition templates with the serial number starting from 0.
https://vod.tencentcloudapi.com/?Action=DescribeAIRecognitionTemplates
&Offset=0
&Limit=10
&<Common request parameters>
{
"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"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.InvalidVodUser | The VOD service is not activated. |
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue.Definitions | Invalid parameter: Definitions. |
| InvalidParameterValue.Limit | Invalid parameter: Limit. |
| ResourceNotFound.TemplateNotExist | The resource does not exist: the template does not exist. |
| UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?