tencent cloud

云点播

ModifyAIRecognitionTemplate

Download
聚焦模式
字号
最后更新时间: 2026-05-19 15:00:46

1. API Description

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

This API is used to modify a custom 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 identifier of the audio/video content recognition template.
SubAppId No Integer On-demand application ID. Customers who activate on-demand services from December 25, 2023 must fill this field with the app ID when accessing resources in on-demand applications (whether default or newly created).
Name No String Audio and video content recognition template name. The length cannot exceed 64 characters.
Comment No String Audio/video content recognition template description, with a length limit of 256 characters.
HeadTailConfigure No HeadTailConfigureInfoForUpdate Video opening and closing recognition control parameters.
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 trigger voice translation recognition (when DstLanguage is left blank or filled with an empty string, no translation will be performed, and the billing item will match full text recognition).
AsrWordsConfigure No AsrWordsConfigureInfoForUpdate Voice keyword recognition control parameters.
AsrTranslateConfigure No AsrTranslateConfigureInfoForUpdate Voice translation recognition control parameters.
ObjectConfigure No ObjectConfigureInfoForUpdate Object recognition control parameters.
ScreenshotInterval No Float Frame interception interval, unit: seconds, minimum value 0.5.

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 Modify content recognition frame capturing interval

Modify the custom intelligent recognition template and 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 Disable 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 Simultaneously

This example shows you how to modify a customized audio and video content recognition template by disabling the video opening and closing credits recognition task and enabling the video splitting task.

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 Invalid parameter: template description.
InvalidParameterValue.DefaultLibraryLabelSet Incorrect parameter value: the default face library filter tag is invalid.
InvalidParameterValue.FaceLibrary Incorrect parameter value: the face library parameter is invalid.
InvalidParameterValue.FaceScore Incorrect parameter value: the value of the face score parameter is invalid.
InvalidParameterValue.LabelSet Incorrect parameter value: the value of the LabelSet parameter is invalid.
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: the value of the object library parameter is invalid.
InvalidParameterValue.ScreenshotInterval Incorrect parameter value: the value of the ScreenshotInterval parameter is invalid.
InvalidParameterValue.SubtitleFormat Incorrect parameter value: the value of the SubtitleFormat parameter is invalid.
InvalidParameterValue.Switch Incorrect parameter value: the value of the Switch parameter is invalid.
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.
UnauthorizedOperation Unauthorized operation.

帮助和支持

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

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

文档反馈