画像をモデレートし、リアルタイムでモデレーション結果を取得します。このオペレーションを呼び出して、画像に危険なコンテンツや違法なコンテンツが含まれているかどうかをモデレートできます。このオペレーションは、ポルノ検出、テロコンテンツ検出、広告違反検出、QRコード検出、好ましくないシーン検出、ロゴ検出などのシナリオに適用できます。
説明
オペレーション: /green/image/scan
このオペレーションを呼び出して、画像モデレーションタスクを送信し、リアルタイムでモデレーション結果を取得できます。 HTTPリクエストを構成する方法の詳細については、リクエスト構造をご参照ください。既存のHTTPリクエストを選択することもできます。詳細については、SDKの概要をご参照ください。
- 課金方法:
このオペレーションの呼び出しには料金が発生します。課金方法の詳細については、をご参照ください。
- レスポンスタイムアウト:
同期モデレーションリクエストで許可される最大応答時間は 6 秒です。モデレーションが 6 秒以内に完了しない場合は、タイムアウトエラーが返されます。リアルタイムでモデレーション結果が必要ない場合は、非同期モデレーションリクエストを送信できます。ほとんどの場合、同期モデレーションオペレーションの方が呼び出しやすいため、同期モデレーションリクエストを送信することをお勧めします。同期モデレーションオペレーションの呼び出しには、タイムアウト期間を 6 秒に設定することをお勧めします。
- 返される結果:
通常、同期モデレーションリクエストを送信してから 1 秒以内にモデレーション結果が返されます。システムで処理されるリクエストの数が多い場合、画像のサイズが大きい場合、または画像に含まれる単語の数が多い場合など、特別なシナリオでは時間が長くなる可能性があります。
- 画像の制限:
画像の URL は、HTTP または HTTPS URL である必要があります。
画像は、PNG、JPG、JPEG、BMP、GIF、または WEBP 形式である必要があります。
画像のサイズは最大 20 MB です。画像サイズの制限は、同期モデレーションオペレーションと非同期モデレーションオペレーションの両方に適用されます。
画像のダウンロード時間は 3 秒に制限されています。画像が 3 秒以内にダウンロードされない場合は、タイムアウトエラーが返されます。
モデレーション効果を確保するために、少なくとも 256 × 256 ピクセルの画像を送信することをお勧めします。
画像をモデレートするオペレーションの応答時間は、これらの画像のダウンロード時間によって異なります。モデレートする画像は、安定した信頼性の高いストレージサービスを使用して保存してください。オブジェクトストレージサービス（OSS）またはコンテンツデリバリーネットワーク（CDN）を使用することをお勧めします。
| シナリオ | 説明 | モデレーション結果のカテゴリ |
| ポルノ検出 | 画像内のポルノまたは性的なコンテンツを検出します。 | normal、porn、sexy |
| テロコンテンツ検出 | 画像内のテロまたは政治的コンテンツを検出します。 | normal、bloody、explosion、outfit、logo、weapon、politics、violence、crowd、parade、carcrash、flag、location |
| 広告違反検出 | 画像内の広告または違反テキストを検出します。 | normal、politics、porn、abuse、terrorism、contraband、spam、npx、qrcode、programCode、ad 説明 機械支援モデレーションのカスタムポリシーを作成し、実際の要件に基づいて検出するカテゴリを指定できます。詳細については、機械支援モデレーションのカスタムポリシーをご参照ください。 |
| QRコード検出 | 画像内の QR コードまたはミニプログラムコードを検出します。 | normal、qrcode、programCode 説明 機械支援モデレーションのカスタムポリシーを作成し、実際の要件に基づいて検出するカテゴリを指定できます。詳細については、機械支援モデレーションのカスタムポリシーをご参照ください。 |
| 好ましくないシーン検出 | 画像内の好ましくないシーン（黒い画面、黒い縁、暗い画像、ピクチャインピクチャ（PiP）、喫煙、運転中のライブストリーミングなど）を検出します。 | normal、meaningless、PIP、smoking、drivelive |
| ロゴ検出 | 画像内のロゴ（テレビ局のロゴや商標など）を検出します。 | normal、TV、trademark |
QPS 制限
このオペレーションは、アカウントごとに 1 秒あたり最大 50 回呼び出すことができます。1 秒あたりの呼び出し数が制限を超えると、スロットリングがトリガーされます。その結果、ビジネスに影響が及ぶ可能性があります。このオペレーションを呼び出す際には、制限に注意することをお勧めします。
リクエストパラメータ
| パラメータ | タイプ | 必須 | 例 | 説明 |
| bizType | String | いいえ | default | ビジネスシナリオ。でビジネスシナリオを作成できます。 コンテンツモデレーション コンソール 。詳細については、機械支援モデレーションのカスタムポリシーをご参照ください。 |
| scenes | StringArray | はい | ["porn","terrorism","ad","live","qrcode","logo"] | モデレーションシナリオ。有効な値:
複数のシナリオを指定できます。たとえば、 scenes パラメータで porn と terrorism の両方を指定して、ポルノコンテンツとテロコンテンツを検出できます。説明 一度に複数のシナリオをモデレーションに指定した場合、すべてのシナリオの累積料金が課金されます。各シナリオの料金は、そのシナリオでモデレートされた画像の数にそのシナリオの単価を掛けたものに等しくなります。 |
| tasks | JSONArray | はい | 送信するモデレーションタスクのリスト。JSON 配列には、1 つ以上の要素を含めることができます。各要素は構造体です。JSON 配列には最大 100 個の要素を含めることができます。つまり、一度に最大 100 個のタスクを送信できます。一度に 100 個のタスクを送信するには、関連する同時実行制限を 100 より大きい数に上げる必要があります。構造体の詳細については、task をご参照ください。 |
| パラメータ | タイプ | 必須 | 例 | 説明 |
| clientInfo | JSONObject | いいえ | {"userId":"12023****","userNick":"Mike","userType":"others"} | クライアントに関する情報。詳細については、共通パラメータの「共通リクエストパラメータ」セクションをご参照ください。 サーバーは、グローバル clientInfo パラメーターを使用するか、この表で説明されている clientInfo パラメーターを使用するかを決定します。 説明 この表の clientInfo パラメーターは、グローバル clientInfo パラメーターよりも優先されます。 |
| dataId | String | いいえ | cfd33235-71a4-468b-8137-a5ffe323**** | モデレーションオブジェクトの ID です。 ID には、文字、数字、アンダースコア（_）、ハイフン（-）、およびピリオド（.）を含めることができます。最大 128 文字まで使用できます。この ID は、ビジネスデータを一意に識別します。 |
| url | String | Yes | http://www.aliyundoc.com/xxx.jpg | インターネット経由でアクセスできる HTTP または HTTPS の URL です。URL の長さは最大 2,048 文字です。 |
| 追加パラメーター | JSONObject | いいえ | {"hitLibInfo":[{"context":"Haokan","libCode":"2144002","libName":"テキストパターンライブラリ a"}]} | オペレーションの呼び出しに指定できる追加パラメーターです。このパラメーターは画像モデレーションには必要ありません。 |
| interval | Integer | No | 2 | 連続してキャプチャされる 2 つのフレームの間隔。このパラメータは、GIF または長い画像のモデレーションを実行するために使用されます。
デフォルトでは、GIF 画像または長い画像の最初のフレームのみがモデレートされます。interval パラメータを使用して、システムが連続してキャプチャする 2 つのフレームの間隔を指定できます。これは、モデレーションコストの削減に役立ちます。 説明 interval パラメータと maxFrames パラメータは一緒に使用する必要があります。たとえば、GIF 画像または長い画像をモデレートするために、interval パラメータを 2 に設定し、maxFrames パラメータを 10 に設定します。この例では、2 フレームごとに 1 フレームがモデレートされ、最大 10 フレームをモデレートできます。料金は、モデレートされたフレームの実際の数に基づいて計算されます。 |
| maxFrames | Integer | No | 10 | キャプチャするフレームの最大数。このパラメーターは、GIFまたは長い画像のモデレーション専用です。デフォルト値: 1。 interval パラメーターの値に |
レスポンスパラメーター
| パラメーター | タイプ | 例 | 説明 |
| code | Integer | 200 | 返された HTTP ステータスコード。 詳細については、「一般的なエラーコード」をご参照ください。 |
| msg | String | OK | リクエストに応じて返されるメッセージ。 |
| dataId | String | cfd33235-71a4-468b-8137-a5ffe323**** | モデレーションオブジェクトの ID。 説明 モデレーションリクエストで dataId パラメーターを設定した場合、dataId リクエストパラメーターの値がここに返されます。 |
| taskId | String | img4wlJcb7p4wH4lAP3111111-123456 | モデレーションタスクの ID。 |
| url | String | http://www.aliyundoc.com/xxx.jpg | インターネット経由でアクセスできる HTTP または HTTPS URL。 URL の長さは最大 2,048 文字です。 |
| storedUrl | String | http://www.aliyundoc.com | 画像証拠を保存するオブジェクトストレージサービス (OSS) バケットの HTTP URL。 OSS バケットに画像証拠を保存する機能を有効にすると、証拠保存ルールに一致する画像が指定された OSS バケットに保存されます。 |
| extras | JSONObject | {"hitLibInfo":[{"context":"Haokan","libCode":"2144002","libName":"Text pattern library a"}]} | 追加情報。 scenes パラメーターで ad を指定して広告違反を検出した場合、extras パラメーターは次のコンテンツを返すことができます。 hitLibInfo: モデレーション対象の画像で検出されたテキストにヒットしたカスタムテキストライブラリに関する情報。このパラメーターは配列型です。構造の詳細については、「hitLibInfo」をご参照ください。 |
| results | JSONArray | モデレーション結果。呼び出しが成功すると、HTTP ステータスコード 200 とモデレーション結果が返されます。モデレーション結果の配列には、1 つ以上の要素が含まれています。各要素は構造体です。各要素の構造の詳細については、「result」をご参照ください。 |
| パラメーター | タイプ | 例 | 説明 |
| scene | String | porn | モデレーションリクエストで指定した画像モデレーションシナリオ。有効な値：
|
| label | String | sexy | モデレーション結果のカテゴリ。有効な値：
|
| sublabel | String | porn | scenes パラメーターが porn または terrorism に設定されている場合、モデレーション結果のサブカテゴリがこのパラメーターに返されることがあります。 このパラメーターはデフォルトでは返されません。 |
| suggestion | String | block | 推奨される後続の操作。有効な値：
|
| rate | Float | 91.54 | 信頼レベルのスコア。有効な値：0 から 100。値が大きいほど、信頼レベルが高いことを示します。 suggestion パラメーターに pass の値が返された場合、信頼レベルが高いほど、コンテンツが正常である可能性が高くなります。 提案レビューブロックsuggestion パラメーターに または の値が返された場合、信頼レベルが高いほど、コンテンツに違反が含まれている可能性が高くなります。 重要 suggestion、label、および sublabel パラメーターに返される値を使用して、コンテンツに違反が含まれているかどうかを判断することをお勧めします。 sublabel パラメーターは、特定の操作によって返されます。 |
| frames | JSONArray | モデレーション対象の画像が長すぎる場合、画像は切り詰められます。このパラメーターは、切り詰められた画像の各フレームの一時 URL を返します。構造の詳細については、「frame」をご参照ください。 | |
| hintWordsInfo | JSONArray | モデレーション対象の画像で検出された広告または違反テキストにヒットした用語に関する情報。構造の詳細については、「hintWordsInfo」をご参照ください。 説明 このパラメーターは、広告違反検出にのみ適用されます。 例： | |
| qrcodeData | StringArray | ["http://www.aliyundoc.com/01ZZOliO"] | モデレーション対象の画像で検出された QR コードに含まれるテキストに関する情報。 説明 このパラメーターは、QR コード検出にのみ適用されます。 |
| qrcodeLocations | JSONArray | モデレーション対象の画像で検出された QR コードの座標情報。構造の詳細については、「qrcodeLocation」をご参照ください。 | |
| programCodeData | JSONArray | モデレーション対象の画像で検出されたミニプログラムコードの位置情報。構造の詳細については、「programCodeData」をご参照ください。 説明 このパラメーターは、ミニプログラムコード検出にのみ適用されます。ミニプログラムコード検出が有効になっていることを確認してください。 | |
| logoData | JSONArray | モデレーション対象の画像で検出されたロゴに関する情報。構造の詳細については、「logoData」をご参照ください。 説明 このパラメーターは、ロゴ検出にのみ適用されます。 | |
| sfaceData | JSONArray | モデレーション対象の画像で検出されたテロコンテンツに関する情報。構造の詳細については、「sfaceData」をご参照ください。 説明 このパラメーターは、テロコンテンツ検出にのみ適用されます。 | |
| ocrData | Array | Haokan | モデレーション対象の画像で検出された完全なテキストに関する情報。 説明 デフォルトでは、このパラメーターは返されません。 |
| パラメーター | タイプ | 例 | 説明 |
| rate | Float | 89.85 | 信頼レベルのスコア。有効な値：0 から 100。信頼レベルが高いほど、モデレーション結果の信頼性が高くなります。ビジネスではこのスコアを使用しないことをお勧めします。 |
| url | String | http://www.aliyundoc.com/xxx-0.jpg | 切り詰められた画像のフレームの一時 URL。 URL は 5 分間有効です。 |
| パラメーター | タイプ | 例 | 説明 |
| x | Float | 11.0 | ミニプログラムコード領域の左上隅と Y 軸の間の距離。画像の左上隅が座標原点です。単位：ピクセル。 |
| y | Float | 0.0 | ミニプログラムコード領域の左上隅と X 軸の間の距離。画像の左上隅が座標原点です。単位：ピクセル。 |
| w | Float | 402.0 | ミニプログラムコード領域の幅。単位：ピクセル。 |
| h | Float | 413.0 | ミニプログラムコード領域の高さ。単位：ピクセル。 |
| パラメーター | タイプ | 例 | 説明 |
| type | String | TV | 検出されたロゴのタイプ。たとえば、TV の値は、禁止されているメディアのロゴを示します。 |
| name | String | xxx TV | 検出されたロゴの名前。 |
| x | Float | 140 | ロゴ領域の左上隅と Y 軸の間の距離。画像の左上隅が座標原点です。単位：ピクセル。 |
| y | Float | 68 | ロゴ領域の左上隅と X 軸の間の距離。画像の左上隅が座標原点です。単位：ピクセル。 |
| w | Float | 106 | ロゴ領域の幅。単位：ピクセル。 |
| h | Float | 106 | ロゴ領域の高さ。単位：ピクセル。 |
| パラメーター | タイプ | 例 | 説明 |
| x | Float | 49 | 顔領域の左上隅と Y 軸の間の距離。画像の左上隅が座標原点です。単位：ピクセル。 |
| y | Float | 39 | 顔領域の左上隅と X 軸の間の距離。画像の左上隅が座標原点です。単位：ピクセル。 |
| w | Float | 97 | 顔領域の幅。単位：ピクセル。 |
| h | Float | 131 | 顔領域の高さ。単位：ピクセル。 |
| faces | JSONArray | [{"name":"Hit name","rate":91.54,"id":"AliFace_0123****"}] | 認識された顔の情報。配列の各要素には、次のパラメーターが含まれています。
|
| パラメーター | タイプ | 例 | 説明 |
| context | String | Haokan | 検出されたテキストにヒットしたカスタム用語。 |
| libCode | String | 123456 | 検出されたテキストにヒットしたカスタム用語を含むライブラリのコード。 |
| libName | String | abc | 検出されたテキストにヒットしたカスタム用語を含むライブラリの名前。 |
| パラメーター | タイプ | 例 | 説明 |
| context | String | Haokan | 検出されたテキストにヒットした用語。 |
| パラメーター | タイプ | 例 | 説明 |
| x | Float | 11.0 | QR コード領域の左上隅と Y 軸の間の距離。画像の左上隅が座標原点です。単位：ピクセル。 |
| y | Float | 0.0 | QR コード領域の左上隅と X 軸の間の距離。画像の左上隅が座標原点です。単位：ピクセル。 |
| w | Float | 402.0 | QR コード領域の幅。単位：ピクセル。 |
| h | Float | 413.0 | QR コード領域の高さ。単位：ピクセル。 |
| qrcode | String | http://www.aliyundoc.com/0.ZZOliO | 検出された QR コードが指す URL。 |
例
http(s)://[Endpoint]/green/image/scan
&<共通リクエストパラメーター>
{
"scenes": [
"porn",
"terrorism",
"ad",
"live",
"qrcode",
"logo"
],
"tasks": [
{
"dataId": "uuid-xxxx-xxxx-1234",
"url": "http://www.aliyundoc.com/xxx.jpg"
}
]
}{
"msg": "OK",
"code": 200,
"data": [
{
"msg": "OK",
"code": 200,
"dataId": "cfd33235-71a4-468b-8137-a5ffe323****",
"extras": {
},
"results": [
{
"rate": 99.63,
"suggestion": "block",
"label": "sexy",
"scene": "porn"
},
{
"label": "politics",
"rate": 91.54,
"scene": "terrorism",
"sfaceData": [
{
"faces": [
{
"id": "AliFace_0123****",
"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": "Name of the custom image library", // カスタム画像ライブラリの名前
"hitLibInfo": [
{
"context": "Hit text", // ヒットテキスト
"libCode": "123456",
"libName": "Name of the custom text library" // カスタムテキストライブラリの名前
}
]
},
"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", // xxxテレビ
"type": "TV", // テレビ
"x": 140,
"y": 68,
"w": 106,
"h": 106
}
],
"rate": 99.9,
"suggestion": "block",
"label": "TV", // テレビ
"scene": "logo"
}
],
"taskId": "img4wlJcb7p4wH4lAP3111111-123456",
"url": "http://www.aliyundoc.com/xxx.jpg"
}
],
"requestId": "69B41AE8-1234-1234-1234-12D395695D2D"
}