Person Group Operations - Create Person Group

Usługa:

Azure AI Services

Wersja interfejsu API:

v1.2-preview.1

Utwórz nową grupę osób z określonym identyfikatorem personGroupId, nazwą, elementem userData i recognitionModel.
Grupa osób to kontener przechowujący przekazane dane osoby, w tym funkcje rozpoznawania twarzy.

Po utworzeniu użyj polecenia "Utwórz osobę grupy osób", aby dodać osoby do grupy, a następnie wywołaj metodę "Train Person Group", aby przygotować tę grupę do "Identyfikowanie z grupy osób".

Nie będzie przechowywany żaden obraz. Tylko wyodrębnione funkcje twarzy i userData osoby będą przechowywane na serwerze, dopóki nie zostanie wywołana opcja "Usuń osobę grupę osób" lub "Usuń grupę osób".

Należy określić element "recognitionModel", aby skojarzyć z tą grupą osób. Wartość domyślna "recognitionModel" to "recognition_01", jeśli wymagany jest najnowszy model, jawnie określ model, którego potrzebujesz w tym parametrze. Nowe twarze dodane do istniejącej grupy osób będą używać modelu rozpoznawania, który jest już skojarzony z kolekcją. Nie można zaktualizować istniejących funkcji twarzy w grupie osób do funkcji wyodrębnionych przez inny model rozpoznawania.

Nuta

• • Limit przydziału subskrypcji w warstwie Bezpłatna: 1000 grup osób. Każdy posiada do 1000 osób.
  • Limit przydziału subskrypcji warstwy S0: 1000 000 grup osób. Każdy posiada do 10 000 osób.
  • aby rozwiązać problem z identyfikacją twarzy na większą skalę, rozważ użycie grupy dużych osób.

PUT {endpoint}/face/{apiVersion}/persongroups/{personGroupId}

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).
personGroupId	path	True	string	Identyfikator kontenera. Wzorzec wyrażenia regularnego: ^[a-z0-9-_]+$

Treść żądania

Nazwa	Wymagane	Typ	Opis
name	True	string	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	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 PersonGroup

Przykładowe żądanie

HTTP

PUT {endpoint}/face/v1.2-preview.1/persongroups/your_person_group_id

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

Przykładowa odpowiedź

Kod stanu:

200

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.

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.