共用方式為

Person Directory Operations - Get Dynamic Person Groups

  • 參考
服務:
Azure AI Services
API 版本:
v1.2-preview.1

依 dynamicPersonGroupId 列出所有現有的動態人員群組，以及名稱和 userData。
動態人員群組會依 dynamicPersonGroupId 的字母順序儲存。

    • “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}/dynamicpersongroups
含選擇性參數: 
GET {endpoint}/face/{apiVersion}/dynamicpersongroups?start={start}&top={top}

URI 參數

名稱 位於 必要 類型 Description
apiVersion
 path True

string

API 版本
endpoint
 path True

string

uri

支持的認知服務端點（通訊協定和主機名，例如：https://{resource-name}.cognitiveservices.azure.com）。
start
 query

string

列出大於「開始」的資源。 它包含不超過 64 個字元。 預設值為空的。
top
 query

integer

int32

要列出的項目數目，範圍介於 [1， 1000] 內。 預設值為 1000。

回應

名稱 類型 Description
200 OK

DynamicPersonGroup[]

成功的呼叫會傳回動態人員群組及其信息陣列（dynamicPersonGroupId、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 DynamicPersonGroups

範例要求

GET {endpoint}/face/v1.2-preview.1/dynamicpersongroups?start=dynamic_person_group_id&top=20

範例回覆

狀態碼:
200 
[
  {
    "dynamicPersonGroupId": "your_dynamic_person_group_id",
    "name": "your_dynamic_person_group_name",
    "userData": "your_user_data"
  }
]

定義

名稱 Description
DynamicPersonGroup

參考 Person Directory “Create Person” 的容器。
FaceError

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

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

DynamicPersonGroup

參考 Person Directory “Create Person” 的容器。

名稱 類型 Description
dynamicPersonGroupId

string

動態人員群組的標識碼。
name

string

用戶定義的名稱，最大長度為128。
userData

string

選擇性的使用者定義數據。 長度不應超過 16K。

FaceError

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

名稱 類型 Description
code

string

其中一組伺服器定義的錯誤碼。
message

string

錯誤的人類可讀取表示法。

FaceErrorResponse

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

名稱 類型 Description
error

FaceError

error 物件。