Person Group Operations - Get Large Person Group Person

サービス:

Azure AI Services

API バージョン:

v1.2-preview.1

ユーザーの名前と userData、および登録済みの人物の顔機能を表す永続化された faceId を取得します。

GET {endpoint}/face/{apiVersion}/largepersongroups/{largePersonGroupId}/persons/{personId}

URI パラメーター

名前	/	必須	型	説明
apiVersion	path	True	string	API バージョン
endpoint	path	True	string uri	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名。例: https://{resource-name}.cognitiveservices.azure.com)。
largePersonGroupId	path	True	string	コンテナーの ID。 正規表現パターン: ^[a-z0-9-_]+$
personId	path	True	string uuid	ユーザーの ID。

応答

名前	型	説明
200 OK	LargePersonGroupPerson	呼び出しが成功すると、そのユーザーの情報が返されます。
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 Person from LargePersonGroup

要求のサンプル

HTTP

GET {endpoint}/face/v1.2-preview.1/largepersongroups/your_large_person_group_id/persons/25985303-c537-4467-b41d-bdb45cd95ca1

応答のサンプル

状態コード:

200

{
  "personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
  "name": "your_large_person_group_person_name",
  "userData": "your_user_data",
  "persistedFaceIds": [
    "43897a75-8d6f-42cf-885e-74832febb055"
  ]
}

定義

名前	説明
FaceError	エラー オブジェクト。 Face サービスによって返されるエラー コードとメッセージの詳細については、次のリンクを参照してください: https://aka.ms/face-error-codes-and-messages。
FaceErrorResponse	エラーの詳細を含む応答。
LargePersonGroupPerson	指定した大規模人物グループ内の人物。 このユーザーに顔を追加するには、"Add Large Person Group Person Face" を呼び出してください。

FaceError

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

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

FaceErrorResponse

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

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

LargePersonGroupPerson

指定した大規模人物グループ内の人物。 このユーザーに顔を追加するには、"Add Large Person Group Person Face" を呼び出してください。

名前	型	説明
name	string	ユーザー定義の名前。最大長は 128 です。
persistedFaceIds	string[]	人物の登録済み顔の顔 ID。
personId	string	ユーザーの ID。
userData	string	省略可能なユーザー定義データ。 長さは 16K を超えないようにしてください。