Person Group Operations - Create Person Group

Dienst:

Azure AI Services

API-Version:

v1.2

Erstellen Sie eine neue Personengruppe mit der angegebenen personGroupId, dem Namen, dem vom Benutzer bereitgestellten UserData und recognitionModel.
Eine Personengruppe ist ein Container mit den hochgeladenen Personendaten, einschließlich Gesichtserkennungsfeatures.

Verwenden Sie nach der Erstellung "Persongruppenperson erstellen", um Personen zur Gruppe hinzuzufügen, und rufen Sie dann "Person-Gruppe trainieren" auf, um diese Gruppe für "Identifizieren von Personengruppe" vorzubereiten.

Es wird kein Bild gespeichert. Nur die extrahierten Gesichtsfeatures und UserData der Person werden auf dem Server gespeichert, bis "Person Group Person löschen" oder "Personengruppe löschen" aufgerufen wird.

"recognitionModel" sollte angegeben werden, um dieser Personengruppe zuzuordnen. Der Standardwert für "recognitionModel" ist "recognition_01", falls das neueste Modell erforderlich ist, geben Sie bitte explizit das modell an, das Sie in diesem Parameter benötigen. Neue Gesichter, die einer vorhandenen Personengruppe hinzugefügt werden, verwenden das Erkennungsmodell, das der Auflistung bereits zugeordnet ist. Vorhandene Gesichtsfeatures in einer Personengruppe können nicht auf Features aktualisiert werden, die von einer anderen Version des Erkennungsmodells extrahiert wurden.

Anmerkung

• • Kontingent für kostenlose Abonnements: 1.000 Personengruppen. Jede hält bis zu 1.000 Personen.
  • S0-Stufen-Abonnementkontingent: 1.000.000 Personengruppen. Jede hält bis zu 10.000 Personen.
  • um ein größeres Gesichtsidentifikationsproblem zu behandeln, sollten Sie die Verwendung einer großen Personengruppe in Betracht ziehen.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
apiVersion	path	True	string	API-Version
endpoint	path	True	string (uri)	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. https://{resource-name}.cognitiveservices.azure.com).
personGroupId	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-z0-9-_]+$	ID des Containers.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
name	True	string minLength: 1 maxLength: 128	Benutzerdefinierter Name, maximale Länge beträgt 128.
recognitionModel		RecognitionModel	Das "recognitionModel", das dieser Gesichtsliste zugeordnet ist. Zu den unterstützten "recognitionModel"-Werten gehören "recognition_01", "recognition_02", "recognition_03" und "recognition_04". Der Standardwert ist "recognition_01". "recognition_04" wird empfohlen, da die Genauigkeit bei Gesichtern mit Masken im Vergleich zu "recognition_03" verbessert wird und die Gesamtgenauigkeit im Vergleich zu "recognition_01" und "recognition_02" verbessert wird.
userData		string maxLength: 16384	Optionale benutzerdefinierte Daten. Die Länge darf 16 KB nicht überschreiten.

Antworten

Name	Typ	Beschreibung
200 OK		Die Anforderung ist erfolgreich.
Other Status Codes	FaceErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Sicherheit

Ocp-Apim-Subscription-Key

Der geheime Schlüssel für Ihr Azure AI Face-Abonnement.

Typ: apiKey
In: header

AADToken

Der Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://api.example.com/oauth2/authorize
Token-URL: https://api.example.com/oauth2/token

Bereiche

Name	Beschreibung
https://cognitiveservices.azure.com/.default

Beispiele

Create PersonGroup

Beispielanforderung

HTTP

PUT {endpoint}/face/v1.2/persongroups/your_person_group_id

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

Beispiel für eine Antwort

Statuscode:

200

Definitionen

Name	Beschreibung
CreateCollectionRequest	Modell zum Erstellen der Gesichtssammlung.
FaceError	Das Fehlerobjekt. Ausführliche Informationen zu Fehlercodes und Nachrichten, die vom Face Service zurückgegeben werden, finden Sie unter folgendem Link: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Eine Antwort, die Fehlerdetails enthält.
RecognitionModel	Das Erkennungsmodell für das Gesicht.

CreateCollectionRequest

Objekt

Modell zum Erstellen der Gesichtssammlung.

Name	Typ	Standardwert	Beschreibung
name	string minLength: 1 maxLength: 128		Benutzerdefinierter Name, maximale Länge beträgt 128.
recognitionModel	RecognitionModel	recognition_01	Das "recognitionModel", das dieser Gesichtsliste zugeordnet ist. Zu den unterstützten "recognitionModel"-Werten gehören "recognition_01", "recognition_02", "recognition_03" und "recognition_04". Der Standardwert ist "recognition_01". "recognition_04" wird empfohlen, da die Genauigkeit bei Gesichtern mit Masken im Vergleich zu "recognition_03" verbessert wird und die Gesamtgenauigkeit im Vergleich zu "recognition_01" und "recognition_02" verbessert wird.
userData	string maxLength: 16384		Optionale benutzerdefinierte Daten. Die Länge darf 16 KB nicht überschreiten.

FaceError

Objekt

Das Fehlerobjekt. Ausführliche Informationen zu Fehlercodes und Nachrichten, die vom Face Service zurückgegeben werden, finden Sie unter folgendem Link: https://aka.ms/face-error-codes-and-messages.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
message	string	Eine lesbare Darstellung des Fehlers.

FaceErrorResponse

Objekt

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	FaceError	Das Fehlerobjekt.

RecognitionModel

Enumeration

Das Erkennungsmodell für das Gesicht.

Wert	Beschreibung
recognition_01	Das Standarderkennungsmodell für "Erkennen". Alle faceIds, die vor dem März 2019 erstellt wurden, sind mit diesem Erkennungsmodell verbunden.
recognition_02	Erkennungsmodell, das im März 2019 veröffentlicht wurde.
recognition_03	Erkennungsmodell, das im Mai 2020 veröffentlicht wurde.
recognition_04	Erkennungsmodell, das im Februar 2021 veröffentlicht wurde. Es wird empfohlen, dieses Erkennungsmodell für eine bessere Erkennungsgenauigkeit zu verwenden.