Person Group Operations - Get Person Groups

服務:

Azure AI Services

API 版本:

v1.2-preview.1

列出人員群組的 personGroupId、name、userData 和 recognitionModel。
人員群組會依personGroupId的字母順序儲存。

• • “start” 參數 （string， optional） 會指定標識符值，從中傳回的專案會根據字串比較有較大的標識符。 將 「start」 設定為空值表示應該從第一個項目開始傳回專案。
  • “top” 參數 （int， optional） 會決定要傳回的項目數目上限，每個呼叫最多 1000 個專案的限制。 若要擷取超出此限制的其他專案，請使用目前呼叫中傳回之最後一個專案的personId指定 「start」。。

提示

• 例如，其標識碼總計有5個專案：「itemId1」、“...、”itemId5“。
  • “start=&top=” 會傳回所有 5 個專案。
  • “start=&top=2” 會傳回 “itemId1”、“itemId2”。
  • “start=itemId2&top=3” 會傳回 “itemId3”、“itemId4”、“itemId5”。

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

含選擇性參數:

GET {endpoint}/face/{apiVersion}/persongroups?start={start}&top={top}&returnRecognitionModel={returnRecognitionModel}

URI 參數

名稱	位於	必要	類型	Description
apiVersion	path	True	string	API 版本
endpoint	path	True	string uri	支持的認知服務端點（通訊協定和主機名，例如：https://{resource-name}.cognitiveservices.azure.com）。
returnRecognitionModel	query		boolean	傳回 'recognitionModel' 或否。 默認值為 false。
start	query		string	列出大於「開始」的資源。 它包含不超過 64 個字元。 預設值為空的。
top	query		integer int32	要列出的項目數目，範圍介於 [1， 1000] 內。 預設值為 1000。

回應

名稱	類型	Description
200 OK	PersonGroup[]	成功的呼叫會傳回 Person Groups 及其資訊陣列（personGroupId、name 和 userData）。
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 PersonGroups

範例要求

HTTP

GET {endpoint}/face/v1.2-preview.1/persongroups?start=00000000-0000-0000-0000-000000000000&top=20&returnRecognitionModel=True

範例回覆

狀態碼:

200

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

定義

名稱	Description
FaceError	error 物件。 如需臉部服務所傳回錯誤碼和訊息的完整詳細數據，請參閱下列連結：https://aka.ms/face-error-codes-and-messages。
FaceErrorResponse	包含錯誤詳細數據的回應。
PersonGroup	上傳人員數據的容器，包括臉部辨識功能，以及最多10,000人。 若要處理較大的臉部識別問題，請考慮使用大型人員群組。
RecognitionModel	臉部的辨識模型。

FaceError

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

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

FaceErrorResponse

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

名稱	類型	Description
error	FaceError	error 物件。

PersonGroup

上傳人員數據的容器，包括臉部辨識功能，以及最多10,000人。 若要處理較大的臉部識別問題，請考慮使用大型人員群組。

名稱	類型	Description
name	string	用戶定義的名稱，最大長度為128。
personGroupId	string	容器的標識碼。
recognitionModel	RecognitionModel	辨識模型的名稱。 辨識模型會在擷取臉部特徵並與偵測到的faceId相關聯時使用。
userData	string	選擇性的使用者定義數據。 長度不應超過 16K。

RecognitionModel

臉部的辨識模型。

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