tencent cloud

1. API Description

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

This API is used to submit an image for smart moderation. Before using it, you need to log in to the console with the Tencent Cloud root account to activate IMS and adjust the business configuration.

API use instructions

• Go to the "CMS console - IMS" to activate IMS.
• This API is a paid API.

API feature description

• It can detect images or links and recognize content that may be offensive, unsafe, or inappropriate based on the deep learning technology;
• It can capture frames from or split GIF/long images for detection;
• It can recognize various non-compliant scenarios, including vulgarity, law or regulation violations, pornography, and advertising;
• It can detect multiple types of objects (such as object, advertising logo, and QR code) and recognize text in images based on OCR;
• It allows you to customize moderation policies based on different business scenarios;
• You can select image risk libraries to filter non-compliant images of custom types (currently, only blocklist configuration is supported);
• You can associate account or device information when moderating an image to recognize the account or device involved.

API call description

• Supported image file size: < 5 MB
• Supported image file resolution: a resolution of 256x256 or higher is recommended; otherwise, the recognition effect may be affected.
• Supported image file formats: PNG, JPG, JPEG, BMP, GIF, and WEBP.
• Supported image URL transfer protocols: HTTP and HTTPS.
• If you pass in the access URL of an image, you need to limit the image download time to 3 seconds. To ensure the stability and reliability of the image to be detected, we recommend you use Tencent Cloud COS for storage or CDN for caching.
• Default API request rate limit: 100 requests/sec. If this limit is exceeded, an error will be reported.

A maximum of 100 requests can be initiated per second for this API.

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.

3. Output Parameters

4. Example

Example1 Moderating image

This example shows you how to moderate an image.

Input Example

POST / HTTP/1.1
Host: ims.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ImageModeration
<common request parameters>

{
    "BizType": "test_1001",
    "DataId": "1213",
    "FileUrl": "https://xxx.jpg"
}

Output Example

{
    "Response": {
        "RequestId": "a61237dd-c2a0-43e7-a3da-d27022d39ba7",
        "DataId": "a61237dd-c2a0-43e7-a3da-d27022d39ba7",
        "BizType": "test_1001",
        "Suggestion": "Block",
        "FileMD5": "",
        "Label": "Porn",
        "SubLabel": "SexBehavior",
        "Score": 90,
        "LabelResults": [
            {
                "Scene": "Porn",
                "Suggestion": "Block",
                "Label": "Porn",
                "SubLabel": "SexBehavior",
                "Score": 90,
                "Details": []
            }
        ],
        "ObjectResults": [
            {
                "Scene": "QrCode",
                "Suggestion": "Block",
                "Label": "Ad",
                "SubLabel": "",
                "Score": 100,
                "Names": [
                    "QRCODE"
                ],
                "Details": [
                    {
                        "Id": 0,
                        "Name": "QRCODE",
                        "Score": 100,
                        "Location": {
                            "X": 155.01746,
                            "Y": 396.01746,
                            "Width": 769.9824,
                            "Height": 769.98254,
                            "Rotate": 0
                        }
                    }
                ]
            }
        ],
        "OcrResults": [],
        "LibResults": [],
        "RecognitionResults": [
            {
                "Label": "Scene",
                "Tags": [
                    {
                        "Name": "MedicalImage",
                        "Score": 30,
                        "Location": {
                            "X": 0,
                            "Y": 0,
                            "Width": 0,
                            "Height": 0,
                            "Rotate": 0
                        }
                    }
                ]
            }
        ],
        "Extra": ""
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for NodeJS
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.