Person Group Operations - Get Person Group Person Face
人物の顔情報を取得します。 永続化された人物の顔は、personGroupId、personId、persistedFaceId によって指定されます。
GET {endpoint}/face/{apiVersion}/persongroups/{personGroupId}/persons/{personId}/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 minLength: 1maxLength: 64 pattern: ^[a-z0-9-_]+$ |
コンテナーの ID。 |
|
person
|
path | True |
string (uuid) |
ユーザーの ID。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 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 form PersonGroup Person
要求のサンプル
GET {endpoint}/face/v1.2/persongroups/your_person_group_id/persons/25985303-c537-4467-b41d-bdb45cd95ca1/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 |
人物グループのユーザーの顔リソース。 |
FaceError
エラー オブジェクト。 Face サービスによって返されるエラー コードとメッセージの詳細については、次のリンクを参照してください: https://aka.ms/face-error-codes-and-messages。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
サーバー定義の一連のエラー コードの 1 つ。 |
| message |
string |
エラーの人間が判読できる表現。 |
FaceErrorResponse
エラーの詳細を含む応答。
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー オブジェクト。 |
PersonGroupPersonFace
人物グループのユーザーの顔リソース。
| 名前 | 型 | 説明 |
|---|---|---|
| persistedFaceId |
string (uuid) |
顔の顔 ID。 |
| userData |
string maxLength: 1024 |
顔にアタッチされたユーザー指定のデータ。 長さの制限は 1K です。 |