Person Directory Operations - Get Person Face
人物の顔情報を取得します。 永続化された人物の顔は、その personId によって指定されます。 recognitionModel、persistedFaceId。
GET {endpoint}/face/{apiVersion}/persons/{personId}/recognitionModels/{recognitionModel}/persistedfaces/{persistedFaceId}
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
api
|
path | True |
string |
API バージョン |
endpoint
|
path | True |
string uri |
サポートされている Cognitive Services エンドポイント (プロトコルとホスト名。例: https://{resource-name}.cognitiveservices.azure.com)。 |
persisted
|
path | True |
string uuid |
顔の顔 ID。 |
person
|
path | True |
string uuid |
ユーザーのユーザー ID。 |
recognition
|
path | True |
顔に関連付けられている 'recognitionModel' です。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
呼び出しが成功すると、ターゲットの永続化された顔の情報 (persistedFaceId と userData) が返されます。 |
|
Other Status Codes |
予期しないエラー応答。 ヘッダー 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 |
例
Get Face from PersonDirectory Person
要求のサンプル
GET {endpoint}/face/v1.2-preview.1/persons/85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5/recognitionModels/recognition_01/persistedfaces/43897a75-8d6f-42cf-885e-74832febb055
応答のサンプル
{
"persistedFaceId": "43897a75-8d6f-42cf-885e-74832febb055",
"userData": "your_user_data"
}
定義
名前 | 説明 |
---|---|
Face |
エラー オブジェクト。 Face サービスによって返されるエラー コードとメッセージの詳細については、次のリンクを参照してください: https://aka.ms/face-error-codes-and-messages。 |
Face |
エラーの詳細を含む応答。 |
Person |
人物ディレクトリユーザーの Face リソース。 |
Recognition |
顔の認識モデル。 |
FaceError
エラー オブジェクト。 Face サービスによって返されるエラー コードとメッセージの詳細については、次のリンクを参照してください: https://aka.ms/face-error-codes-and-messages。
名前 | 型 | 説明 |
---|---|---|
code |
string |
サーバー定義の一連のエラー コードの 1 つ。 |
message |
string |
エラーの人間が判読できる表現。 |
FaceErrorResponse
エラーの詳細を含む応答。
名前 | 型 | 説明 |
---|---|---|
error |
エラー オブジェクト。 |
PersonDirectoryFace
人物ディレクトリユーザーの Face リソース。
名前 | 型 | 説明 |
---|---|---|
persistedFaceId |
string |
顔の顔 ID。 |
userData |
string |
顔にアタッチされたユーザー指定のデータ。 長さの制限は 1K です。 |
RecognitionModel
顔の認識モデル。
名前 | 型 | 説明 |
---|---|---|
recognition_01 |
string |
"Detect" の既定の認識モデル。 2019 年 3 月より前に作成されたすべての faceId は、この認識モデルと結合されます。 |
recognition_02 |
string |
2019 年 3 月にリリースされた認識モデル。 |
recognition_03 |
string |
2020 年 5 月にリリースされた認識モデル。 |
recognition_04 |
string |
2021 年 2 月にリリースされた認識モデル。 認識精度を向上させるために、この認識モデルを使用することをお勧めします。 |