tencent cloud

Feedback

ReviewImage

Last updated: 2022-05-19 19:00:48

1. API Description

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

This API is used to initiate an image recognition task to identify pornographic, terroristic, and politically sensitive content in images saved in VOD.

  • File size: < 5 MB
  • Resolution: Preferably higher than 256 x 256. Resolution lower than this may compromise the recognition performance.
  • Supported image formats: PNG, JPG, JPEG, BMP, GIF, WEBP
  • A maximum of 20 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: ReviewImage.
    Version Yes String Common Params. The value used for this API: 2018-07-17.
    Region No String Common Params. This parameter is not required for this API.
    FileId Yes String The unique ID of the media file. For this API to work, the file must be an image.
    Definition Yes Integer The ID of the image recognition template. Currently, this can only be 10.
    SubAppId No Integer The VOD subapplication ID. If you need to access a resource in a subapplication, set this parameter to the subapplication ID; otherwise, leave it empty.

    3. Output Parameters

    Parameter Name Type Description
    ReviewResultSet Array of ContentReviewResult The image recognition result.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Initiating an image recognition task

    Input Example

    https://vod.tencentcloudapi.com/?Action=ReviewImage
    &FileId=5285485487985271487
    &Definition=10
    &<Common request parameters>
    

    Output Example

    {
      "Response": {
        "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
        "ReviewResultSet": [
          {
            "Type": "Porn.Image",
            "PornImageResult": {
              "Confidence": 99,
              "Suggestion": "block",
              "Label": "sexy"
            },
            "TerrorismImageResult": null,
            "PoliticalImageResult": null,
            "PornOcrResult": null,
            "TerrorismOcrResult": null,
            "PoliticalOcrResult": null
          }
        ]
      }
    }
    

    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.
    FailedOperation.MediaType Operation failed: unsupported media type.
    InternalError Internal error.
    InvalidParameterValue Incorrect parameter value.
    LimitExceeded Quota limit is exceeded.
    ResourceNotFound The resource does not exist.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support