Face List Operations - Get Large Face List Face

Usługa:

Azure AI Services

Wersja interfejsu API:

v1.2-preview.1

Pobierz utrwalone twarze na dużej liście twarzy według largeFaceListId i utrwaloneFaceId.

GET {endpoint}/face/{apiVersion}/largefacelists/{largeFaceListId}/persistedfaces/{persistedFaceId}

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).
largeFaceListId	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-z0-9-_]+$	Prawidłowy znak to litera w małych literach lub cyfrach lub "-" lub "_", maksymalna długość to 64.
persistedFaceId	path	True	string (uuid)	Face ID twarzy.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	LargeFaceListFace	Pomyślne wywołanie zwraca informacje o utrwalonej twarzy docelowej (utrwaloneFaceId 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 Face from LargeFaceList

Przykładowe żądanie

HTTP

GET {endpoint}/face/v1.2-preview.1/largefacelists/your_large_face_list_id/persistedfaces/43897a75-8d6f-42cf-885e-74832febb055

Przykładowa odpowiedź

Kod stanu:

200

{
  "persistedFaceId": "43897a75-8d6f-42cf-885e-74832febb055",
  "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.
LargeFaceListFace	Zasób twarzy dla dużej listy twarzy.

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.

LargeFaceListFace

Objekt

Zasób twarzy dla dużej listy twarzy.

Nazwa	Typ	Opis
persistedFaceId	string (uuid)	Face ID twarzy.
userData	string maxLength: 1024	Dane dostarczone przez użytkownika dołączone do twarzy. Limit długości to 1K.