内容安全は、非同期通知を送信して、機械によるモデレーション結果とレビュー結果を通知できます。ビジネス目的で結果を使用または統合する場合、コールバック通知を有効にできます。このトピックでは、内容安全 API のコールバック通知を有効にする方法について説明します。
背景情報
内容安全 API は、機械によるモデレーション結果と人間のレビュー結果のコールバック通知をサポートしています。
機械によるモデレーション結果のコールバック通知: モデレーションリクエストが処理されると、内容安全は HTTP POST リクエストを送信することにより、機械によるモデレーション結果を指定された HTTP コールバック URL に送信します。
人間のレビュー結果のコールバック通知: データをレビューするか、フィードバック操作を呼び出して機械によるモデレーション結果を修正すると、内容安全は HTTP POST リクエストを送信することにより、人間のレビュー結果を指定された HTTP コールバック URL に送信します。詳細については、機械によるモデレーション結果を確認するをご参照ください。
用語
次の表に、コールバック通知に関連する概念を示します。
用語 | 説明 |
コールバック URL | Alibaba Cloud 内容安全コンソールで指定するサーバーのパブリックエンドポイント。コールバック URL は、次の要件を満たしている必要があります。
|
シード | POST リクエストが内容安全から指定された HTTP コールバック URL に送信されたかどうかを確認するために使用される文字列。 |
コールバック回数 | 内容安全がサーバーにコールバック通知をプッシュする回数。サーバーがコールバック通知を受信すると、HTTP ステータスコード 200 を内容安全に送信します。サーバーがコールバック通知の受信に失敗した場合、他の HTTP ステータスコードを内容安全に送信します。内容安全は、200 以外の HTTP ステータスコードを受信すると、サーバーが受信するまでコールバック通知のプッシュを続けます。内容安全は、コールバック通知を最大 3 回まで繰り返しプッシュできます。 |
コールバックデータ | 内容安全が指定されたコールバック URL に送信するコールバック通知の内容。コールバックデータのパラメーターの詳細については、コールバックデータのパラメーターをご参照ください。 |
表 1. コールバックデータのパラメーター
名前 | タイプ | 説明 |
checksum | 文字列 | セキュアハッシュアルゴリズム 256(SHA-256)アルゴリズムを使用して生成される 説明 データの改ざんを防ぐために、サーバーがコールバック通知を受信したときに SHA-256 アルゴリズムを使用して文字列を生成し、受信した checksum 値と照合して検証できます。 |
content | 文字列 | JSON 形式の文字列を JSON 形式のコールバックデータに解析します。 content パラメーターから解析されたコールバックデータの詳細については、このトピックのcontent パラメーターの説明セクションをご参照ください。 |
機械によるモデレーション結果のコールバック通知
内容安全 API のすべての非同期モデレーション操作は、非同期画像モデレーションや非同期ビデオモデレーションなど、コールバック通知をサポートしています。詳細については、非同期画像モデレーションと非同期ビデオモデレーションをご参照ください。非同期操作を呼び出し、内容安全にモデレーション結果を返却する必要がある場合は、モデレーションリクエストで callback パラメーターと seed パラメーターを設定します。 callback パラメーターはコールバック URL を指定し、seed パラメーターはコールバック通知リクエストを検証するために使用される文字列を指定します。
非同期操作を呼び出すときに上記のパラメーターを設定しない場合、非同期モデレーション結果を定期的にポーリングすることしかできません。
手順
モデレーション結果の受信に使用する HTTP コールバック URL と seed パラメーターを準備します。
コンテンツモデレーションの非同期操作を呼び出すときは、モデレーションリクエストで callback パラメーターと seed パラメーターを設定します。詳細については、関連する API 操作のパラメーターの説明をご参照ください。
人間のレビュー結果のコールバック通知
人間のレビューリクエストを送信した場合、レビュー結果はリアルタイムで返されません。人間のレビュー結果を受信するには、コールバック通知を設定する必要があります。
機械によるモデレーションと人間のレビューサービスの両方を使用する
機械によるモデレーションと人間のレビューサービスの両方を使用する場合は、内容安全コンソールで人間のレビュー結果のコールバック通知を設定する必要があります。コンソールでコールバック通知を設定するには、次の手順を実行します。
内容安全コンソールにログオンします。
左側のナビゲーションペインで、
を選択します。[機械審査] ページで、[通知] タブをクリックします。次に、このタブの [新しい通知を作成] をクリックします。
[新しい通知を作成] ダイアログボックスで、[タイトル]、[コールバック URL]、[暗号化アルゴリズム]、[通知タイプ]、[審査結果] パラメーターを設定します。次に、[OK] をクリックします。
コールバック通知を設定すると、システムは seed パラメーターの値を自動的に生成します。 seed パラメーターの値を使用して、コールバック通知リクエストが Alibaba Cloud から送信されたかどうかを確認できます。生成された seed パラメーターの値を保存します。
重要機械によるモデレーション結果のコールバック通知を設定している場合は、コールバック通知の設定を再利用するか、ビジネス要件に基づいて別のコールバック通知を設定できます。
ビジネスシナリオに基づいて、すべてのモデレーション結果を受信するためのコールバック通知を設定するか、指定されたモデレーション結果のみを受信するためのコールバック通知を設定できます。
通知タイプパラメーターには [alibabacloud による手動レビュー結果] を選択します。
暗号化アルゴリズムパラメーターの有効な値:
[SHA256]: HMAC-SHA256 暗号化アルゴリズムが使用されます。
[SM3]: HMAC-SM3 暗号化アルゴリズムが使用され、16 進数文字列が返されます。文字列は小文字と数字で構成されます。
たとえば、[66c7f0f462eeedd9d1f2d46bdc10e4e24167c4875cf2f7a2297da02b8f4ba8e0] は、HMAC-SM3 暗号化アルゴリズムを使用して [abc] を暗号化した後に返されます。
[biztype 管理] タブで、管理するビジネスシナリオを見つけ、[アクション] 列の [通知プランを選択] をクリックし、ビジネスシナリオの [コールバック通知スキーム] ドロップダウンリストからコールバック通知スキームを選択します。
content パラメーターの説明
コールバック通知を有効にすると、内容安全は内容安全 API によって生成されたモデレーション結果をコールバック通知で指定されたコールバック URL に送信します。コールバック通知には content パラメーターが含まれています。次の表に、content パラメーターの構造を示します。
表 2. content パラメーターの構造
要素 | タイプ | 必須 | 説明 |
scanResult | JSONObject | いいえ | 機械によるモデレーション結果。このパラメーターの構造は、画像やビデオなど、モデレートされたオブジェクトによって異なります。
|
auditResult | JSONObject | いいえ | 人が生成したレビュー結果。このパラメーターは、人間のレビューが実行された場合にのみ返されます。詳細については、auditResult をご参照ください。 説明 内容安全が機械によるモデレーション結果のみを送信する場合、このパラメーターは返されません。 |
humanAuditResult | JSONObject | いいえ | Alibaba Cloud の人間のレビューサービスによって生成された人間のレビュー結果。このパラメーターは、Alibaba Cloud の人間のレビューサービスを購入した場合にのみ返されます。詳細については、humanAuditResult をご参照ください。 |
表 3. auditResult
要素 | タイプ | 必須 | 説明 |
suggestion | 文字列 | はい | 人間のレビュー中に提供した提案。有効な値:
|
labels | JSONArray | いいえ | 人間のレビュー中に設定したタグ。戻り値は 1 つ以上のタグです。有効な値:
|
表 4. humanAuditResult
要素 | タイプ | 必須 | 説明 |
suggestion | 文字列 | はい | Alibaba Cloud の人間のレビューサービスによって提供される提案。有効な値:
|
taskId | 文字列 | はい | モデレーションタスクの ID。タスク ID に基づいて、コンテンツの人間のレビュー結果を対応する機械によるモデレーション結果に関連付けることができます。 |
dataId | 文字列 | はい | モデレートされたコンテンツの ID。 |
labels | JSONArray | いいえ | 人間のレビューサービスが設定するタグ。戻り値には複数のタグを含めることができます。 説明 デフォルトでは、このパラメーターは返されません。このパラメーターを返す場合は、Alibaba Cloud テクニカルサポートに連絡して料金を支払ってください。 |
content パラメーターの例
{
"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"
}
}