Person Group Operations - Get Person Groups
列出 Person 群組 的 personGroupId、name、userData 和 recognitionModel。
person 群組 會依 personGroupId 的字母順序儲存。
-
- “start” 參數 (字串,選擇性) 會根據字元串比較指定傳回專案的標識符值。 將 「start」 設定為空值,表示應該從第一個項目開始傳回專案。
- “top” 參數 (int,選擇性) 會決定要傳回的項目數目上限,每個呼叫最多 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 |
---|---|---|---|---|
api
|
path | True |
string |
API 版本 |
endpoint
|
path | True |
string uri |
支持的認知服務端點 (通訊協定和主機名,例如:https://{resource-name}.cognitiveservices.azure.com) 。 |
return
|
query |
boolean |
傳回 'recognitionModel' 或未傳回 。 預設值為 false。 |
|
start
|
query |
string |
列出大於「開始」的資源。 它包含不超過 64 個字元。 預設為空白, |
|
top
|
query |
integer int32 |
要列出的專案數,範圍介於 [1, 1000]。 預設值為 1000。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
成功的呼叫會傳回 Person 群組 陣列及其資訊, (personGroupId、name 和 userData) 。 |
|
Other Status Codes |
未預期的錯誤回應。 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 |
範例
Get PersonGroups
Sample Request
GET {endpoint}/face/v1.1-preview.1/persongroups?start=00000000-0000-0000-0000-000000000000&top=20&returnRecognitionModel=True
Sample Response
[
{
"name": "your_person_group_name",
"userData": "your_user_data",
"recognitionModel": "recognition_01",
"personGroupId": "your_person_group_id"
}
]
定義
名稱 | Description |
---|---|
Face |
錯誤物件。 如需臉部服務所傳回錯誤碼和訊息的完整詳細數據,請參閱下列連結: https://aka.ms/face-error-codes-and-messages。 |
Face |
包含錯誤詳細數據的回應。 |
Person |
上傳人員數據的容器,包括臉部辨識功能,以及最多10,000人。 若要處理較大的臉部識別問題,請考慮使用大型人員群組。 |
Recognition |
臉部的辨識模型。 |
FaceError
錯誤物件。 如需臉部服務所傳回錯誤碼和訊息的完整詳細數據,請參閱下列連結: https://aka.ms/face-error-codes-and-messages。
名稱 | 類型 | Description |
---|---|---|
code |
string |
其中一組伺服器定義的錯誤碼。 |
message |
string |
人類看得懂的錯誤表示法。 |
FaceErrorResponse
包含錯誤詳細數據的回應。
名稱 | 類型 | Description |
---|---|---|
error |
錯誤物件。 |
PersonGroup
上傳人員數據的容器,包括臉部辨識功能,以及最多10,000人。 若要處理較大的臉部識別問題,請考慮使用大型人員群組。
名稱 | 類型 | Description |
---|---|---|
name |
string |
用戶定義的名稱,最大長度為128。 |
personGroupId |
string |
容器的標識碼。 |
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月發行的辨識模型。 建議您使用此辨識模型,以取得更佳的辨識精確度。 |