Person Directory Operations - Get Persons

Služba:

Azure AI Services

Verze rozhraní API:

v1.2-preview.1

Vypište všechny informace o osobách v adresáři osob, včetně ID osoby, jména a userData.
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}/persons

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
apiVersion	path	True	string	Verze rozhraní API
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	PersonDirectoryPerson[]	Úspěšné volání vrátí pole osob adresářů osob obsažených v dynamické skupině 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 Persons from PersonDirectory

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

200

[
  {
    "personId": "85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5",
    "name": "your_person_name",
    "userData": "your_user_data"
  }
]

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ě.
PersonDirectoryPerson	Prostředek osoby pro adresář osoby

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.

PersonDirectoryPerson

Prostředek osoby pro adresář osoby

Name	Typ	Description
name	string	Uživatelem definované jméno, maximální délka je 128.
personId	string	ID osoby.
userData	string	Volitelná uživatelsky definovaná data Délka by neměla překročit 16 tisíc.