tencent cloud

APIs

ModifyAIRecognitionTemplate

下载
聚焦模式
字号
最后更新时间: 2026-09-22 21:49:29

1. API Description

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

This API is used to modify a user-defined audio and video 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: 2018-07-17.
Region No String Common Params. This parameter is not required.
Definition Yes Integer Unique ID of the audio/video content recognition template.
SubAppId No Integer VOD application ID. For customers who activate VOD after December 25, 2023, this field must be set to the app ID when accessing resources in VOD applications (whether the default application or a newly created application).
Name No String Audio/Video content recognition template name, with a length limit of 64 characters.
Comment No String Description of the audio/video content recognition template, with a length limit of 256 characters.
HeadTailConfigure No HeadTailConfigureInfoForUpdate Video opening and closing recognition control parameter.
SegmentConfigure No SegmentConfigureInfoForUpdate Video split recognition control parameters.
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.
Note: This parameter is no longer maintained. It is recommended to use the AsrTranslateConfigure parameter to initiate voice translation recognition (when DstLanguage is not specified or is an empty string, no translation is performed, and the billing item is the same as full text speech recognition).
AsrWordsConfigure No AsrWordsConfigureInfoForUpdate Voice keyword recognition control parameters.
AsrTranslateConfigure No AsrTranslateConfigureInfoForUpdate Voice translation recognition control parameters.
ObjectConfigure No ObjectConfigureInfoForUpdate Object recognition control parameter.
ScreenshotInterval No Float Frame interval in seconds, with a minimum value of 0.5 seconds.

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 Frame Capturing Interval for Modification Content Recognition

Modify a custom intelligent recognition template to change the frame interception interval to 0.5 seconds.

Input Example

POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAIRecognitionTemplate
<Common request parameters>

{
    "Definition": 30,
    "ScreenshotInterval": 0.5
}

Output Example

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

Example2 Disabling the Video Opening and Closing Credits Recognition Task

This example shows you how to disable the video opening and closing credits recognition task in a customized audio and video content recognition template.

Input Example

POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAIRecognitionTemplate
<Common request parameters>

{
    "Definition": 30,
    "HeadTailConfigure": {
        "Switch": "OFF"
    }
}

Output Example

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

Example3 Disabling and Enabling an Identification Task

This example shows you how to disable video opening and closing credits recognition and enable video splitting in a custom audio and video content recognition template.

Input Example

POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAIRecognitionTemplate
<Common request parameters>

{
    "Definition": 30,
    "SegmentConfigure": {
        "Switch": "ON"
    },
    "HeadTailConfigure": {
        "Switch": "OFF"
    }
}

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

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.Comment Parameter error: description of this template.
InvalidParameterValue.DefaultLibraryLabelSet Incorrect parameter value: the default human face library filter tag is invalid.
InvalidParameterValue.FaceLibrary Incorrect parameter value: invalid face library parameter.
InvalidParameterValue.FaceScore Incorrect parameter value: the face score parameter value is invalid.
InvalidParameterValue.LabelSet Parameter value error: Invalid LabelSet parameter value.
InvalidParameterValue.ModifyDefaultTemplate Parameter value error: The default template cannot be modified.
InvalidParameterValue.Name Parameter value error: Name exceeds the length limit.
InvalidParameterValue.ObjectLibrary Parameter value error: Invalid object library parameter.
InvalidParameterValue.ScreenshotInterval Parameter value error: Invalid ScreenshotInterval parameter value.
InvalidParameterValue.SubtitleFormat Parameter value error: Invalid SubtitleFormat parameter.
InvalidParameterValue.Switch Incorrect parameter value: the Switch parameter value is invalid.
InvalidParameterValue.UserDefineLibraryLabelSet Parameter value error: the custom face library filter tag is invalid.
ResourceNotFound.TemplateNotExist Resource does not exist: template not found.
UnauthorizedOperation Unauthorized operation.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