Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to get the list of audio/video content recognition templates by unique ID. The returned results include all eligible user-defined audio/video content recognition templates and system preset audio/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 Params. The value used for this API: DescribeAIRecognitionTemplates. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| SubAppId | No | Integer | ID of the on-demand application. For customers who activate on-demand services after December 25, 2023, this field must be set to the app ID when accessing resources in on-demand applications (whether the default application or a newly created application). |
| Definitions.N | No | Array of Integer | Filter condition for the unique identifier of the audio/video content recognition template. The array can contain up to 100 unique identifiers. |
| Type | No | String | Filtering condition for the template type. Valid values: |
| Offset | No | Integer | Pagination offset. Default value: 0. |
| Limit | No | Integer | Number of returned entries. Default value: 10. Maximum value: 100. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of records that meet the filtering conditions. |
| AIRecognitionTemplateSet | Array of AIRecognitionTemplateItem | List of audio/video content recognition template details. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to get up to 10 audio/video content recognition templates starting from the first record (offset = 0).
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAIRecognitionTemplates
<Common request parameters>
{
"Limit": 10,
"Offset": 0
}{
"Response": {
"TotalCount": 2,
"AIRecognitionTemplateSet": [
{
"Definition": 30,
"Name": "Template 1",
"Type": "Preset",
"Comment": "Intelligent Identification Template",
"HeadTailConfigure": {
"Switch": "ON"
},
"SegmentConfigure": {
"Switch": "ON"
},
"FaceConfigure": {
"Switch": "ON",
"FaceLibrary": "All",
"Score": 0,
"UserDefineLibraryLabelSet": [],
"DefaultLibraryLabelSet": []
},
"OcrFullTextConfigure": {
"Switch": "ON"
},
"OcrWordsConfigure": {
"Switch": "OFF",
"LabelSet": []
},
"AsrFullTextConfigure": {
"Switch": "ON",
"SrcLanguage": "",
"SubtitleFormats": []
},
"AsrTranslateConfigure": {
"Switch": "OFF",
"SrcLanguage": "",
"DstLanguage": "",
"SubtitleFormats": [],
"SubtitleName": ""
},
"AsrWordsConfigure": {
"Switch": "OFF",
"LabelSet": []
},
"ObjectConfigure": {
"Switch": "ON",
"ObjectLibrary": "All"
},
"ScreenshotInterval": 10,
"CreateTime": "2019-01-01T12:00:00Z",
"UpdateTime": "2019-01-01T16:00:00Z"
},
{
"Definition": 31,
"Name": "Template 2",
"Type": "Preset",
"Comment": "Intelligent Identification Template",
"HeadTailConfigure": {
"Switch": "ON"
},
"SegmentConfigure": {
"Switch": "OFF"
},
"FaceConfigure": {
"Switch": "OFF",
"FaceLibrary": "All",
"Score": 0,
"UserDefineLibraryLabelSet": [],
"DefaultLibraryLabelSet": []
},
"OcrFullTextConfigure": {
"Switch": "OFF"
},
"OcrWordsConfigure": {
"Switch": "OFF",
"LabelSet": []
},
"AsrFullTextConfigure": {
"Switch": "OFF",
"SrcLanguage": "",
"SubtitleFormats": []
},
"AsrTranslateConfigure": {
"Switch": "OFF",
"SrcLanguage": "",
"DstLanguage": "",
"SubtitleFormats": [],
"SubtitleName": ""
},
"AsrWordsConfigure": {
"Switch": "OFF",
"LabelSet": []
},
"ObjectConfigure": {
"Switch": "ON",
"ObjectLibrary": "All"
},
"ScreenshotInterval": 10,
"CreateTime": "2019-01-01T11:00:00Z",
"UpdateTime": "2019-01-01T12:00:00Z"
}
],
"RequestId": "19ae8d8e-dce3-4151-9d4b-5594384987a9"
}
}Obtain the audio/video content recognition template with template ID 30.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAIRecognitionTemplates
<Common request parameters>
{
"Definitions": [
30
]
}{
"Response": {
"TotalCount": 1,
"AIRecognitionTemplateSet": [
{
"Definition": 30,
"Name": "Template 1",
"Type": "Preset",
"Comment": "Intelligent Identification Template"
"HeadTailConfigure": {
"Switch": "ON"
},
"SegmentConfigure": {
"Switch": "ON"
},
"FaceConfigure": {
"Switch": "ON",
"FaceLibrary": "All",
"Score": 0,
"UserDefineLibraryLabelSet": [],
"DefaultLibraryLabelSet": []
},
"OcrFullTextConfigure": {
"Switch": "ON"
},
"OcrWordsConfigure": {
"Switch": "OFF",
"LabelSet": []
},
"AsrFullTextConfigure": {
"Switch": "ON",
"SrcLanguage": "",
"SubtitleFormats": []
},
"AsrTranslateConfigure": {
"Switch": "OFF",
"SrcLanguage": "",
"DstLanguage": "",
"SubtitleFormats": [],
"SubtitleName": ""
},
"AsrWordsConfigure": {
"Switch": "OFF",
"LabelSet": []
},
"ObjectConfigure": {
"Switch": "ON",
"ObjectLibrary": "All"
},
"ScreenshotInterval": 10,
"CreateTime": "2019-01-01T12:00:00Z",
"UpdateTime": "2019-01-01T16: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 | Operation failed. |
| FailedOperation.InvalidVodUser | The VOD service is not activated. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue.Definitions | Parameter error: Definitions. |
| InvalidParameterValue.Limit | Parameter error: Limit. |
| InvalidParameterValue.Type | Type parameter value error. |
| ResourceNotFound.TemplateNotExist | Resource does not exist: template does not exist. |
| UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback