AI Guardrails:Asynchronous scan

Usage notes (submit a moderation task)

API operation: /green/image/asyncscan, which submits an asynchronous image moderation task.

Call this operation to create an asynchronous image moderation task. Submitting the task is the first of two steps: this operation returns a taskId, and you then retrieve the moderation results either through a callback or by querying the result operation.For information about how to construct an HTTP request, see Request structure. You can also use a pre-constructed HTTP request. For more information, see SDK overview.

• Billing information:

  This is a paid API operation. For more information about billing, see Content Moderation Pricing.

  - Moderation timeout:

  The maximum detection time for a synchronous detection request is 6 seconds. If the detection is not completed within this time limit, a timeout error is returned. If you do not require real-time results, you can use asynchronous detection. Otherwise, use synchronous detection because its API call is simpler. For these calls, set the timeout period to 6 seconds.

  - Retrieving moderation results:

  Asynchronous detection tasks do not return results in real time. You must use a callback or polling to retrieve the results, which are stored for up to one hour.

  - Callback: When you submit an asynchronous moderation task, specify the callback parameter in the request. Content Moderation then delivers the moderation results to the callback URL automatically. For more information, see Request parameters (submit a moderation task).- Polling: When you submit an asynchronous moderation task, do not specify the callback parameter. After you submit the task, call the result query operation to obtain the moderation results. Observe the query interval and the validity period of the taskId. For more information, see Usage notes (query moderation results).- Image requirements:

  • The image URL must use the HTTP or HTTPS protocol.

  • Supported image formats: PNG, JPG, JPEG, BMP, GIF, and WEBP.

  • The image size cannot exceed 20 MB for both synchronous and asynchronous calls.

  • The image must be downloaded within 3 seconds. If the download time exceeds 3 seconds, a download timeout error is returned.

  • For optimal performance, we recommend that the image resolution be at least 256x256 pixels. A lower resolution may affect the detection accuracy.

  • The response time of the image detection API depends on the image download time. Ensure that the storage service where the image is stored is stable and reliable. For best performance, use Alibaba Cloud Object Storage Service (OSS) or a Content Delivery Network (CDN).

  The following table describes the moderation scenarios that asynchronous image moderation supports.

Request parameters (submit a moderation task)

The following table describes the request parameters of /green/image/asyncscan.

| callback | String | No | http://www.aliyundoc.com |

A random string used for the signature in the callback notification request.

The string can contain letters, digits, and underscores (_), and must be 64 characters or less. Customize this string to verify the origin of callback requests.

Response parameters (submit a moderation task)

The response body of /green/image/asyncscan contains the top-level fields code, msg, requestId, and data. The data array contains one element for each moderation task in the request. The following table describes the fields of each element.

Examples (submit a moderation task)

The following code shows a sample request:

http(s)://[Endpoint]/green/image/asyncscan
&<common request parameters>
{
    "scenes": [
        "porn"
    ],
    "tasks": [
        {
            "dataId": "test4lNSMdggA0c56MMvfYoh4e-1mwxpx",
            "url": "https://www.aliyundoc.com/tfs/TB1urBOQFXXXXbMXFXXXXXXXXXX-1442-257.png"
        }
    ]
}

The following code shows a sample success response:

{
    "code": 200,
    "msg": "OK",
    "requestId": "95AD868A-F5D2-4AEA-96D4-E0273B8E074C",
    "data": [
        {
            "code": 200,
            "msg": "OK",
            "dataId": "test4lNSMdggA0c56MMvfYoh4e-1mwxpx",
            "taskId": "fdd25f95-4892-4d6b-aca9-7939bc6e9baa-1486198766695",
            "url": "https://www.aliyundoc.com/tfs/TB1urBOQFXXXXbMXFXXXXXXXXXX-1442-257.png"
        }
    ]
}

Usage notes (query moderation results)

API operation: /green/image/results, which queries the results of asynchronous image moderation.

