tencent cloud

Feedback

CreateAIRecognitionTemplate

Last updated: 2022-08-23 16:03:00

1. API Description

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.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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.

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 for this API.
SubAppId No Integer The VOD subapplication ID. If you need to access a resource in a subapplication, set this parameter to the subapplication ID; otherwise, leave it empty.
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.
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.

3. Output Parameters

Parameter Name Type Description
Definition Integer Unique ID of video content recognition template.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a template to recognize opening and closing credits

This example shows you how to create a custom video recognition template to recognize opening and closing credits.

Input Example

https://vod.tencentcloudapi.com/?Action=CreateAIRecognitionTemplate
&Name=Opening and closing credits recognition template
&Comment=Template 1
&HeadTailConfigure.Switch=ON
&<Common request parameters>

Output Example

{
    "Response": {
        "Definition": 30,
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
    }
}

Example2 Creating a template for multiple content recognition tasks, with the frame capturing interval specified

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.

Input Example

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>

Output Example

{
    "Response": {
        "Definition": 32,
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
    }
}

Example3 Creating a template for multiple video content recognition tasks

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.

Input Example

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>

Output Example

{
    "Response": {
        "Definition": 31,
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
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 limit.
UnauthorizedOperation Unauthorized operation.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support