このトピックでは、画像非同期検出インターフェイス(/green/image/asyncscan)を呼び出して、顔画像の 1:1 照合を実行する方法について説明します。顔照合は、2 つの顔写真の類似性を検出するのに役立ちます。
非同期画像モデレーションに関する説明非同期イメージ モデレーション
操作: /green/image/asyncscan
この操作を呼び出して、非同期画像モデレーションタスクを送信できます。 HTTP リクエストを作成する方法の詳細については、「リクエスト構造」をご参照ください。既存の HTTP リクエストを選択することもできます。詳細については、「SDK の概要」をご参照ください。
課金方法:
この操作の呼び出しには料金が発生します。課金方法の詳細については、 をご参照ください。
説明顔照合機能の場合、2 回ではなく 1 回の照合のために 2 つの画像を渡します。
応答タイムアウト:
同期モデレーションリクエストで許可される最大応答時間は 6 秒です。モデレーションが 6 秒以内に完了しない場合は、タイムアウトエラーが返されます。リアルタイムでモデレーション結果を必要としない場合は、非同期モデレーションリクエストを送信できます。ほとんどの場合、同期モデレーション操作の方が呼び出しやすいため、同期モデレーションリクエストを送信することをお勧めします。同期モデレーション操作を呼び出す場合は、タイムアウト期間を 6 秒に設定することをお勧めします。
結果の戻り値:
非同期モデレーションリクエストを送信した場合、モデレーション結果はリアルタイムで返されません。モデレーション結果を取得するには、モデレーション結果を定期的にポーリングするか、コールバック通知を有効にすることができます。モデレーション結果は最大 1 時間保持されます。
コールバックによる検出結果の取得: 非同期検出タスクを送信するときに、リクエストパラメータで callback パラメータを指定して、検出結果を自動的に受信できます。詳細については、「リクエストパラメータ」をご参照ください。
ポーリングによる検出結果の取得: 非同期検出タスクを送信するときに、callback パラメータを指定する必要はありません。非同期検出タスクを送信した後、結果クエリ操作を呼び出して検出結果を取得できます。詳細については、「/green/image/results に関する説明」をご参照ください。
画像の制限:
画像の URL は、HTTP または HTTPS URL である必要があります。
画像は PNG、JPG、JPEG、BMP、GIF、または WEBP 形式である必要があります。
画像は最大 20 MB まで可能です。画像サイズの制限は、同期および非同期モデレーション操作の両方に適用されます。
画像のダウンロード期間は 3 秒に制限されています。画像が 3 秒以内にダウンロードされない場合は、タイムアウトエラーが返されます。
モデレーション効果を確保するために、少なくとも 256 × 256 ピクセルの画像を送信することをお勧めします。
画像をモデレートする操作の応答時間は、これらの画像のダウンロード期間によって異なります。モデレートする画像を保存するために、安定していて信頼できるストレージサービスを使用してください。Object Storage Service (OSS) または Content Delivery Network (CDN) を使用することをお勧めします。
QPS 制限
この操作は、アカウントごとに 1 秒あたり最大 50 回呼び出すことができます。1 秒あたりの呼び出し数が制限を超えると、速度制限がトリガーされます。その結果、ビジネスに影響が及ぶ可能性があります。この操作を呼び出すときは、制限に注意することをお勧めします。
リクエストパラメータ
パラメータ | タイプ | 必須 | 例 | 説明 | |
bizType | String | いいえ | default | ビジネス シナリオ。 ビジネス シナリオは、 で作成できます。 Content Moderation コンソール。詳細については、「機械学習によるモデレーションのポリシーをカスタマイズする」をご参照ください。 | |
scenes | StringArray | はい | ["sface-1"] | 検出シナリオを指定します。有効な値: sface-1。顔照合を示します。 | |
callback | String | いいえ | http://www.aliyundoc.com/xx.json | 非同期モデレーション結果を通知するためのコールバック URL。HTTP および HTTPS URL がサポートされています。このパラメータを設定しない場合は、モデレーション結果を定期的にポーリングする必要があります。 モデレーションリクエストで callback パラメータを設定する場合は、指定した HTTP または HTTPS URL が次の要件を満たしていることを確認してください。POST メソッドをサポートしていること、送信データのエンコードに UTF-8 を使用していること、checksum パラメータと content パラメータをサポートしていること。指定されたコールバック URL にモデレーション結果を送信するために、Content Moderation は次のルールと形式に基づいて、コールバック通知で checksum パラメータと content パラメータを返します。
説明 サーバーがコールバック通知を正常に受信した場合、サーバーは Content Moderation に HTTP 200 ステータスコードを送信します。サーバーがコールバック通知を受信できなかった場合、サーバーは Content Moderation に他の HTTP ステータスコードを送信します。サーバーがコールバック通知を受信できなかった場合、Content Moderation はサーバーが受信するまでコールバック通知のプッシュを続けます。Content Moderation は、最大 16 回までコールバック通知を繰り返しプッシュできます。16 回後、Content Moderation はコールバック通知のプッシュを停止します。この場合、コールバック URL のステータスを確認することをお勧めします。 | |
seed | String | いいえ | aabbcc123 | コールバック通知リクエストの署名を生成するために使用されるランダムな文字列。 文字列は最大 64 文字で、文字、数字、アンダースコア(_)を含めることができます。この文字列はカスタマイズできます。Content Moderation がサーバーにコールバック通知をプッシュするときに、コールバック通知リクエストを検証するために使用されます。 説明 callback パラメータを設定する場合は、このパラメータが必要です。 | |
cryptType | String | いいえ | SHA256 | コールバック通知を有効にしたときに、コールバック通知コンテンツの暗号化に使用される暗号化アルゴリズム。Content Moderation は、指定した暗号化アルゴリズムを使用して返された文字列を暗号化し、暗号化された文字列をコールバック URL に送信します。返される文字列は UID + Seed + Content 形式です。有効な値:
| |
tasks | JSONArray | はい | モデレーションオブジェクトのリスト。JSON 配列の各要素は、モデレーションタスク構造です。JSON 配列には最大 100 個の要素を含めることができます。つまり、一度に最大 100 枚の画像を送信できます。一度に 100 枚の画像を送信するには、関連する同時実行制限を 100 より大きい数に上げる必要があります。各要素の構造の詳細については、「task」をご参照ください。 |
表 1. task
パラメータ | タイプ | 必須 | 例 | 説明 |
dataId | String | いいえ | e6b080a8-a91a-11e8-bac4-6c96cfde2af9 | モデレーションオブジェクトの ID。 ID には、文字、数字、アンダースコア(_)、ハイフン(-)、ピリオド(.)を含めることができます。最大 128 文字まで可能です。この ID は、ビジネスデータを一意に識別します。 |
url | String | はい | http://www.aliyundoc.com/2015/0826/2015082612403321.jpg | インターネット経由でアクセスできる HTTP または HTTPS URL。URL は最大 2,048 文字です。 説明 照合する画像の最初の画像の URL を指定します。 |
extras | JSONObject | いいえ | {"faceUrl":"http://www.aliyundoc.com/c/u/2013/0313/1363136852136.jpg"} | 照合する画像の 2 番目の画像を渡します。形式は |
レスポンスパラメータ
パラメータ | タイプ | 例 | 説明 |
code | Integer | 200 | 返された HTTP ステータスコード。 詳細については、「一般的なエラーコード」をご参照ください。 |
msg | String | OK | リクエストに対して返されるメッセージ。 |
dataId | String | e6b080a8-a91a-11e8-bac4-6c96cfde2af9 | モデレーションオブジェクトの ID。 説明 モデレーションリクエストで dataId パラメータを設定した場合、dataId リクエストパラメータの値がここに返されます。 |
taskId | String | fdd25f95-4892-4d6b-aca9-7939bc6e9baa-1486198766695 | OCR タスクの ID。 |
url | String | http://www.aliyundoc.com/2015/0826/2015082612403321.jpg | インターネット経由でアクセスできる HTTP または HTTPS URL。URL は最大 2,048 文字です。 説明 モデレーションオブジェクトの URL。対応するリクエストの URL、つまり最初の画像の URL。 |
例
リクエストの例
http(s)://[エンドポイント]/green/image/asyncscan
&<共通リクエストパラメータ>
{
"scenes": [
"sface-1"
],
"tasks": [
{
"url": "http://www.aliyundoc.com/2015/0826/2015082612403321.jpg",
"dataId": "e6b080a8-a91a-11e8-bac4-6c96cfde2af9",
"extras": {
"faceUrl": "http://www.aliyundoc.com/c/u/2013/0313/1363136852136.jpg"
},
"time": 949640
}
]
}成功レスポンスの例
{
"code": 200,
"msg": "OK",
"requestId": "95AD868A-F5D2-4AEA-96D4-E0273B8E074C",
"data": [
{
"code": 200,
"msg": "OK",
"dataId": "e6b080a8-a91a-11e8-bac4-6c96cfde2af9",
"taskId": "fdd25f95-4892-4d6b-aca9-7939bc6e9baa-1486198766695",
"url": "http://www.aliyundoc.com/2015/0826/2015082612403321.jpg"
}
]
}/green/image/results に関する説明
操作: /green/image/results
この操作を呼び出して、非同期画像モデレーション結果を照会できます。 HTTP リクエストを作成する方法の詳細については、「リクエスト構造」をご参照ください。既存の HTTP リクエストを選択することもできます。詳細については、「SDK の概要」をご参照ください。
課金方法:
この操作は無料です。
応答タイムアウト:
非同期モデレーションリクエストを送信してから少なくとも 30 秒後にモデレーション結果を照会することをお勧めします。Content Moderation は、モデレーション結果を最大 4 時間保持します。4 時間後、結果は削除されます。
QPS 制限
この操作は、アカウントごとに 1 秒あたり最大 50 回呼び出すことができます。1 秒あたりの呼び出し数が制限を超えると、速度制限がトリガーされます。その結果、ビジネスに影響が及ぶ可能性があります。この操作を呼び出すときは、制限に注意することをお勧めします。
リクエストパラメータ
パラメータ | タイプ | 必須 | 例 | 説明 |
body | StringArray | はい | ["fdd25f95-4892-4d6b-aca9-7939bc6e9baa-1486198766695"] | 照会する非同期モデレーションタスクの ID のリスト。 配列には最大 100 個の要素を含めることができます。 モデレーションタスクを送信した後、レスポンスからタスクの ID を取得できます。 |
レスポンスパラメータ
パラメータ | タイプ | 例 | 説明 |
code | Integer | 200 | 返された HTTP ステータスコード。 詳細については、「一般的なエラーコード」をご参照ください。 |
msg | String | OK | リクエストに対して返されるメッセージ。 |
dataId | String | e6b080a8-a91a-11e8-bac4-6c96cfde2af9 | モデレーションオブジェクトの ID。 説明 モデレーションリクエストで dataId パラメータを設定した場合、dataId リクエストパラメータの値がここに返されます。 |
taskId | String | img2hsbmQeA4CU7l78$s8q5mW-1pnn7Z | モデレーションタスクの ID。 |
url | String | http://www.aliyundoc.com/2015/0826/2015082612403321.jpg | モデレートされた音声の URL。 |
results | JSONArray | 戻り値。呼び出しが成功して HTTP ステータスコード 200 が返された場合、戻り値の配列には 1 つ以上の要素が含まれます。各要素は構造体です。構造体の詳細については、「result」をご参照ください。 | |
extras | JSONObject | xxx | 呼び出された追加パラメータ。 説明 このパラメータは変更される可能性があります。このパラメータの最新の値を使用してください。 |
表 2. result
パラメータ | タイプ | 例 | 説明 |
scene | String | sface-1 | 検出シナリオ。有効な値: sface-1。顔照合を示します。 |
label | String | sface-1 | 検出結果のカテゴリ。有効な値:
|
suggestion | String | review | モデレートされた画像の機械支援モデレーション結果。有効な値:
|
rate | Float | 97.0 | 信頼レベルのスコア。有効な値: 0 から 100。信頼レベルが高いほど、モデレーション結果の信頼性が高いことを示します。ビジネスではこのスコアを使用しないことをお勧めします。 |
例
リクエストの例
http(s)://[エンドポイント]/green/image/results
&<共通リクエストパラメータ>
[
"fdd25f95-4892-4d6b-aca9-7939bc6e9baa-1486198766695"
]成功レスポンスの例
{
"code": 200,
"msg": "OK",
"requestId": "9EEF894F-A933-4830-97B1-EC1A9630A9D6",
"data": [
{
"code": 200,
"dataId": "e6b080a8-a91a-11e8-bac4-6c96cfde2af9",
"taskId": "img2hsbmQeA4CU7l78$s8q5mW-1pnn7Z",
"url": "http://www.aliyundoc.com/2015/0826/2015082612403321.jpg",
"extras": {
},
"msg": "OK",
"results": {
"label": "sface-1",
"rate": 97.0,
"scene": "sface-1",
"suggestion": "review"
}
}
]
}