Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to create a custom video content recognition template. Up to 50 templates can be created.
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: CreateAIRecognitionTemplate. |
| 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 | VOD application ID. Customers who activate VOD services after December 25, 2023 must fill this field with the application ID when accessing resources in on-demand applications (whether default or newly created). |
| Name | No | String | Audio and video content recognition template name. Length limit: 64 characters. |
| Comment | No | String | Audio/video content recognition template description. Length limit: 256 characters. |
| HeadTailConfigure | No | HeadTailConfigureInfo | Video opening and closing recognition control parameters. |
| SegmentConfigure | No | SegmentConfigureInfo | Video split recognition control parameters. |
| FaceConfigure | No | FaceConfigureInfo | Face recognition control parameter. |
| OcrFullTextConfigure | No | OcrFullTextConfigureInfo | Text Full-text Recognition Control Parameters. |
| OcrWordsConfigure | No | OcrWordsConfigureInfo | Text keyword recognition control parameters. |
| AsrFullTextConfigure | No | AsrFullTextConfigureInfo | Voice full-text recognition control parameters. Note: This parameter is no longer maintained. Use the AsrTranslateConfigure parameter to trigger voice translation recognition (when DstLanguage is left empty or filled with an empty string, no translation is performed, and the billing item matches that of full speech recognition). |
| AsrWordsConfigure | No | AsrWordsConfigureInfo | Voice keyword recognition control parameters. |
| AsrTranslateConfigure | No | AsrTranslateConfigureInfo | Voice translation recognition control parameters. |
| ObjectConfigure | No | ObjectConfigureInfo | Object recognition control parameters. |
| ScreenshotInterval | No | Float | Frame interception interval in seconds. If left empty, the default frame interval is 1 second with a minimum value of 0.5 seconds. |
| Parameter Name | Type | Description |
|---|---|---|
| Definition | Integer | Unique identifier of the audio/video content recognition template. |
| 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. |
Create a customized audio and video content recognition template with only the video opening and closing credits recognition task enabled.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAIRecognitionTemplate
<Common request parameters>
{
"Comment": "Template 1",
"HeadTailConfigure": {
"Switch": "ON"
},
"Name": "Video Start and End Recognition Task Template"
}
{
"Response": {
"Definition": 30,
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}
Create a customized audio and video content recognition template with only voice translation task enabled.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAIRecognitionTemplate
<Common request parameters>
{
"AsrTranslateConfigure": {
"Switch": "ON",
"SrcLanguage": "zh",
"DstLanguage": "en",
"SubtitleFormats": [
"vtt"
]
},
"Name": "Speech Translation Template_CN to EN"
}
{
"Response": {
"Definition": 31,
"RequestId": "0de23d47-ff58-41d7-80c4-c4fa7dbc6c21"
}
}
This example shows you how to create a customized audio and video content recognition template with video splitting and face recognition tasks enabled. The default and user-defined face libraries are used, the face recognition filter score is 90, and the frame interception interval is set to 1.0 seconds.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAIRecognitionTemplate
<Common request parameters>
{
"Comment": "Template 3",
"FaceConfigure": {
"Switch": "ON",
"FaceLibrary": "All"
},
"ScreenshotInterval": 1.0,
"Name": "Intelligent Identification Template"
"SegmentConfigure": {
"Switch": "ON"
}
}
{
"Response": {
"Definition": 32,
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}
This example shows you how to create a customized audio and video content recognition template with video splitting and face recognition tasks enabled. The default face library is used, and the face recognition filter score is 90.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAIRecognitionTemplate
<Common request parameters>
{
"Comment": "Template 2",
"FaceConfigure": {
"Switch": "ON",
"Score": 90,
"FaceLibrary": "Default"
},
"Name": "Intelligent Identification Template"
"SegmentConfigure": {
"Switch": "ON"
}
}
{
"Response": {
"Definition": 31,
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}
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. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue.Comment | Invalid parameter: template description. |
| InvalidParameterValue.DefaultLibraryLabelSet | Incorrect parameter value: the default face library filter tag is invalid. |
| InvalidParameterValue.FaceLibrary | Incorrect parameter value: the face library parameter is invalid. |
| InvalidParameterValue.FaceScore | Incorrect parameter value: the value of the face score parameter is invalid. |
| InvalidParameterValue.LabelSet | Incorrect parameter value: the value of the LabelSet parameter is invalid. |
| InvalidParameterValue.Name | Incorrect parameter value: Name exceeds the length limit. |
| InvalidParameterValue.ObjectLibrary | Incorrect parameter value: the value of the object library parameter is invalid. |
| InvalidParameterValue.ScreenshotInterval | Incorrect parameter value: the value of the ScreenshotInterval parameter is invalid. |
| InvalidParameterValue.SubtitleFormat | Incorrect parameter value: the value of the SubtitleFormat parameter is invalid. |
| InvalidParameterValue.Switch | Incorrect parameter value: the value of the Switch parameter is invalid. |
| InvalidParameterValue.UserDefineLibraryLabelSet | Incorrect parameter value: the custom face library filter tag is invalid. |
| LimitExceeded.TooMuchTemplate | Limit exceeded: The number of templates exceeds the upper limit of 100. If you need more, pleaseSubmit a ticket. |
| UnauthorizedOperation | Unauthorized operation. |
文档反馈