Document Moderation 2.0 API

Usage notes

• Business operation: FileModeration. Only asynchronous moderation is supported.

• Supported regions and access addresses:

  Region	Public network access address	Internal network access address	Supported services
  Singapore	green-cip.ap-southeast-1.aliyuncs.com	green-cip-vpc.ap-southeast-1.aliyuncs.com	document_detection_global

• Billing: This operation is chargeable and billed by the number of pages processed in the document.

• Moderation object: Common documents are supported.

• Result delivery: Moderation results are not returned in real time. Retrieve them by polling or by enabling callback notification. Results are retained for up to 24 hours.

  • Callback notification: Specify a callback URL in the callback parameter when submitting the moderation task.

  • Polling: Leave the callback parameter blank and call the result query operation after submission.

• Document requirements:

  • Supported protocols: HTTP and HTTPS.

  • Supported formats: DOC, DOCX, PPT, PPTX, PPS, PPSX, PDF, XLS, XLSX, XLTX, XLTM, HTML, and TXT (UTF-8 encoding).

  • Size limit: 200 MB per document. Compress or split documents that exceed this limit.

  • Moderation time depends on document download time. Use a stable and reliable storage service such as Alibaba Cloud OSS.

• Rule configuration: Configure Document Moderation rules in the Content Moderation console before making your first call. Without this configuration, Document Moderation 2.0 defaults to standard settings.

QPS limit

You can call this operation up to 100 times per second per account. The system supports a maximum of 20 concurrent moderation tasks. Requests that exceed this limit are dropped, which may interrupt your service. Note this limit when calling this operation.

Debugging

Use Alibaba Cloud OpenAPIDocument Moderation enhanced edition to debug the operation online, view sample code and SDK dependencies, and explore operation parameters.

Request parameters

Table 1. ServiceParameters

*The url, ossBucketName/ossObjectName/ossRegionId (OSS authorization), and local document upload (via SDK) are three mutually exclusive input methods. Choose one. For local document upload code examples, see Document Moderation 2.0 SDK and access guide.

Response parameters

Examples

Sample requests

{
  "Service": "document_detection_global",
  "ServiceParameters":
  {
    "url": "http://www.aliyundoc.com/a.pdf",
    "dataId": "fileId-2024-0307-0728***"
  }
}

Sample success responses

{
    "Msg": "OK",
    "Code": 200,
    "Data":
    {
        "TaskId": "AAAAA-BBBBB-CCCCCCCC"
    },
    "RequestId": "ABCD1234-1234-1234-1234-123****"
}

Usage notes

• Business operation: DescribeFileModerationResult. Retrieves Document Moderation task results.

• Billing: This operation is free of charge.

• Query timing: Query moderation results at least 30 seconds after submitting an asynchronous moderation request. Results are retained for up to 24 hours and are automatically deleted after 4 hours.

QPS limit

You can call this operation up to 100 times per second per account. Exceeding this limit triggers throttling, which may affect your service. Note this limit when calling this operation.

Debugging

Use Alibaba Cloud OpenAPI to debug the operation online, view sample code and SDK dependencies, and explore operation parameters.

Request parameters

Table 1. ServiceParameters

Response parameters

Table 2. Data

Table 3. PageSummary

Table 4. ImageSummary

Table 5. ImageLabels

Table 6. TextSummary

Table 7. TextLabels

Table 8. PageResult

Table 9. ImageResult

Table 10. LabelResult

Table 11. TextResult

Examples

Sample requests

{
    "service": "document_detection_global",
    "serviceParameters": {
        "taskId": "abcd****"
    }
}

Sample success responses

{
    "Code": 200,
    "Data": {
        "DataId": "fileId-2024-0307-0728***",
        "PageResult": [
            {
                "ImageResult": [
                    {
                        "Description": "Moderation of the image content of the document page",
                        "LabelResult": [
                            {
                                "label": "nonLabel"
                            }
                        ],
                        "Service": "baselineCheck_global"
                    }
                ],
                "ImageUrl": "http://oss.aliyundoc.com/a.png",
                "PageNum": 1,
                "TextResult": [
                    {
                        "Description": "Moderation of the text content of the document page",
                        "Labels": "",
                        "RiskTips": "",
                        "RiskWords": "",
                        "Service": "comment_multilingual_global",
                        "Text": "Content Moderation product test case a"
                    }
                ]
            },
            ...
            {
                "ImageResult": [
                    {
                        "Description": "Moderation of the image content of the document page",
                        "LabelResult": [
                            {
                                "Confidence": 89.01,
                                "Label": "pornographic_adultContent_tii"
                            }
                        ],
                        "Service": "baselineCheck_global"
                    }
                ],
                "ImageUrl": "http://oss.aliyundoc.com/b.png",
                "PageNum": 10,
                "TextResult": [
                    {
                        "Description": "Moderation of the text content of the document page",
                        "Labels": "contraband,sexual_content",
                        "RiskTips": "Prohibited_Prohibited goods, Pornographic_Film resources, Pornographic_Vulgar",
                        "RiskWords": "Risk word A, Risk word B",
                        "Service": "comment_multilingual_global",
                        "Text": "Content Moderation product test case b"
                    }
                ]
            }
        ],
        "Url": "http://www.aliyundoc.com/a.docx"
    },
    "Message": "SUCCESS",
    "RequestId": "1D0854A7-AAAAA-BBBBBBB-CC8292AE5"
}