Person Group Operations - Create Person Group

Service:

Azure AI Services

API Version:

v1.1-preview.1

Create eine neue Personengruppe mit der angegebenen personGroupId, dem namen, dem benutzerseitig bereitgestellten userData und recognitionModel.
Eine Personengruppe ist ein Container mit den hochgeladenen Personendaten, einschließlich Gesichtserkennungsfeatures.

Verwenden Sie nach der Erstellung "Create Person Group Person", um Personen zur Gruppe hinzuzufügen, und rufen Sie dann "Person-Gruppe trainieren" auf, um diese Gruppe für "Personengruppe identifizieren" vorzubereiten.

Es wird kein Bild gespeichert. Nur die extrahierten Gesichtsfeatures der Person und userData 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". Wenn das neueste Modell erforderlich ist, geben Sie in diesem Parameter explizit das modell an, das Sie benötigen. Neue Gesichter, die einer vorhandenen Personengruppe hinzugefügt werden, verwenden das Erkennungsmodell, das bereits der Sammlung zugeordnet ist. Vorhandene Gesichtsfeatures in einer Personengruppe können nicht auf Features aktualisiert werden, die von einer anderen Version des Erkennungsmodells extrahiert wurden.

Hinweis

• • Free-Tarif-Abonnementkontingent: 1.000 Person Gruppen. Jeder fasst bis zu 1.000 Personen.
  • S0-Tarif-Abonnementkontingent: 1.000.000 Person Gruppen. Jeder fasst bis zu 10.000 Personen.
  • Um probleme mit der Gesichtserkennung in größerem Umfang 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	ID des Containers. Regex pattern: ^[a-z0-9-_]+$

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
name	True	string	Benutzerdefinierter Name, maximale Länge ist 128.
recognitionModel		RecognitionModel	Das "recognitionModel", das dieser Gesichtsliste zugeordnet ist. Unterstützte "recognitionModel"-Werte sind "recognition_01", "recognition_02", "recognition_03" und "recognition_04". Der Standardwert ist "recognition_01". "recognition_04" wird empfohlen, da seine 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	Optionale benutzerdefinierte Daten. Die Länge sollte 16.000 nicht überschreiten.

Antworten

Name	Typ	Beschreibung
200 OK		Die Anforderung war erfolgreich.
Other Status Codes	FaceErrorResponse	Eine unerwartete Fehlerantwort. Headers x-ms-error-code: string

Sicherheit

Ocp-Apim-Subscription-Key

Der geheime Schlüssel für Ihr Azure KI-Gesichtserkennungsabonnement.

Type: apiKey
In: header

AADToken

Der Azure Active Directory OAuth2-Flow

Type: oauth2
Flow: accessCode
Authorization URL: https://api.example.com/oauth2/authorize
Token URL: https://api.example.com/oauth2/token

Scopes

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

Beispiele

Create PersonGroup

Sample Request

HTTP

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

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

Sample Response

Status code:

200

Definitionen

Name	Beschreibung
FaceError	Das Fehlerobjekt. Ausführliche Informationen zu Fehlercodes und Meldungen, die vom Gesichtserkennungsdienst zurückgegeben werden, finden Sie unter folgendem Link: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Eine Antwort, die Fehlerdetails enthält.

FaceError

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

Name	Typ	Beschreibung
code	string	Einer von einem serverdefiniertem Satz von Fehlercodes.
message	string	Eine lesbare Darstellung des Fehlers.

FaceErrorResponse

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	FaceError	Das Fehlerobjekt.