CreateAIAnalysisTemplate

1. API Description

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

This API is used to create a custom content analysis 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: CreateAIAnalysisTemplate.
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.
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	ClassificationConfigureInfo	Control parameter of intelligent categorization task.
TagConfigure	No	TagConfigureInfo	Control parameter of intelligent tagging task.
CoverConfigure	No	CoverConfigureInfo	Control parameter of intelligent cover generating task.
FrameTagConfigure	No	FrameTagConfigureInfo	Control parameter of intelligent frame-specific tagging task.

3. Output Parameters

Parameter Name	Type	Description
Definition	Integer	Unique ID of video content analysis 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 for a video analysis task

This example shows you how to create a custom video analysis template to perform intelligent categorization.

Input Example

https://mps.tencentcloudapi.com/?Action=CreateAIAnalysisTemplate
&Name=Intelligent analysis template
&Comment=Template 1
&ClassificationConfigure.Switch=ON
&<Common request parameters>

Output Example

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

Example2 Creating a template for multiple analysis tasks

This example shows you how to create a custom video analysis template to perform intelligent categorization and labeling.

Input Example

https://mps.tencentcloudapi.com/?Action=CreateAIAnalysisTemplate
&Name=Intelligent analysis template
&Comment=Template 2
&ClassificationConfigure.Switch=ON
&TagConfigure.Switch=ON
&<Common request parameters>

Output Example

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

Example3 Creating a template to perform all content analysis tasks

This example shows you how to create a custom video analysis template to perform all intelligent analysis tasks.

Input Example

https://mps.tencentcloudapi.com/?Action=CreateAIAnalysisTemplate
&Name=Intelligent analysis template
&Comment=Template 3
&ClassificationConfigure.Switch=ON
&TagConfigure.Switch=ON
&CoverConfigure.Switch=NO
&FrameTagConfigure.Switch=ON
&<Common request parameters>

Output Example

{
    "Response": {
        "Definition": 33,
        "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
FailedOperation.InvalidMpsUser	Operation failed: unauthorized MPS user.
InternalError	Internal error.
InvalidParameterValue	Incorrect parameter value.
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.Definition	Parameter error: Definition.
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.
LimitExceeded.TooMuchTemplate	Limit reached: the number of templates exceeds the limit.