ModifyAIRecognitionTemplate

Last updated: 2020-11-24 18:53:49

1. API Description

Domain name for API request: vod.tencentcloudapi.com.

This API is used to modify a custom video content recognition template.

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: ModifyAIRecognitionTemplate.
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.
Definition Yes Integer Unique ID of video content recognition template.
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 HeadTailConfigureInfoForUpdate Control parameter of video opening and ending credits recognition.
SegmentConfigure No SegmentConfigureInfoForUpdate Control parameter of video splitting recognition.
FaceConfigure No FaceConfigureInfoForUpdate Control parameter of face recognition.
OcrFullTextConfigure No OcrFullTextConfigureInfoForUpdate Control parameter of full text recognition.
OcrWordsConfigure No OcrWordsConfigureInfoForUpdate Control parameter of text keyword recognition.
AsrFullTextConfigure No AsrFullTextConfigureInfoForUpdate Control parameter of full speech recognition.
AsrWordsConfigure No AsrWordsConfigureInfoForUpdate Control parameter of speech keyword recognition.
ObjectConfigure No ObjectConfigureInfoForUpdate Control parameter of object recognition.
ScreenshotInterval No Float Frame capturing interval in seconds. 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
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Disabling video opening and ending credits recognition tasks

This example shows you how to modify a custom video content recognition template to disable a video opening and ending credits recognition tasks.

Input Example

https://vod.tencentcloudapi.com/?Action=ModifyAIRecognitionTemplate
&Definition=30
&HeadTailConfigure.Switch=OFF
&<Public request parameters>

Output Example

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

Example2 Disabling a recognition task while enabling another one

This example shows you how to modify a custom video content recognition template to disable a video opening and ending credits recognition task and enable a video splitting recognition task.

Input Example

https://vod.tencentcloudapi.com/?Action=ModifyAIRecognitionTemplate
&Definition=30
&HeadTailConfigure.Switch=OFF
&SegmentConfigure.Switch=ON
&<Public request parameters>

Output Example

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

Example3 Modifying the frame capturing interval of content recognition

This example shows you how to modify a custom intelligent recognition template to change the frame capturing interval to 0.5 seconds.

Input Example

https://vod.tencentcloudapi.com/?Action=ModifyAIRecognitionTemplate
&Definition=30
&ScreenshotInterval=0.5
&<Public request parameters>

Output Example

{
  "Response": {
    "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.ModifyDefaultTemplate Incorrect parameter value: the default template cannot be modified.
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.
ResourceNotFound.TemplateNotExist The resource does not exist: the template does not exist.
UnauthorizedOperation Unauthorized operation.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help