Person Group Operations - Get Person Group

サービス:

Azure AI Services

API バージョン:

v1.2-preview.1

人物グループ名、userData、recognitionModel を取得します。 この personGroup でユーザー情報を取得するには、"Get Person Group Persons" を使用します。

GET {endpoint}/face/{apiVersion}/persongroups/{personGroupId}

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

GET {endpoint}/face/{apiVersion}/persongroups/{personGroupId}?returnRecognitionModel={returnRecognitionModel}

URI パラメーター

名前	/	必須	型	説明
apiVersion	path	True	string	API バージョン
endpoint	path	True	string uri	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名。例: https://{resource-name}.cognitiveservices.azure.com)。
personGroupId	path	True	string	コンテナーの ID。 正規表現パターン: ^[a-z0-9-_]+$
returnRecognitionModel	query		boolean	'recognitionModel' を返すかどうか。 既定値は false です。

応答

名前	型	説明
200 OK	PersonGroup	呼び出しが成功すると、人物グループの情報が返されます。
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 PersonGroup

要求のサンプル

HTTP

GET {endpoint}/face/v1.2-preview.1/persongroups/your_person_group_id?returnRecognitionModel=True

応答のサンプル

状態コード:

200

{
  "name": "your_person_group_name",
  "userData": "your_user_data",
  "recognitionModel": "recognition_01",
  "personGroupId": "your_person_group_id"
}

定義

名前	説明
FaceError	エラー オブジェクト。 Face サービスによって返されるエラー コードとメッセージの詳細については、次のリンクを参照してください: https://aka.ms/face-error-codes-and-messages。
FaceErrorResponse	エラーの詳細を含む応答。
PersonGroup	顔認識機能と最大 10,000 人を含む、アップロードされた人物データのコンテナー。 大規模な顔識別の問題を処理するには、大規模人物グループの使用を検討してください。
RecognitionModel	顔の認識モデル。

FaceError

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

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

FaceErrorResponse

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

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

PersonGroup

顔認識機能と最大 10,000 人を含む、アップロードされた人物データのコンテナー。 大規模な顔識別の問題を処理するには、大規模人物グループの使用を検討してください。

名前	型	説明
name	string	ユーザー定義の名前。最大長は 128 です。
personGroupId	string	コンテナーの ID。
recognitionModel	RecognitionModel	認識モデルの名前。 認識モデルは、顔の特徴が抽出され、検出された faceId に関連付けられている場合に使用されます。
userData	string	省略可能なユーザー定義データ。 長さは 16K を超えないようにしてください。

RecognitionModel

顔の認識モデル。

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