Person Group Operations - Get Person Groups

Usługa:

Azure AI Services

Wersja interfejsu API:

v1.2-preview.1

Wyświetlanie listy osób personGroupId, name, userData i recognitionModel.
Grupy osób są przechowywane w kolejności alfabetycznej personGroupId.

• • 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}/persongroups

Z parametrami opcjonalnymi:

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

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).
returnRecognitionModel	query		boolean	Zwraca wartość "recognitionModel" lub nie. Wartość domyślna to false.
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	PersonGroup[]	Pomyślne wywołanie zwraca tablicę grup osób i ich informacji (personGroupId, name i userData).
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 PersonGroups

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

200

[
  {
    "name": "your_person_group_name",
    "userData": "your_user_data",
    "recognitionModel": "recognition_01",
    "personGroupId": "your_person_group_id"
  }
]

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.
PersonGroup	Kontener przekazanych danych osób, w tym funkcji rozpoznawania twarzy i maksymalnie 10 000 osób. Aby rozwiązać problem z identyfikacją twarzy na większą skalę, rozważ użycie grupy dużych osób.
RecognitionModel	Model rozpoznawania twarzy.

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.

PersonGroup

Kontener przekazanych danych osób, w tym funkcji rozpoznawania twarzy i maksymalnie 10 000 osób. Aby rozwiązać problem z identyfikacją twarzy na większą skalę, rozważ użycie grupy dużych osób.

Nazwa	Typ	Opis
name	string	Nazwa zdefiniowana przez użytkownika, maksymalna długość to 128.
personGroupId	string	Identyfikator kontenera.
recognitionModel	RecognitionModel	Nazwa modelu rozpoznawania. Model rozpoznawania jest używany, gdy funkcje twarzy są wyodrębniane i skojarzone z wykrytymi identyfikatorami faceId.
userData	string	Opcjonalne dane zdefiniowane przez użytkownika. Długość nie powinna przekraczać 16 tys.

RecognitionModel

Model rozpoznawania twarzy.

Nazwa	Typ	Opis
recognition_01	string	Domyślny model rozpoznawania dla "Detect". Wszystkie te identyfikatory faceId utworzone przed marcem 2019 r. są związane z tym modelem rozpoznawania.
recognition_02	string	Model rozpoznawania wydany w marcu 2019 r.
recognition_03	string	Model rozpoznawania wydany w maju 2020 r.
recognition_04	string	Model rozpoznawania wydany w lutym 2021 r. Zaleca się użycie tego modelu rozpoznawania w celu uzyskania lepszej dokładności rozpoznawania.