Call this operation to query the results of an asynchronous image moderation task that you submitted through /green/image/asyncscan. Use this operation when you retrieve results by polling instead of through a callback.For information about how to construct an HTTP request, see Request structure. You can also use a pre-constructed HTTP request. For more information, see SDK overview.

• Billing information:

  This API operation is free of charge.

  - Query timing and result validity: Set the query interval to 30 seconds. That is, query the results 30 seconds after you submit the asynchronous moderation task and obtain the taskId.> Note: If the offline parameter is set to true, the taskId remains valid for 24 hours. If the offline parameter is set to false, the taskId remains valid for 1 hour. Default value: false.

Request parameters (query moderation results)

The following table describes the request parameters of /green/image/results.

Response parameters (query moderation results)

The response body of /green/image/results contains the top-level fields code, msg, requestId, and data. The data array contains one element for each taskId in the request. The following table describes the fields of each element.

Examples (query moderation results)

The following code shows a sample request:

http(s)://[Endpoint]/green/image/results
&<common request parameters>
[
    "fdd25f95-4892-4d6b-aca9-7939bc6e9baa-1486198766695"
]

The following code shows a sample success response:

{
    "msg": "OK",
    "code": 200,
    "data": [
        {
            "msg": "OK",
            "code": 200,
            "dataId": "test4lNSMdggA0c56MMvfYoh4e-1mwxpx",
            "extras": {

            },
            "results": [
                {
                    "rate": 99.63,
                    "suggestion": "block",
                    "label": "sexy",
                    "scene": "porn"
                },
                {
                    "label": "politics",
                    "rate": 91.54,
                    "scene": "terrorism",
                    "sfaceData": [
                        {
                            "faces": [
                                {
                                    "id": "AliFace_0001234",
                                    "name": "hit name",
                                    "rate": 91.54
                                }
                            ],
                            "h": 131,
                            "w": 97,
                            "x": 49,
                            "y": 39
                        }
                    ],
                    "suggestion": "block"
                },
                {
                    "extras": {
                        "qrcodes": "http://www.aliyundoc.com/0.ZZOliO",
                        "npx": "72.01",
                        "hitCustomLibCode": "8012345000",
                        "hitCustomLibName": "Custom image library name",
                        "hitLibInfo": [
                            {
                                "context": "hit text",
                                "libCode": "123456",
                                "libName": "Text library name"
                            }
                        ]
                    },
                    "programCodeData": [
                        {
                            "w": 402.0,
                            "h": 413.0,
                            "x": 11.0,
                            "y": 0.0
                        }
                    ],
                    "frames": [
                        {
                            "rate": 89.85,
                            "url": "http://www.aliyundoc.com/xxx-0.jpg"
                        },
                        {
                            "rate": 68.06,
                            "url": "http://www.aliyundoc.com/xxx-1.jpg"
                        }
                    ],
                    "rate": 99.91,
                    "suggestion": "block",
                    "label": "ad",
                    "scene": "ad"
                },
                {
                    "rate": 99.91,
                    "suggestion": "block",
                    "label": "drug",
                    "scene": "live"
                },
                {
                    "qrcodeData": [
                        "http://www.aliyundoc.com/01ZZOliO"
                    ],
                    "rate": 99.91,
                    "suggestion": "review",
                    "label": "qrcode",
                    "scene": "qrcode"
                },
                {
                    "logoData": [
                        {
                            "name": "xxx TV",
                            "type": "TV",
                            "x": 140,
                            "y": 68,
                            "w": 106,
                            "h": 106
                        }
                    ],
                    "rate": 99.9,
                    "suggestion": "block",
                    "label": "TV",
                    "scene": "logo"
                }
            ],
            "taskId": "fdd25f95-4892-4d6b-aca9-7939bc6e9baa-1486198766695",
            "url": "https://www.aliyundoc.com/tfs/TB1urBOQFXXXXbMXFXXXXXXXXXX-1442-257.png"
        }
    ],
    "requestId": "69B41AE8-1234-1234-1234-12D395695D2D"
}