Face List Operations - Get Face List

Usługa:

Azure AI Services

Wersja interfejsu API:

v1.2-preview.1

Pobierz faceListId listy twarzy, nazwę, userData, recognitionModel i twarze na liście twarzy.

GET {endpoint}/face/{apiVersion}/facelists/{faceListId}

Z parametrami opcjonalnymi:

GET {endpoint}/face/{apiVersion}/facelists/{faceListId}?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).
faceListId	path	True	string	Prawidłowy znak to litera w małych literach lub cyfrach lub "-" lub "_", maksymalna długość to 64. Wzorzec wyrażenia regularnego: ^[a-z0-9-_]+$
returnRecognitionModel	query		boolean	Zwraca wartość "recognitionModel" lub nie. Wartość domyślna to false.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	FaceList	Pomyślne wywołanie zwraca informacje listy twarzy.
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 FaceList

Przykładowe żądanie

HTTP

GET {endpoint}/face/v1.2-preview.1/facelists/your_face_list_id?returnRecognitionModel=True

Przykładowa odpowiedź

Kod stanu:

200

{
  "name": "your_face_list_name",
  "userData": "your_user_data",
  "recognitionModel": "recognition_01",
  "faceListId": "your_face_list_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.
FaceList	Lista twarzy to lista twarzy, do 1000 twarzy.
FaceListFace	Zasób twarzy dla listy twarzy.
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.

FaceList

Lista twarzy to lista twarzy, do 1000 twarzy.

Nazwa	Typ	Opis
faceListId	string	Prawidłowy znak to litera w małych literach lub cyfrach lub "-" lub "_", maksymalna długość to 64.
name	string	Nazwa zdefiniowana przez użytkownika, maksymalna długość to 128.
persistedFaces	FaceListFace[]	Identyfikatory twarzy zarejestrowanych twarzy na liście twarzy.
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.

FaceListFace

Zasób twarzy dla listy twarzy.

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

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.