Person Group Operations - Get Large Person Group Person

Usługa:

Azure AI Services

Wersja interfejsu API:

v1.2-preview.1

Pobierz imię i nazwisko osoby i wartość userData oraz utrwalone identyfikatory faceId reprezentujące funkcje twarzy zarejestrowanej osoby.

GET {endpoint}/face/{apiVersion}/largepersongroups/{largePersonGroupId}/persons/{personId}

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).
largePersonGroupId	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-z0-9-_]+$	Identyfikator kontenera.
personId	path	True	string (uuid)	Identyfikator osoby.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	LargePersonGroupPerson	Pomyślne wywołanie zwraca informacje o osobie.
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 Person from LargePersonGroup

Przykładowe żądanie

HTTP

GET {endpoint}/face/v1.2-preview.1/largepersongroups/your_large_person_group_id/persons/25985303-c537-4467-b41d-bdb45cd95ca1

Przykładowa odpowiedź

Kod stanu:

200

{
  "personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
  "name": "your_large_person_group_person_name",
  "userData": "your_user_data",
  "persistedFaceIds": [
    "43897a75-8d6f-42cf-885e-74832febb055"
  ]
}

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.
LargePersonGroupPerson	Osoba w określonej grupie dużej osoby. Aby dodać twarz do tej osoby, zadzwoń do "Dodaj twarz grupy dużej osoby".

FaceError

Objekt

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

Objekt

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

Nazwa	Typ	Opis
error	FaceError	Obiekt błędu.

LargePersonGroupPerson

Objekt

Osoba w określonej grupie dużej osoby. Aby dodać twarz do tej osoby, zadzwoń do "Dodaj twarz grupy dużej osoby".

Nazwa	Typ	Opis
name	string minLength: 1 maxLength: 128	Nazwa zdefiniowana przez użytkownika, maksymalna długość to 128.
persistedFaceIds	string[] (uuid)	Identyfikatory twarzy zarejestrowanych twarzy w danej osobie.
personId	string (uuid)	Identyfikator osoby.
userData	string maxLength: 16384	Opcjonalne dane zdefiniowane przez użytkownika. Długość nie powinna przekraczać 16 tys.