CreateContentReviewTemplate

Last updated: 2020-09-25 14:22:47

1. API Description

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

This API is used to create a custom content audit 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 parameter. The value used for this API: CreateContentReviewTemplate.
Version Yes String Common parameter. The value used for this API: 2019-06-12.
Region No String Common parameter. This parameter is not required for this API.
Name No String Name of a content audit template. Length limit: 64 characters.
Comment No String Description of a content audit template. Length limit: 256 characters.
PornConfigure No PornConfigureInfo Porn information detection control parameter.
TerrorismConfigure No TerrorismConfigureInfo Terrorism information detection control parameter.
PoliticalConfigure No PoliticalConfigureInfo Politically sensitive information detection control parameter.
ProhibitedConfigure No ProhibitedConfigureInfo Control parameter of prohibited information detection. Prohibited information includes:
  • Abusive;
  • Drug-related.

  • Note: this parameter is not supported yet.
    UserDefineConfigure No UserDefineConfigureInfo Custom content audit control parameter.

    3. Output Parameters

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

    4. Example

    Example1 Creating content audit template with only porn detection in video image enabled and specifying threshold scores and frame capturing interval

    This example shows you how to create a custom AI-based content audit template where porn detection in video image is enabled. The threshold scores for violation and human audit are set at 80 and 30, respectively.

    Input Example

    https://mps.tencentcloudapi.com/?Action=CreateContentReviewTemplate
    &Name=Content audit template
    &Comment=Template 2
    &PornConfigure.ImgReviewInfo.Switch=ON
    &PornConfigure.ImgReviewInfo.BlockConfidence=80
    &PornConfigure.ImgReviewInfo.ReviewConfidence=30
    &<common request parameters>

    Output Example

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

    Example2 Creating content audit template with only porn detection in video image enabled

    This example shows you how to create a custom AI-based content audit template where only a porn detection in video image task is enabled. The default values are used as the threshold scores for violation and human audit, and filter tags are not specified.

    Input Example

    https://mps.tencentcloudapi.com/?Action=CreateContentReviewTemplate
    &Name=Content audit template
    &Comment=Template 1
    &PornConfigure.ImgReviewInfo.Switch=ON
    &<common request parameters>

    Output Example

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

    Example3 Creating content audit template with multiple audit tasks enabled

    This example shows you how to create a custom AI-based content audit template where porn, terrorism, and politically sensitive information detection in video image tasks are enabled. The default values are used as the threshold scores for violation and human audit, and filter tags are not specified.

    Input Example

    https://mps.tencentcloudapi.com/?Action=CreateContentReviewTemplate
    &Name=Content audit template
    &Comment=Template 3
    &PornConfigure.ImgReviewInfo.Switch=ON
    &TerrorismConfigure.ImgReviewInfo.Switch=ON
    &PoliticalConfigure.ImgReviewInfo.Switch=ON
    &<common request parameters>

    Output Example

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

    Example4 Creating content audit template with porn detection in video image enabled and specifying filter tags

    This example shows you how to create a custom AI-based content audit template where porn detection in video image is enabled. The filter tags are specified as porn and sexy, and the default values are used as the threshold scores for violation and human audit.

    Input Example

    https://mps.tencentcloudapi.com/?Action=CreateContentReviewTemplate
    &Name=Content audit template
    &Comment=Template 1
    &PornConfigure.ImgReviewInfo.Switch=ON
    &PornConfigure.ImgReviewInfo.LabelSet.0=porn
    &PornConfigure.ImgReviewInfo.LabelSet.1=sexy
    &<common request parameters>

    Output Example

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

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    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.InvalidMpsUser Operation failed: unauthorized MPS user.
    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 Parameter error: template description.
    InvalidParameterValue.LabelSet Incorrect parameter value: invalid LabelSet value.
    InvalidParameterValue.Name Incorrect parameter value: Name exceeds the length limit.
    InvalidParameterValue.ReviewConfidence Incorrect parameter value: The value of the ReviewConfidence parameter is invalid.
    InvalidParameterValue.Switch Incorrect parameter value: invalid Switch value.
    LimitExceeded.TooMuchTemplate Limit reached: the number of templates exceeds the limit.

    Was this page helpful?

    Was this page helpful?

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