Domain name for API request: vod.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 | The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID. |
Name | No | String | Video content recognition template name. Length limit: 64 characters. |
Comment | No | String | Description of video content recognition template. Length limit: 256 characters. |
HeadTailConfigure | No | HeadTailConfigureInfo | Control parameter of video opening and ending credits recognition. |
SegmentConfigure | No | SegmentConfigureInfo | Control parameter of video splitting recognition. |
FaceConfigure | No | FaceConfigureInfo | Control parameter of face recognition. |
OcrFullTextConfigure | No | OcrFullTextConfigureInfo | Control parameter of full text recognition. |
OcrWordsConfigure | No | OcrWordsConfigureInfo | Control parameter of text keyword recognition. |
AsrFullTextConfigure | No | AsrFullTextConfigureInfo | Control parameter of full speech recognition. |
AsrWordsConfigure | No | AsrWordsConfigureInfo | Control parameter of speech keyword recognition. |
AsrTranslateConfigure | No | AsrTranslateConfigureInfo | Control parameter of voice translation. |
ObjectConfigure | No | ObjectConfigureInfo | Control parameter of object recognition. |
ScreenshotInterval | No | Float | Frame capturing interval in seconds. If this parameter is left empty, 1 second will be used by default. Minimum value: 0.5 seconds. |
Parameter Name | Type | Description |
---|---|---|
Definition | Integer | Unique ID of 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. |
This example shows you how to create a custom video recognition template to recognize opening and closing credits.
https://vod.tencentcloudapi.com/?Action=CreateAIRecognitionTemplate
&Name=Opening and closing credits recognition template
&Comment=Template 1
&HeadTailConfigure.Switch=ON
&<Common request parameters>
{
"Response": {
"Definition": 30,
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}
Create a custom audio and video content recognition template, enabling only the voice translation task.
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAIRecognitionTemplate
<Common request parameters>
{
"AsrTranslateConfigure": {
"Switch": "ON",
"SrcLanguage": "zh",
"DstLanguage": "en",
"SubtitleFormats": [
"vtt"
]
},
"Name": "VoiceTranslationTemplateChineseToEnglish"
}
{
"Response": {
"Definition": 31,
"RequestId": "0de23d47-ff58-41d7-80c4-c4fa7dbc6c21"
}
}
This example shows you how to create a custom video content recognition template for a splitting task and a face recognition task. The default face library is used, and the face recognition filter score is 90.
https://vod.tencentcloudapi.com/?Action=CreateAIRecognitionTemplate
&Name=Intelligent content recognition template
&Comment=Template 2
&SegmentConfigure.Switch=ON
&FaceConfigure.Switch=ON
&FaceConfigure.FaceLibrary=Default
&FaceConfigure.Score=90
&<Common request parameters>
{
"Response": {
"Definition": 31,
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}
This example shows you how to create a custom video content recognition template for a splitting task and a face recognition task. The default and custom face libraries are used, the face recognition filter score is 90, and the frame capturing interval is 1.0 second.
https://vod.tencentcloudapi.com/?Action=CreateAIRecognitionTemplate
&Name=Intelligent content recognition template
&Comment=Template 3
&SegmentConfigure.Switch=ON
&FaceConfigure.Switch=ON
&FaceConfigure.FaceLibrary=All
&ScreenshotInterval=1.0
&<Common request parameters>
{
"Response": {
"Definition": 32,
"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 | Invalid parameter. |
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. |
Was this page helpful?