DescribeContentReviewTemplates

Last updated: 2021-06-16 10:35:33

    1. API Description

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

    This API is used to get the list of intelligent video content recognition template details according to unique template IDs. The return result includes all eligible custom and preset intelligent video content recognition templates.

    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: DescribeContentReviewTemplates.
    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.
    Definitions.N No Array of Integer Unique IDs for filters of an intelligent content recognition template. Array length limit: 100.
    Offset No Integer Pagination offset. Default value: 0.
    Limit No Integer Number of returned entries. Default value: 10. Maximum value: 100.
    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
    TotalCount Integer Number of eligible entries.
    ContentReviewTemplateSet Array of ContentReviewTemplateItem List of intelligent content recognition template details.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Getting the intelligent content recognition template whose ID is 30

    This example shows you how to get 10 intelligent content recognition templates with the serial number starting from 0, including the system default one.

    Input Example

    https://vod.tencentcloudapi.com/?Action=DescribeContentReviewTemplates
    &Definitions.0=30
    &<Common request parameters>
    

    Output Example

    {
    "Response": {
      "TotalCount": 1,
      "ContentReviewTemplateSet": [
        {
          "Definition": 30,
          "Name": "Template 1",
          "Comment": "Intelligent content recognition template",
          "ReviewWallSwitch": "ON",
          "PornConfigure": {
            "ImgReviewInfo": {
              "Switch": "ON",
              "LabelSet": [
                "porn"
              ],
              "BlockConfidence": 80,
              "ReviewConfidence": 30
            },
            "AsrReviewInfo": {
              "Switch": "ON",
              "BlockConfidence": 100,
              "ReviewConfidence": 75
            },
            "OcrReviewInfo": {
              "Switch": "ON",
              "BlockConfidence": 100,
              "ReviewConfidence": 75
            }
          },
          "TerrorismConfigure": {
            "ImgReviewInfo": {
              "Switch": "ON",
              "LabelSet": [
                "bloody"
              ],
              "BlockConfidence": 80,
              "ReviewConfidence": 30
            },
            "OcrReviewInfo": {
              "Switch": "OFF",
              "BlockConfidence": 0,
              "ReviewConfidence": 0
            }
          },
          "PoliticalConfigure": {
            "ImgReviewInfo": {
              "Switch": "ON",
              "LabelSet": [
                "politician"
              ],
              "BlockConfidence": 80,
              "ReviewConfidence": 30
            },
            "AsrReviewInfo": {
              "Switch": "ON",
              "BlockConfidence": 100,
              "ReviewConfidence": 75
            },
            "OcrReviewInfo": {
              "Switch": "ON",
              "BlockConfidence": 100,
              "ReviewConfidence": 75
            }
          },
          "ProhibitedConfigure": null,
          "UserDefineConfigure": {
            "AsrReviewInfo": {
              "Switch": "ON",
              "LabelSet": [],
              "BlockConfidence": 100,
              "ReviewConfidence": 75
            },
            "OcrReviewInfo": {
              "Switch": "ON",
              "LabelSet": [],
              "BlockConfidence": 100,
              "ReviewConfidence": 75
            }
          },
          "ScreenshotInterval": 1,
          "CreateTime": "2019-01-01T12:00:00Z",
          "UpdateTime": "2019-01-01T16:00:00Z"
        }
      ],
      "RequestId": "19ae8d8e-dce3-4151-9d4b-5594384987a9"
    }
    }
    

    Example2 Getting a specified number of intelligent content recognition templates

    This example shows you how to get 10 intelligent content recognition templates with the serial number starting from 0, including the system default one.

    Input Example

    https://vod.tencentcloudapi.com/?Action=DescribeContentReviewTemplates
    &Offset=0
    &Limit=10
    &<Common request parameters>
    

    Output Example

    {
    "Response": {
      "TotalCount": 2,
      "ContentReviewTemplateSet": [
        {
          "Definition": 30,
          "Name": "Template 1",
          "Comment": "Intelligent content recognition template",
          "ReviewWallSwitch": "ON",
          "PornConfigure": {
            "ImgReviewInfo": {
              "Switch": "ON",
              "LabelSet": [
                "porn"
              ],
              "BlockConfidence": 80,
              "ReviewConfidence": 30
            },
            "AsrReviewInfo": {
              "Switch": "ON",
              "BlockConfidence": 100,
              "ReviewConfidence": 75
            },
            "OcrReviewInfo": {
              "Switch": "ON",
              "BlockConfidence": 100,
              "ReviewConfidence": 75
            }
          },
          "TerrorismConfigure": {
            "ImgReviewInfo": {
              "Switch": "ON",
              "LabelSet": [
                "bloody"
              ],
              "BlockConfidence": 80,
              "ReviewConfidence": 30
            },
            "OcrReviewInfo": {
              "Switch": "OFF",
              "BlockConfidence": 0,
              "ReviewConfidence": 0
            }
          },
          "PoliticalConfigure": {
            "ImgReviewInfo": {
              "Switch": "ON",
              "LabelSet": [
                "politician"
              ],
              "BlockConfidence": 80,
              "ReviewConfidence": 30
            },
            "AsrReviewInfo": {
              "Switch": "ON",
              "BlockConfidence": 100,
              "ReviewConfidence": 75
            },
            "OcrReviewInfo": {
              "Switch": "ON",
              "BlockConfidence": 100,
              "ReviewConfidence": 75
            }
          },
          "ProhibitedConfigure": null,
          "UserDefineConfigure": {
            "AsrReviewInfo": {
              "Switch": "ON",
              "LabelSet": [],
              "BlockConfidence": 100,
              "ReviewConfidence": 75
            },
            "OcrReviewInfo": {
              "Switch": "ON",
              "LabelSet": [],
              "BlockConfidence": 100,
              "ReviewConfidence": 75
            }
          },
          "ScreenshotInterval": 1,
          "CreateTime": "2019-01-01T12:00:00Z",
          "UpdateTime": "2019-01-01T16:00:00Z"
        },
        {
          "Definition": 31,
          "Name": "Template 2",
          "Comment": "Inappropriate information recognition template",
          "ReviewWallSwitch": "ON",
          "PornConfigure": {
            "ImgReviewInfo": {
              "Switch": "OFF"
            },
            "AsrReviewInfo": {
              "Switch": "OFF"
            },
            "OcrReviewInfo": {
              "Switch": "ON",
              "BlockConfidence": 100,
              "ReviewConfidence": 75
            }
          },
          "TerrorismConfigure": {
            "ImgReviewInfo": {
              "Switch": "ON",
              "LabelSet": [],
              "BlockConfidence": 80,
              "ReviewConfidence": 30
            },
            "OcrReviewInfo": {
              "Switch": "OFF",
              "BlockConfidence": 0,
              "ReviewConfidence": 0
            }
          },
          "PoliticalConfigure": {
            "ImgReviewInfo": {
              "Switch": "ON",
              "LabelSet": [
                "politician"
              ],
              "BlockConfidence": 80,
              "ReviewConfidence": 30
            },
            "AsrReviewInfo": {
              "Switch": "ON",
              "BlockConfidence": 100,
              "ReviewConfidence": 75
            },
            "OcrReviewInfo": {
              "Switch": "ON",
              "BlockConfidence": 100,
              "ReviewConfidence": 75
            }
          },
          "ProhibitedConfigure": null,
          "UserDefineConfigure": {
            "AsrReviewInfo": {
              "Switch": "ON",
              "LabelSet": [],
              "BlockConfidence": 100,
              "ReviewConfidence": 75
            },
            "OcrReviewInfo": {
              "Switch": "ON",
              "LabelSet": [],
              "BlockConfidence": 100,
              "ReviewConfidence": 75
            }
          },
          "ScreenshotInterval": 1,
          "CreateTime": "2019-01-01T12:00:00Z",
          "UpdateTime": "2019-01-01T16:00:00Z"
        }
      ],
      "RequestId": "19ae8d8e-dce3-4151-9d4b-5594384987a9"
    }
    }
    

    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 Operation failed.
    FailedOperation.InvalidVodUser The VOD service is not activated.
    InternalError Internal error.
    InvalidParameter Invalid parameter.
    InvalidParameterValue.Definitions Invalid parameter: Definitions.
    InvalidParameterValue.Limit Invalid parameter: Limit.
    ResourceNotFound.TemplateNotExist The resource does not exist: the template does not exist.
    UnauthorizedOperation Unauthorized operation.