Face List Operations - Create Face List

Usługa:

Azure AI Services

Wersja interfejsu API:

v1.2

Utwórz pustą listę twarzy z określonym przez użytkownika identyfikatorem faceListId, nazwą, opcjonalnym elementem userData i recognitionModel.
Maksymalnie 64 listy twarzy są dozwolone w jednej subskrypcji.

Lista twarzy to lista twarzy, do 1000 twarzy i używana przez funkcję "Znajdź podobne z listy twarzy".

Po utworzeniu użytkownik powinien użyć polecenia "Dodaj twarz na liście twarzy", aby zaimportować twarze. Nie będzie przechowywany żaden obraz. Tylko wyodrębnione funkcje twarzy będą przechowywane na serwerze do momentu wywołania "Usuń listę twarzy".

Opcja "Znajdź podobne" jest używana w scenariuszu, na przykład w przypadku znajdowania twarzy podobnych do osobistości, podobnego filtrowania twarzy lub jako jasnej identyfikacji twarzy. Ale jeśli rzeczywistym użyciem jest zidentyfikowanie osoby, użyj grupy osób / grupy osób dużych osób i "Zidentyfikuj".

Jeśli liczba twarzy jest duża, należy wziąć pod uwagę dużą listę twarzy. Może obsługiwać maksymalnie 1000 000 twarzy.

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

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 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.

Treść żądania

Nazwa	Wymagane	Typ	Opis
name	True	string minLength: 1 maxLength: 128	Nazwa zdefiniowana przez użytkownika, maksymalna długość to 128.
recognitionModel		RecognitionModel	Element "recognitionModel" skojarzony z tą listą twarzy. Obsługiwane wartości "recognitionModel" obejmują wartości "recognition_01", "recognition_02, "recognition_03" i "recognition_04". Wartość domyślna to "recognition_01". Zaleca się "recognition_04", ponieważ jego dokładność jest lepsza na twarzach w maskach w porównaniu z "recognition_03", a jego ogólna dokładność jest lepsza w porównaniu z "recognition_01" i "recognition_02".
userData		string maxLength: 16384	Opcjonalne dane zdefiniowane przez użytkownika. Długość nie powinna przekraczać 16 tys.

Odpowiedzi

Nazwa	Typ	Opis
200 OK		Żądanie zakończyło się pomyślnie.
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

Create FaceList

Przykładowe żądanie

HTTP

PUT {endpoint}/face/v1.2/facelists/your_face_list_id

{
  "name": "your_face_list_name",
  "userData": "your_user_data",
  "recognitionModel": "recognition_01"
}

Przykładowa odpowiedź

Kod stanu:

200

Definicje

Nazwa	Opis
CreateCollectionRequest	Model tworzenia kolekcji 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.
FaceErrorResponse	Odpowiedź zawierająca szczegóły błędu.
RecognitionModel	Model rozpoznawania twarzy.

CreateCollectionRequest

Objekt

Model tworzenia kolekcji twarzy.

Nazwa	Typ	Domyślna wartość	Opis
name	string minLength: 1 maxLength: 128		Nazwa zdefiniowana przez użytkownika, maksymalna długość to 128.
recognitionModel	RecognitionModel	recognition_01	Element "recognitionModel" skojarzony z tą listą twarzy. Obsługiwane wartości "recognitionModel" obejmują wartości "recognition_01", "recognition_02, "recognition_03" i "recognition_04". Wartość domyślna to "recognition_01". Zaleca się "recognition_04", ponieważ jego dokładność jest lepsza na twarzach w maskach w porównaniu z "recognition_03", a jego ogólna dokładność jest lepsza w porównaniu z "recognition_01" i "recognition_02".
userData	string maxLength: 16384		Opcjonalne dane zdefiniowane przez użytkownika. Długość nie powinna przekraczać 16 tys.

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.

RecognitionModel

Wyliczanie

Model rozpoznawania twarzy.

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