Sdílet prostřednictvím

Person Directory Operations - Get Dynamic Person Group Persons

  • Reference
Služba:
Azure AI Services
Verze rozhraní API:
v1.2-preview.1

Zobrazí seznam všech osob v zadané skupině dynamických osob.
Osoby se ukládají v abecedním pořadí podle id osoby vytvořené v adresáři osob "Vytvořit osobu".

    • Parametr start (řetězec, volitelný) určuje hodnotu ID, ze které budou vrácené položky mít větší ID na základě porovnání řetězců. Nastavení "start" na prázdnou hodnotu označuje, že položky by měly být vráceny od první položky.
    • Parametr "top" (int, optional) určuje maximální počet položek, které se mají vrátit, s limitem až 1 000 položek na volání. Pokud chcete načíst další položky nad rámec tohoto limitu, zadejte "start" s id poslední položky vrácenou v aktuálním volání.

Spropitné

  • Existuje například celkem 5 položek se svými ID: itemId1, ..., itemId5.
    • Výraz start=&top=" vrátí všech 5 položek.
    • "start=&top=2" vrátí "itemId1", "itemId2".
    • "start=itemId2&top=3" vrátí "itemId3", "itemId4", "itemId5".
GET {endpoint}/face/{apiVersion}/dynamicpersongroups/{dynamicPersonGroupId}/persons
S volitelnými parametry: 
GET {endpoint}/face/{apiVersion}/dynamicpersongroups/{dynamicPersonGroupId}/persons?start={start}&top={top}

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
apiVersion
 path True

string

Verze rozhraní API
dynamicPersonGroupId
 path True

string

ID dynamické skupiny osob.

Vzor regulárního výrazu: ^[a-z0-9-_]+$
endpoint
 path True

string

uri

Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://{název_prostředku}.cognitiveservices.azure.com).
start
 query

string

Uveďte prostředky větší než počáteční. Neobsahuje více než 64 znaků. Výchozí hodnota je prázdná.
top
 query

integer

int32

Počet položek seznamu v rozsahu od [1, 1000]. Výchozí hodnota je 1000.

Odpovědi

Name Typ Description
200 OK

ListPersonResult

Úspěšné volání vrátí pole informací o osobě v adresáři osob.
Other Status Codes

FaceErrorResponse

Neočekávaná chybová odpověď

Hlavičky

x-ms-error-code: string

Zabezpečení

Ocp-Apim-Subscription-Key

Tajný klíč předplatného Azure AI Face.

Typ: apiKey
V: header

AADToken

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: accessCode
URL autorizace: https://api.example.com/oauth2/authorize
URL tokenu: https://api.example.com/oauth2/token

Rozsahy

Name Description
https://cognitiveservices.azure.com/.default

Příklady

Get DynamicPersonGroup Persons

Ukázkový požadavek

GET {endpoint}/face/v1.2-preview.1/dynamicpersongroups/your_dynamic_person_group_id/persons?start=00000000-0000-0000-0000-000000000000&top=20

Ukázková odpověď

Stavový kód:
200 
{
  "personIds": [
    "1d44651f-fadb-41f5-8918-c30609964489",
    "c1d3b745-2548-4abf-b057-a386c9bd52f1"
  ]
}

Definice

Name Description
FaceError

Objekt chyby. Podrobné informace o kódech chyb a zprávách vrácených službou Rozpoznávání tváře najdete na následujícím odkazu: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse

Odpověď obsahující podrobnosti o chybě.
ListPersonResult

Odpověď dynamické osoby se seznamem osob

FaceError

Objekt chyby. Podrobné informace o kódech chyb a zprávách vrácených službou Rozpoznávání tváře najdete na následujícím odkazu: https://aka.ms/face-error-codes-and-messages.

Name Typ Description
code

string

Jedna ze serverově definovaných kódů chyb.
message

string

Čitelné znázornění chyby člověkem.

FaceErrorResponse

Odpověď obsahující podrobnosti o chybě.

Name Typ Description
error

FaceError

Objekt chyby.

ListPersonResult

Odpověď dynamické osoby se seznamem osob

Name Typ Description
personIds

string[]

Array of PersonDirectory Person IDs.