tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateAIAnalysisTemplate

Last updated: 2024-03-27 16:08:23

    1. API Description

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

    This API is used to create a custom video 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: 2018-07-17.
    Region No String Common Params. This parameter is not required.
    SubAppId No Integer The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    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.
    HighlightConfigure No HighlightsConfigureInfo Control parameter of an intelligent highlight generating task.

    3. Output Parameters

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

    This example shows you how to create a custom video content analysis template to enable intelligent categorization tasks.

    Input Example

    https://vod.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 to enable all content analysis tasks

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

    Input Example

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

    Output Example

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

    Example3 Creating a template for multiple analysis tasks

    This example shows you how to create a custom video content analysis template to enable intelligent categorization and intelligent tagging tasks.

    Input Example

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

    Output Example

    {
    "Response": {
        "Definition": 31,
        "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 Invalid parameter.
    InvalidParameterValue.ClassifcationConfigure The control field parameter for intelligent categorization is incorrect.
    InvalidParameterValue.Comment Invalid parameter: template description.
    InvalidParameterValue.CoverConfigure The control field parameter for intelligent cover generation is incorrect.
    InvalidParameterValue.Definition Invalid parameter: Definition.
    InvalidParameterValue.FrameTagConfigure The control field parameter for intelligent frame-specific tagging is incorrect.
    InvalidParameterValue.HighlightConfigure Invalid intelligent highlight generating control parameter.
    InvalidParameterValue.Name Incorrect parameter value: Name exceeds the length limit.
    InvalidParameterValue.TagConfigure The control field parameter for intelligent tagging is incorrect.
    LimitExceeded.TooMuchTemplate Limit exceeded: The number of templates exceeds the upper limit of 100. If you need more, pleaseSubmit a ticket。
    UnauthorizedOperation Unauthorized operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy