CreateContentReviewTemplate

Last updated: 2021-05-10 15:11:02

    1. API Description

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

    This API is used to create custom intelligent video content recognition templates. 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 parameter. The value used for this API: CreateContentReviewTemplate.
    Version Yes String Common parameter. The value used for this API: 2018-07-17.
    Region No String Common parameter. This parameter is not required for this API.
    ReviewWallSwitch Yes String Whether to allow the recognition result to enter the intelligent recognition platform (for human recognition).
  • ON: yes
  • OFF: no
  • Name No String Name of an intelligent content recognition template. Length limit: 64 characters.
    Comment No String Description of an intelligent content recognition template. Length limit: 256 characters.
    PornConfigure No PornConfigureInfo Control parameter for porn information.
    TerrorismConfigure No TerrorismConfigureInfo Control parameter for terrorism information.
    PoliticalConfigure No PoliticalConfigureInfo Control parameter for politically sensitive information.
    ProhibitedConfigure No ProhibitedConfigureInfo Control parameter of prohibited information detection. Prohibited information includes:
  • Abusive;
  • Drug-related.
  • UserDefineConfigure No UserDefineConfigureInfo Control parameter for custom intelligent content recognition.
    ScreenshotInterval No Float Frame capturing interval in seconds. If this parameter is left empty, 1 second will be used by default. Minimum value: 0.5 seconds.
    SubAppId No Integer Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty.

    3. Output Parameters

    Parameter Name Type Description
    Definition Integer Unique ID of an intelligent recognition template.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Creating an intelligent content recognition template to enable only a porn information recognition task

    This example shows you how to create a custom intelligent content recognition template to enable only a porn information recognition task, with the following configuration. Threshold scores for rule violation and human recognition: default values; filter tags: not specified.

    Input Example

    https://vod.tencentcloudapi.com/?Action=CreateContentReviewTemplate
    &Name=Intelligent content recognition template
    &Comment=Template 1
    &PornConfigure.ImgReviewInfo.Switch=ON
    &ReviewWallSwitch=OFF
    &<Common request parameters>
    

    Output Example

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

    Example2 Creating an intelligent content recognition template to enable only a porn information recognition task, with threshold scores and the frame capturing interval specified

    This example shows you how to create a custom intelligent content recognition template to enable only a porn information recognition task, with the following configuration. Threshold scores for rule violation and human recognition: 80 and 30, respectively; frame capturing interval: 1 second.

    Input Example

    https://vod.tencentcloudapi.com/?Action=CreateContentReviewTemplate
    &Name=Intelligent content recognition template
    &Comment=Template 2
    &PornConfigure.ImgReviewInfo.Switch=ON
    &PornConfigure.ImgReviewInfo.BlockConfidence=80
    &PornConfigure.ImgReviewInfo.ReviewConfidence=30
    &ScreenshotInterval=1
    &ReviewWallSwitch=OFF
    &<Common request parameters>
    

    Output Example

    {
      "Response": {
        "Definition": 31,
        "RequestId": "97aee3e9-2qd3-4151-9d4b-9730a45227a9"
      }
    }
    

    Example3 Creating an intelligent content recognition template to enable multiple recognition tasks

    This example shows you how to create a cu