ModifyAIAnalysisTemplate

Last updated: 2023-10-12 16:44:41Download PDF

1. API Description

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

This API is used to modify a custom 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.

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: ModifyAIAnalysisTemplate.
Version	Yes	String	Common Params. The value used for this API: 2019-06-12.
Region	No	String	Common Params. 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.

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 intelligent thumbnail generation

This example shows you how to enable intelligent thumbnail generation in a custom video content analysis template.

Input Example

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

Output Example

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

Example2 Disabling intelligent thumbnail generation

This example shows you how to disable intelligent thumbnail generation in a custom video content analysis template.

Input Example

https://mps.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

This example shows you how to enable intelligent labeling and disable intelligent thumbnail generation in a custom video content analysis template.

Input Example

https://mps.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

SDK

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

Command Line Interface

Tencent Cloud CLI 3.0

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	Parameter error.
InvalidParameterValue.ClassifcationConfigure	Incorrect parameter value: the control field parameter for intelligent categorization is incorrect.
InvalidParameterValue.Comment	Parameter error: template description.
InvalidParameterValue.CoverConfigure	Incorrect parameter value: the control field parameter for intelligent cover generation is incorrect.
InvalidParameterValue.FrameTagConfigure	Incorrect parameter value: the control field parameter for intelligent frame-specific tagging is incorrect.
InvalidParameterValue.Name	Incorrect parameter value: `Name` exceeds the length limit.
InvalidParameterValue.TagConfigure	Incorrect parameter value: 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.