Person Directory Operations - Get Person Faces

サービス:

Azure AI Services

API バージョン:

v1.2-preview.1

登録された人物の顔の特徴を表す個人の永続化されたFaceId を取得します。

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

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' です。

応答

名前	型	説明
200 OK	ListFaceResult	呼び出しが成功すると、persistedFaceIds の配列と人物 ID が返されます。
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

例

Get Faces from PersonDirectory Person

要求のサンプル

HTTP

GET {endpoint}/face/v1.2-preview.1/persons/85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5/recognitionModels/recognition_01/persistedfaces

応答のサンプル

状態コード:

200

{
  "personId": "85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5",
  "persistedFaceIds": [
    "43897a75-8d6f-42cf-885e-74832febb055"
  ]
}

定義

名前	説明
FaceError	エラー オブジェクト。 Face サービスによって返されるエラー コードとメッセージの詳細については、次のリンクを参照してください: https://aka.ms/face-error-codes-and-messages。
FaceErrorResponse	エラーの詳細を含む応答。
ListFaceResult	人のリストの顔の応答。
RecognitionModel	顔の認識モデル。

FaceError

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

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

FaceErrorResponse

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

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

ListFaceResult

人のリストの顔の応答。

名前	型	説明
persistedFaceIds	string[]	永続化された顔 ID の配列。
personId	string	ユーザーの ID。

RecognitionModel

顔の認識モデル。

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