Content Moderation:Enable callback notifications

Terms

The following table introduces the concepts related to callback notifications.

Callback notification for machine-assisted moderation results

All asynchronous moderation operations of the Content Moderation API support callback notifications, including asynchronous image moderation and asynchronous video moderation. For more information, see asynchronous image moderation and asynchronous video moderation. If you call an asynchronous operation and need Content Moderation to return the moderation results, set the callback and seed parameters in your moderation request. The callback parameter specifies the callback URL and the seed parameter specifies a string that is used to verify the callback notification request.

Procedure

1. Prepare the HTTP callback URL and seed parameters that are used to receive moderation results.

2. When you call an asynchronous operation for content moderation, set the callback and seed parameters in your moderation request. For more information, see the parameter description of the relevant API operation.

Callback notification for human review results

If you send human review requests, the review results are not returned in real time. You must configure callback notifications to receive human review results.

• Use both the machine-assisted moderation and human review services

  If you use both the machine-assisted moderation and human review services, you must configure a callback notification for human review results in the Content Moderation console. To configure a callback notification in the console, perform the following steps:

  1. Log on to the Content Moderation console.

  2. In the left-side navigation pane, choose Machine audit V1.0 > Settings.

  3. On the Machine audit page, click the Notification tab. Then click Create New Notification on this tab.

  4. In the Create New Notification dialog box, set the Title, Callback URL, Encryption algorithm, Notification type, and Audit Result parameters. Then, click OK.

     After you configure the callback notification, the system automatically generates a value for the seed parameter. You can use the value of the seed parameter to verify whether a callback notification request is sent from Alibaba Cloud. Save the generated value of the seed parameter.

     Important

     • If you have configured a callback notification for machine-assisted moderation results, you can reuse the configurations of the callback notification or configure another callback notification based on your business requirements.

     • You can configure a callback notification for receiving all moderation results or only specified moderation results based on your business scenario.

     • Select Manual Review Results by AlibabaCloud for the Notification type parameter.

     • Valid values of the Encryption algorithm parameter:

       • SHA256: The HMAC-SHA256 encryption algorithm is used.

       • SM3: The HMAC-SM3 encryption algorithm is used and a hexadecimal string is returned. The string consists of lowercase letters and digits.

         For example, 66c7f0f462eeedd9d1f2d46bdc10e4e24167c4875cf2f7a2297da02b8f4ba8e0 is returned after you encrypt abc by using the HMAC-SM3 encryption algorithm.

  5. On the BizType Manage tab, find the business scenario that you want to manage, click Choose Notification Plan in the Actions column, and then select a callback notification scheme from the Callback notification scheme drop-down list for the business scenario.

Content parameter description

After you enable callback notifications, Content Moderation sends the moderation results that are generated by the Content Moderation API in a callback notification to the specified callback URL. The callback notification contains the content parameter. The following tables describe the structure of the content parameter.

{
    "scanResult": {
        "code": 200,
        "msg": "OK",
        "taskId": "fdd25f95-4892-4d6b-aca9-7939bc6e9baa-1486198766695",
        "url": "http://1.jpg",
        "results": [
            {
                "rate": 100,
                "scene": "porn",
                "suggestion": "block",
                "label": "porn"
            }
        ]
    },
    "auditResult": {
        "suggestion": "block",
        "labels": [
            "porn",
            "ad",
            "terrorism"
        ]
    },
    "humanAuditResult": {
        "suggestion": "pass",
          "dataId": "yyyy",
          "labels": [
              "porn",
              "vulgar"
        ],
        "taskId": "xxxxxx"
    }
}