ModifyAIRecognitionTemplate

Last updated: 2026-08-14 16:33:28Download PDF

1. API Description

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

This API is used to modify a user-defined 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 Params. The value used for this API: ModifyAIRecognitionTemplate.
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 identifier of a video content recognition template.
Name	No	String	Video content recognition template name, length limited to 64 characters.
Comment	No	String	Video Content Recognition template description, length limited to 256 characters.
FaceConfigure	No	FaceConfigureInfoForUpdate	Face Recognition Control Parameter.
OcrFullTextConfigure	No	OcrFullTextConfigureInfoForUpdate	Text Full-text Recognition Control Parameters.
OcrWordsConfigure	No	OcrWordsConfigureInfoForUpdate	Text keyword recognition control parameters.
AsrFullTextConfigure	No	AsrFullTextConfigureInfoForUpdate	Voice full-text recognition control parameters.
AsrWordsConfigure	No	AsrWordsConfigureInfoForUpdate	Voice keyword recognition control parameters.
TranslateConfigure	No	TranslateConfigureInfoForUpdate	Voice translation control parameters.

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Disabling and enabling an identification task

This example shows you how to modify a custom video content recognition template to disable the full text recognition task and enable the text keyword recognition task.

Input Example

https://mps.intl.tencentcloudapi.com/?Action=ModifyAIRecognitionTemplate
&Definition=30
&OcrFullTextConfigure.Switch=OFF
&OcrWordsConfigure.Switch=ON
&<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
FailedOperation.InvalidMpsUser	Operation failed: unauthorized MPS user.
InternalError	Internal error.
InvalidParameter	Parameter error.
InvalidParameterValue.Comment	Parameter error: template description.
InvalidParameterValue.DefaultLibraryLabelSet	Parameter value error: the filter tag of the default human face library is invalid.
InvalidParameterValue.FaceLibrary	Parameter value error: the face library parameter is invalid.
InvalidParameterValue.FaceScore	Parameter value error: the Face Score parameter value is invalid.
InvalidParameterValue.LabelSet	Incorrect parameter value: invalid `LabelSet` value.
InvalidParameterValue.ModifyDefaultTemplate	Parameter value error: Default template not allowed to be modified.
InvalidParameterValue.Name	Incorrect parameter value: `Name` exceeds the length limit.
InvalidParameterValue.ObjectLibrary	Parameter value error: the object library parameter is invalid.
InvalidParameterValue.SourceLanguage	A SourceLanguage parameter error occurs.
InvalidParameterValue.SubtitleFormat	Parameter value error: the SubtitleFormat parameter is invalid.
InvalidParameterValue.Switch	Incorrect parameter value: invalid `Switch` value.
InvalidParameterValue.UserDefineLibraryLabelSet	Parameter value error: the filter tag of the custom face library is invalid.
ResourceNotFound.TemplateNotExist	The resource does not exist: the template does not exist.