CreateAIRecognitionTemplate

Last updated: 2020-12-23 15:36:53

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 parameter. The value used for this API: CreateAIRecognitionTemplate.
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.
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.
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.

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 task template that supports only video opening and ending credits recognition

This example shows you how to create a custom video content recognition template to enable only a video opening and ending credits recognition task.

Input Example

https://vod.tencentcloudapi.com/?Action=CreateAIRecognitionTemplate
&Name=Video opening and ending credits recognition task 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 that supports multiple video content recognition tasks

This example shows you how to create a custom video content recognition template to enable 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 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"
  }
}

Example3 Creating a template that supports multiple recognition tasks and specifies the frame capturing interval

This example shows you how to create a custom video content recognition template to enable 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 recognition template