Person Directory Operations - Add Person Face From Url

リファレンス

サービス:: Azure AI Services

API バージョン:: v1.1-preview.1

顔の識別または検証のために、顔を人物に追加します (「人物ディレクトリ」Create参照)。
複数の顔を含む画像を処理するには、入力面を targetFace 四角形を含む画像として指定できます。追加された顔を表す persistedFaceId を返します。イメージは保存されません。 Person Directory "Delete Person Face" または "Delete Person" が呼び出されるまで、抽出された顔機能のみがサーバーに保存されます。

persistedFaceId は、"Detect" によって生成された faceId とは異なります。

- 顔の画質が高いほど、認識精度が向上します。正面、透明、顔のサイズは 200 x 200 ピクセル (目の間に 100 ピクセル) 以上の高品質の顔を検討してください。
- 各人のエントリには、最大 248 の顔を保持できます。
- JPEG、PNG、GIF (最初のフレーム)、BMP 形式がサポートされています。許可されるイメージファイルのサイズは 1 KB から 6 MB です。
- "targetFace" 四角形には、1 つの顔が含まれている必要があります。 0 個または複数の面はエラーと見なされます。指定された "targetFace" 四角形が "Detect" から返されない場合、顔を正常に検出して追加する保証はありません。
- 検出可能な顔サイズ (36 x 36 ~ 4096 x 4096 ピクセル)、大きな頭部姿勢、または大きなオクルージョンが原因でエラーが発生します。
- 検出可能な顔の最小サイズは、1920x1080 ピクセル以下の画像では 36 x 36 ピクセルです。 1920x1080 ピクセルより大きいサイズの画像では、顔の最小サイズが比例的に大きくなります。
- さまざまな 'detectionModel' 値を指定できます。さまざまな検出モデルを使用して比較するには、次を参照してください。 https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-detection-model
- 同じ人物に対して顔を追加または削除すると、順番に処理されます。異なる人に対する顔の追加/削除は、並行して処理されます。
- この操作の実行には時間がかかります。応答ヘッダー "Operation-Location" を使用して、AddFace 操作が "Identify" への今後の要求に対して正常に反映されたタイミングを確認します。 Operation-Locations の詳細については、「顔操作の状態を取得する」を参照してください。

POST {endpoint}/face/{apiVersion}/persons/{personId}/recognitionModels/{recognitionModel}/persistedfaces

省略可能なパラメーターを含む:

POST {endpoint}/face/{apiVersion}/persons/{personId}/recognitionModels/{recognitionModel}/persistedfaces?_overload=addPersonFaceFromUrl&targetFace={targetFace}&detectionModel={detectionModel}&userData={userData}

URI パラメーター

