Person Group Operations - Create Person Group

Service:

Azure AI Services

API Version:

v1.1-preview.1

Create 具有指定 personGroupId、name、user-provided userData 和 recognitionModel 的新人員群組。
人員群組是保存已上傳人員數據的容器，包括臉部辨識功能。

建立之後，使用「Create 人員群組人員」將人員新增至群組，然後呼叫「訓練人員群組」，讓此群組準備好「從人員群組識別」。

不會儲存任何影像。 只有人員擷取的臉部功能 () ，且userData會儲存在伺服器上，直到呼叫「刪除人員群組人員」或「刪除人員群組」為止。

應該指定 'recognitionModel'，以與此人員群組產生關聯。 'recognitionModel' 的預設值為 'recognition_01'，如果需要最新的模型，請在此參數中明確指定您需要的模型。 新增至現有人員群組的新臉部將會使用已經與集合相關聯的辨識模型。 人員群組中的現有臉部特徵 () 無法更新為另一個辨識模型所擷取的功能。

注意

• • 免費層訂用帳戶配額：1,000 個人 群組。 每個人員最多可保留 1,000 人。
  • S0 層訂用帳戶配額：1,000,000 個人 群組。 每個人員最多可保留 10,000 人。
  • 若要處理較大的臉部識別問題，請考慮使用大型人員群組。

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

URI 參數

名稱	位於	必要	類型	Description
apiVersion	path	True	string	API 版本
endpoint	path	True	string uri	支持的認知服務端點 (通訊協定和主機名，例如：https://{resource-name}.cognitiveservices.azure.com) 。
personGroupId	path	True	string	容器的標識碼。 Regex pattern: ^[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	未預期的錯誤回應。 Headers x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

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

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

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

範例

Create PersonGroup

Sample Request

HTTP

PUT {endpoint}/face/v1.1-preview.1/persongroups/your_person_group_id

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

Sample Response

Status code:

200

定義

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

FaceError

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

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

FaceErrorResponse

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

名稱	類型	Description
error	FaceError	錯誤物件。