Face List Operations - Get Face Lists
Face Listsの faceListId、name、userData、recognitionModel を一覧表示します。
Face List 内で顔情報を取得するには、"顔リストの取得" を使用します。
GET {endpoint}/face/{apiVersion}/facelists
GET {endpoint}/face/{apiVersion}/facelists?returnRecognitionModel={returnRecognitionModel}
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
api
|
path | True |
string |
API バージョン |
endpoint
|
path | True |
string uri |
サポートされている Cognitive Services エンドポイント (プロトコルとホスト名(例: https://{resource-name}.cognitiveservices.azure.com)。 |
return
|
query |
boolean |
'recognitionModel' を返すかどうか。 既定値は false です。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
呼び出しが成功すると、Face Listsの配列が返されます。 |
|
Other Status Codes |
予期しないエラー応答。 Headers x-ms-error-code: string |
セキュリティ
Ocp-Apim-Subscription-Key
Azure AI Face サブスクリプションの秘密キー。
Type:
apiKey
In:
header
AADToken
Azure Active Directory OAuth2 フロー
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://api.example.com/oauth2/authorize
Token URL:
https://api.example.com/oauth2/token
Scopes
名前 | 説明 |
---|---|
https://cognitiveservices.azure.com/.default |
例
Get FaceLists
Sample Request
GET {endpoint}/face/v1.1-preview.1/facelists?returnRecognitionModel=True
Sample Response
[
{
"name": "your_face_list_name",
"userData": "your_user_data",
"recognitionModel": "recognition_01",
"faceListId": "your_face_list_id"
}
]
定義
名前 | 説明 |
---|---|
Face |
error オブジェクト。 Face Service によって返されるエラー コードとメッセージの詳細については、次のリンクを参照してください。 https://aka.ms/face-error-codes-and-messages |
Face |
エラーの詳細を含む応答。 |
Face |
リストフェイスリストの顔リスト項目。 |
Recognition |
顔の認識モデル。 |
FaceError
error オブジェクト。 Face Service によって返されるエラー コードとメッセージの詳細については、次のリンクを参照してください。 https://aka.ms/face-error-codes-and-messages
名前 | 型 | 説明 |
---|---|---|
code |
string |
サーバー定義のエラー コードのセットの 1 つ。 |
message |
string |
エラーの人間が判読できる表現。 |
FaceErrorResponse
エラーの詳細を含む応答。
名前 | 型 | 説明 |
---|---|---|
error |
error オブジェクト。 |
FaceListItem
リストフェイスリストの顔リスト項目。
名前 | 型 | 説明 |
---|---|---|
faceListId |
string |
有効な文字は小文字または数字、'-' または '_' の文字で、最大長は 64 です。 |
name |
string |
ユーザー定義の名前。最大長は 128 です。 |
recognitionModel |
認識モデルの名前。 認識モデルは、顔の特徴が抽出され、検出された faceId に関連付けられるときに使用されます。 |
|
userData |
string |
省略可能なユーザー定義データ。 長さは 16,000 を超えないようにしてください。 |
RecognitionModel
顔の認識モデル。
名前 | 型 | 説明 |
---|---|---|
recognition_01 |
string |
"検出" の既定の認識モデル。 2019 年 3 月より前に作成されたすべての faceId は、この認識モデルと結合されます。 |
recognition_02 |
string |
2019 年 3 月にリリースされた認識モデル。 |
recognition_03 |
string |
2020 年 5 月にリリースされた認識モデル。 |
recognition_04 |
string |
認識モデルは 2021 年 2 月にリリースされました。 認識精度を向上させるために、この認識モデルを使用することをお勧めします。 |