Creates intelligent video content recognition templates

Last updated: 2021-01-21 11:42:29

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 custom intelligent content recognition template to enable porn, terrorism, and politically sensitive information recognition, 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 3
    &PornConfigure.ImgReviewInfo.Switch=ON
    &TerrorismConfigure.ImgReviewInfo.Switch=ON
    &TerrorismConfigure.OcrReviewInfo=null
    &PoliticalConfigure.ImgReviewInfo.Switch=ON
    &ReviewWallSwitch=OFF
    &<Common request parameters>

    Output Example

    {
      "Response": {
        "Definition": 32,
        "RequestId": "88aee3e9-2qd3-4151-9d4b-4390a45227a9"
      }
    }

    Example4 Creating an intelligent content recognition template to enable a porn information recognition task with filter tags specified

    This example shows you how to create a custom intelligent content recognition template to enable a porn information recognition task, with the following configuration. Filter tags: "porn" and "sexy"; threshold scores for rule violation and human recognition: default values.

    Input Example

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

    Output Example

    {
      "Response": {
        "Definition": 33,
        "RequestId": "67aee3e9-2qd3-2395-9d4b-4390a96837a7"
      }
    }

    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
    FailedOperation.InvalidVodUser The VOD service is not activated.
    InternalError Internal error.
    InternalError.GenDefinition Internal error: failed to generate template ID.
    InvalidParameterValue.BlockConfidence Incorrect parameter value: the value of the BlockConfidence parameter is invalid.
    InvalidParameterValue.Comment Invalid parameter: template description.
    InvalidParameterValue.LabelSet Incorrect parameter value: the value of the LabelSet parameter is invalid.
    InvalidParameterValue.Name Incorrect parameter value: Name exceeds the length limit.
    InvalidParameterValue.ReviewConfidence Incorrect parameter value: the value of the ReviewConfidence parameter is invalid.
    InvalidParameterValue.ReviewWallSwitch Incorrect parameter value: the value of the ReviewWallSwitch parameter is invalid.
    InvalidParameterValue.ScreenshotInterval Incorrect parameter value: the value of the ScreenshotInterval parameter is invalid.
    InvalidParameterValue.Switch Incorrect parameter value: the value of the Switch parameter is invalid.
    LimitExceeded.TooMuchTemplate Limit exceeded: the number of templates exceeds the limit.
    UnauthorizedOperation Unauthorized operation.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help