名前	/	必須	型	説明
apiVersion	path	True	string	API バージョン
endpoint	path	True	string uri	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名(例: https://{resource-name}.cognitiveservices.azure.com)。
personId	path	True	string uuid	ユーザーのユーザー ID。
recognitionModel	path	True	RecognitionModel	顔に関連付けられている 'recognitionModel'。
detectionModel	query		DetectionModel	検出された faceIds に関連付けられている 'detectionModel'。サポートされている 'detectionModel' 値には、'detection_01'、'detection_02'、'detection_03' があります。既定値は 'detection_01' です。
targetFace	query		integer[]	"targetFace=left,top,width,height" の形式で、ユーザーに追加する対象の顔を指定する顔の四角形。
userData	query		string	顔にアタッチされたユーザー指定のデータ。サイズ制限は 1K です。

要求本文

名前	必須	型	説明
url	True	string	入力イメージの URL。

応答

名前	型	説明
202 Accepted	AddFaceResult	呼び出しが成功すると、空の応答本文が返されます。サービスは要求を受け入れ、まもなく処理を開始します。クライアントは、'Operation-Location' 応答ヘッダーで指定された URL を使用して、操作の状態と結果のクエリを実行できます。 URL の有効期間は 48 時間です。ヘッダー Location: string operation-Location: string
Other Status Codes	FaceErrorResponse	予期しないエラー応答。ヘッダー x-ms-error-code: string

名前

型

説明

202 Accepted

AddFaceResult

呼び出しが成功すると、空の応答本文が返されます。サービスは要求を受け入れ、まもなく処理を開始します。クライアントは、'Operation-Location' 応答ヘッダーで指定された URL を使用して、操作の状態と結果のクエリを実行できます。 URL の有効期間は 48 時間です。

ヘッダー

Location: string
operation-Location: string

Other Status Codes

FaceErrorResponse

予期しないエラー応答。

ヘッダー

x-ms-error-code: string

セキュリティ

Ocp-Apim-Subscription-Key

Azure AI Face サブスクリプションの秘密鍵。

型: apiKey
/: header

AADToken

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://api.example.com/oauth2/authorize
Token URL (トークン URL): https://api.example.com/oauth2/token

スコープ

名前	説明
https://cognitiveservices.azure.com/.default

例

Add Face to PersonDirectory Person from Url

要求のサンプル

HTTP

POST {endpoint}/face/v1.1-preview.1/persons/85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5/recognitionModels/recognition_01/persistedfaces?_overload=addPersonFaceFromUrl&targetFace=10,10,100,100&detectionModel=detection_01&userData=your_user_data

{
  "url": "https://microsoft.com/example.jpg"
}

応答のサンプル

状態コード:: 202

location: https://contoso.com/operationstatus
operation-Location: https://contoso.com/operationstatus

{
  "persistedFaceId": "43897a75-8d6f-42cf-885e-74832febb055"
}

定義

名前	説明
AddFaceResult	顔を追加するための応答本文。
DetectionModel	検出された faceIds に関連付けられている 'detectionModel'。サポートされている 'detectionModel' 値には、'detection_01'、'detection_02'、'detection_03' があります。既定値は 'detection_01' です。
FaceError	error オブジェクト。 Face Service によって返されるエラーコードとメッセージの包括的な詳細については、次のリンクを参照してください。 https://aka.ms/face-error-codes-and-messages
FaceErrorResponse	エラーの詳細を含む応答。
RecognitionModel	顔の認識モデル。

AddFaceResult

顔を追加するための応答本文。

名前	型	説明
persistedFaceId	string	追加された顔の永続化された顔 ID。これは永続化され、期限切れになりません。 "Detect" で作成され、検出呼び出し後 24 時間以内に期限切れになる faceId とは異なります。

DetectionModel

検出された faceIds に関連付けられている 'detectionModel'。サポートされている 'detectionModel' 値には、'detection_01'、'detection_02'、'detection_03' があります。既定値は 'detection_01' です。

名前	型	説明
detection_01	string	既定の検出モデル。正面近くの顔検出にお勧めします。非常に大きな角度 (頭部姿勢) の顔、隠れた顔、または間違った画像の向きのシナリオでは、そのような場合の顔は検出されない可能性があります。
detection_02	string	2019 年 5 月にリリースされた検出モデルで、特に小さい顔、側面、ぼやけた顔の精度が向上しました。
detection_03	string	2021 年 2 月にリリースされた検出モデルで、特に小さな顔の精度が向上しました。

FaceError

error オブジェクト。 Face Service によって返されるエラーコードとメッセージの包括的な詳細については、次のリンクを参照してください。 https://aka.ms/face-error-codes-and-messages

名前	型	説明
code	string	サーバー定義のエラーコードのセットの 1 つ。
message	string	エラーの人間が判読できる表現。

FaceErrorResponse

エラーの詳細を含む応答。

名前	型	説明
error	FaceError	error オブジェクト。

RecognitionModel

顔の認識モデル。

名前	型	説明
recognition_01	string	"検出" の既定の認識モデル。 2019 年 3 月より前に作成されたすべての faceId は、この認識モデルと結び付いています。
recognition_02	string	2019 年 3 月にリリースされた認識モデル。
recognition_03	string	2020 年 5 月にリリースされた認識モデル。
recognition_04	string	2021 年 2 月にリリースされた認識モデル。認識精度を向上させるには、この認識モデルを使用することをお勧めします。

次の方法で共有

Person Directory Operations - Add Person Face From Url

URI パラメーター

要求本文

応答

セキュリティ

Ocp-Apim-Subscription-Key

AADToken

スコープ

例

Add Face to PersonDirectory Person from Url

要求のサンプル

応答のサンプル

定義

AddFaceResult

DetectionModel

FaceError

FaceErrorResponse

RecognitionModel

その他のリソース