Face List Operations - Create Face List

服務:

Azure AI Services

API 版本:

v1.2-preview.1

使用使用者指定的 faceListId、name、選擇性 userData 和 recognitionModel 建立空的臉部清單。
一個訂用帳戶最多允許64個臉部清單。

臉部清單是臉部清單，最多 1,000 張臉部，並由「從臉部清單尋找類似」使用。

建立之後，用戶應該使用「新增臉部清單臉部」來匯入臉部。 不會儲存任何映像。 只有擷取的臉部功能才會儲存在伺服器上，直到呼叫「刪除臉部清單」為止。

「尋找類似」用於尋找名人樣臉部、類似臉部篩選或淺色臉部識別等案例。 但如果實際使用是識別人員，請使用人員群組/大型人員群組和「識別」。

當臉部數目很大時，請考慮大型臉部清單。 最多可支援 1,000,000 張臉部。

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

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-_]+$

要求本文

名稱	必要	類型	Description
name	True	string	用戶定義的名稱，最大長度為128。
recognitionModel		RecognitionModel	與此臉部清單相關聯的 『recognitionModel』。 支援的 'recognitionModel' 值包括 'recognition_01'、'recognition_02、'recognition_03'和 'recognition_04'。 預設值為 『recognition_01』。 建議使用『recognition_04』，因為它的精確度比“recognition_03”來改善臉部的精確度，而且與“recognition_01”和“recognition_02”相比，其整體精確度也得到了改善。
userData		string	選擇性的使用者定義數據。 長度不應超過 16K。

回應

名稱	類型	Description
200 OK		要求已成功。
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

範例

Create FaceList

範例要求

HTTP

PUT {endpoint}/face/v1.2-preview.1/facelists/your_face_list_id

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

範例回覆

狀態碼:

200

定義

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

FaceError

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

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

FaceErrorResponse

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

名稱	類型	Description
error	FaceError	error 物件。