Person Directory Operations - Get Persons

Usługa:

Azure AI Services

Wersja interfejsu API:

v1.2-preview.1

Wyświetl listę informacji wszystkich osób w katalogu osób, w tym personId, name i userData.
Osoby są przechowywane w kolejności alfabetycznej personId utworzonej w katalogu person Directory "Create Person".

• • Parametr "start" (ciąg, opcjonalny) określa wartość identyfikatora, z której zwrócone wpisy będą miały większe identyfikatory na podstawie porównania ciągów. Ustawienie wartości "start" na wartość pustą wskazuje, że wpisy powinny być zwracane od pierwszego elementu.
  • Parametr "top" (int, optional) określa maksymalną liczbę wpisów do zwrócenia, z limitem do 1000 wpisów na wywołanie. Aby pobrać dodatkowe wpisy wykraczające poza ten limit, określ wartość "start" z identyfikatorem personId ostatniego wpisu zwróconego w bieżącym wywołaniu.

Napiwek

• Na przykład istnieje łącznie 5 elementów z ich identyfikatorami: "itemId1", ..., "itemId5".
  • Wyrażenie "start=&top=" zwróci wszystkie 5 elementów.
  • Wyrażenie "start=&top=2" zwróci wartość "itemId1", "itemId2".
  • Wyrażenie "start=itemId2&top=3" zwróci wartość "itemId3", "itemId4", "itemId5".

GET {endpoint}/face/{apiVersion}/persons

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
apiVersion	path	True	string	Wersja interfejsu API
endpoint	path	True	string uri	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://{nazwa-zasobu}.cognitiveservices.azure.com).
start	query		string	Wyświetl listę zasobów większych niż "start". Zawiera nie więcej niż 64 znaki. Wartość domyślna jest pusta.
top	query		integer int32	Liczba elementów do wyświetlenia, począwszy od [1, 1000]. Wartość domyślna to 1000.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PersonDirectoryPerson[]	Pomyślne wywołanie zwraca tablicę osób katalogu osób znajdujących się w grupie osób dynamicznych.
Other Status Codes	FaceErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Zabezpieczenia

Ocp-Apim-Subscription-Key

Klucz tajny subskrypcji rozpoznawania twarzy w usłudze Azure AI.

Typ: apiKey
W: header

AADToken

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://api.example.com/oauth2/authorize
Adres URL tokenu: https://api.example.com/oauth2/token

Zakresy

Nazwa	Opis
https://cognitiveservices.azure.com/.default

Przykłady

Get Persons from PersonDirectory

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

200

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

Definicje

Nazwa	Opis
FaceError	Obiekt błędu. Aby uzyskać szczegółowe informacje na temat kodów błędów i komunikatów zwracanych przez usługę rozpoznawania twarzy, zapoznaj się z następującym linkiem: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Odpowiedź zawierająca szczegóły błędu.
PersonDirectoryPerson	Zasób osoby dla katalogu osób

FaceError

Obiekt błędu. Aby uzyskać szczegółowe informacje na temat kodów błędów i komunikatów zwracanych przez usługę rozpoznawania twarzy, zapoznaj się z następującym linkiem: https://aka.ms/face-error-codes-and-messages.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
message	string	Czytelna dla człowieka reprezentacja błędu.

FaceErrorResponse

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	FaceError	Obiekt błędu.

PersonDirectoryPerson

Zasób osoby dla katalogu osób

Nazwa	Typ	Opis
name	string	Nazwa zdefiniowana przez użytkownika, maksymalna długość to 128.
personId	string	Identyfikator osoby.
userData	string	Opcjonalne dane zdefiniowane przez użytkownika. Długość nie powinna przekraczać 16 tys.