Person Directory Operations - Create Dynamic Person Group

Dienst:

Azure AI Services

API-Version:

v1.2-preview.1

Erstellt eine neue dynamische Personengruppe mit der angegebenen dynamicPersonGroupId, dem Namen und dem vom Benutzer bereitgestellten UserData.
Eine dynamische Personengruppe ist ein Container, der auf das Personenverzeichnis "Person erstellen" verweist. Verwenden Sie nach der Erstellung das Personenverzeichnis "Dynamische Personengruppe aktualisieren", um Personen zur Gruppe dynamischer Personen hinzuzufügen/daraus zu entfernen.

Dynamische Personengruppe und Benutzerdaten werden auf dem Server gespeichert, bis das Personenverzeichnis "Dynamische Personengruppe löschen" aufgerufen wird. Verwenden Sie "Aus dynamischer Personengruppe identifizieren" mit dem Parameter "dynamicPersonGroupId", um personen zu identifizieren.

Es wird kein Bild gespeichert. Nur die extrahierten Gesichtsfeatures und userData der Person werden auf dem Server gespeichert, bis das Personenverzeichnis "Person löschen" oder "Persönliches Gesicht löschen" aufgerufen wird.

"recognitionModel" muss nicht mit dynamischen Personengruppen angegeben werden. Dynamische Personengruppen sind Verweise auf das Personenverzeichnis "Person erstellen" und funktionieren daher mit den meisten 'recognitionModels'. Die faceId, die während "Identifizieren" bereitgestellt wird, bestimmen das verwendete "recognitionModel".

PUT {endpoint}/face/{apiVersion}/dynamicpersongroups/{dynamicPersonGroupId}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
apiVersion	path	True	string	API-Version
dynamicPersonGroupId	path	True	string	ID der dynamischen Personengruppe.
endpoint	path	True	string (uri)	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. https://{resource-name}.cognitiveservices.azure.com).

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
name	True	string	Benutzerdefinierter Name, maximale Länge beträgt 128.
userData		string	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 DynamicPersonGroup

Beispielanforderung

HTTP

PUT {endpoint}/face/v1.2-preview.1/dynamicpersongroups/your_dynamic_person_group_id

{
  "name": "your_dynamic_person_group_name",
  "userData": "your_user_data"
}

Beispiel für eine Antwort

Statuscode:

200

Definitionen

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

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.