Face List Operations - Get Face List

服務:

Azure AI Services

API 版本:

v1.2-preview.1

擷取臉部清單的 faceListId、name、userData、recognitionModel 和臉部清單中的臉部。

GET {endpoint}/face/{apiVersion}/facelists/{faceListId}

含選擇性參數:

GET {endpoint}/face/{apiVersion}/facelists/{faceListId}?returnRecognitionModel={returnRecognitionModel}

URI 參數

名稱	位於	必要	類型	Description
apiVersion	path	True	string	API 版本
endpoint	path	True	string uri	支持的認知服務端點（通訊協定和主機名，例如：https://{resource-name}.cognitiveservices.azure.com）。
faceListId	path	True	string	有效字元為小寫或數位或 '-' 或 '_'，最大長度為 64。 Regex 模式: ^[a-z0-9-_]+$
returnRecognitionModel	query		boolean	傳回 'recognitionModel' 或否。 默認值為 false。

回應

名稱	類型	Description
200 OK	FaceList	成功的呼叫會傳回臉部清單的資訊。
Other Status Codes	FaceErrorResponse	未預期的錯誤回應。 標題 x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

Azure AI 臉部訂用帳戶的秘密密鑰。

類型: apiKey
位於: header

AADToken

Azure Active Directory OAuth2 流程

類型: oauth2
Flow: accessCode
授權 URL: https://api.example.com/oauth2/authorize
權杖 URL: https://api.example.com/oauth2/token

範圍

名稱	Description
https://cognitiveservices.azure.com/.default

範例

Get FaceList

範例要求

HTTP

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

範例回覆

狀態碼:

200

{
  "name": "your_face_list_name",
  "userData": "your_user_data",
  "recognitionModel": "recognition_01",
  "faceListId": "your_face_list_id"
}

定義

名稱	Description
FaceError	error 物件。 如需臉部服務所傳回錯誤碼和訊息的完整詳細數據，請參閱下列連結：https://aka.ms/face-error-codes-and-messages。
FaceErrorResponse	包含錯誤詳細數據的回應。
FaceList	臉部清單是臉部清單，最多 1,000 張臉部。
FaceListFace	臉部清單的臉部資源。
RecognitionModel	臉部的辨識模型。

FaceError

error 物件。 如需臉部服務所傳回錯誤碼和訊息的完整詳細數據，請參閱下列連結：https://aka.ms/face-error-codes-and-messages。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
message	string	錯誤的人類可讀取表示法。

FaceErrorResponse

包含錯誤詳細數據的回應。

名稱	類型	Description
error	FaceError	error 物件。

FaceList

臉部清單是臉部清單，最多 1,000 張臉部。

名稱	類型	Description
faceListId	string	有效字元為小寫或數位或 '-' 或 '_'，最大長度為 64。
name	string	用戶定義的名稱，最大長度為128。
persistedFaces	FaceListFace[]	臉部清單中已註冊臉部的臉部標識碼。
recognitionModel	RecognitionModel	辨識模型的名稱。 辨識模型會在擷取臉部特徵並與偵測到的faceId相關聯時使用。
userData	string	選擇性的使用者定義數據。 長度不應超過 16K。

FaceListFace

臉部清單的臉部資源。

名稱	類型	Description
persistedFaceId	string	臉部的臉部標識碼。
userData	string	附加至臉部的使用者提供數據。 長度限制為 1K。

RecognitionModel

臉部的辨識模型。

名稱	類型	Description
recognition_01	string	「偵測」的預設辨識模型。 所有在 2019 年 3 月之前建立的 faceId 都會與這個辨識模型結合。
recognition_02	string	辨識模型於 2019 年 3 月發行。
recognition_03	string	辨識模型於 2020 年 5 月發行。
recognition_04	string	辨識模型於 2021 年 2 月發行。 建議您使用此辨識模型來提升辨識精確度。