ModifyAIAnalysisTemplate

Last updated: 2020-03-27 18:45:30

1. API Description

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

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

Note: templates with an ID below 10000 are preset and cannot be modified.

A maximum of 10 requests can be initiated per second for this API.

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: ModifyAIAnalysisTemplate.
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 analysis template.
Name No String Video content analysis template name. Length limit: 64 characters.
Comment No String Video content analysis template description. Length limit: 256 characters.
ClassificationConfigure No ClassificationConfigureInfoForUpdate Control parameter of intelligent categorization task.
TagConfigure No TagConfigureInfoForUpdate Control parameter of intelligent tagging task.
CoverConfigure No CoverConfigureInfoForUpdate Control parameter of intelligent cover generating task.
FrameTagConfigure No FrameTagConfigureInfoForUpdate Control parameter of intelligent frame-specific tagging task.
HighlightConfigure No HighlightsConfigureInfoForUpdate Control parameter of an intelligent highlight generating task.
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 Enabling an intelligent cover generating task

This example shows you how to modify a custom video content analysis template to enable an intelligent cover generating task.

Input Example

https://vod.tencentcloudapi.com/?Action=ModifyAIAnalysisTemplate
&Definition=30
&CoverConfigure.Switch=ON
&<Common request parameters>

Output Example

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

Example2 Disabling an intelligent cover generating task

This example shows you how to modify a custom video content analysis template to disable an intelligent cover generating task.

Input Example

https://vod.tencentcloudapi.com/?Action=ModifyAIAnalysisTemplate
&Definition=30
&CoverConfigure.Switch=OFF
&<Common request parameters>

Output Example

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

Example3 Enabling a content analysis task and disabling another one at the same time

This example shows you how to modify a custom video content analysis template to enable an intelligent tagging task and disable an intelligent cover generating task.

Input Example

https://vod.tencentcloudapi.com/?Action=ModifyAIAnalysisTemplate
&Definition=30
&TagConfigure.Switch=ON
&CoverConfigure.Switch=OFF
&<Common request parameters>

Output Example

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

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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.ClassifcationConfigure The control field parameter for intelligent categorization is incorrect.
InvalidParameterValue.Comment Invalid parameter: template description.
InvalidParameterValue.CoverConfigure The control field parameter for intelligent cover generation is incorrect.
InvalidParameterValue.FrameTagConfigure The control field parameter for intelligent frame-specific tagging is incorrect.
InvalidParameterValue.HighlightConfigure Invalid intelligent highlight generating control parameter.
InvalidParameterValue.Name Incorrect parameter value: Name exceeds the length limit.
InvalidParameterValue.TagConfigure The control field parameter for intelligent tagging is incorrect.
ResourceNotFound The resource does not exist.
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