ModifyAIRecognitionTemplate

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 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 ID of a video content recognition template.
Name	No	String	Name of a video content recognition template. Length limit: 64 characters.
Comment	No	String	Description of a video content recognition template. Length limit: 256 characters.
FaceConfigure	No	FaceConfigureInfoForUpdate	Face recognition control parameter.
OcrFullTextConfigure	No	OcrFullTextConfigureInfoForUpdate	Full text recognition control parameter.
OcrWordsConfigure	No	OcrWordsConfigureInfoForUpdate	Text keyword recognition control parameter.
AsrFullTextConfigure	No	AsrFullTextConfigureInfoForUpdate	Full speech recognition control parameter.
AsrWordsConfigure	No	AsrWordsConfigureInfoForUpdate	Speech keyword recognition control parameter.

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 a content recognition task and disabling another

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

Input Example

https://mps.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	Incorrect parameter value: the default face library filter tag is invalid.
InvalidParameterValue.FaceLibrary	Incorrect parameter value: invalid face library parameter.
InvalidParameterValue.FaceScore	Incorrect parameter value: the value of the face score parameter is invalid.
InvalidParameterValue.LabelSet	Incorrect parameter value: invalid `LabelSet` value.
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: object library parameter is invalid.
InvalidParameterValue.SubtitleFormat	Incorrect parameter value: The value of the `SubtitleFormat` parameter is invalid.
InvalidParameterValue.Switch	Incorrect parameter value: invalid `Switch` value.
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.