Person Directory Operations - Create Dynamic Person Group With Person

Dienst:

Azure AI Services

API-Version:

v1.1-preview.1

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

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

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

"recognitionModel" muss nicht mit dynamic Person Gruppen angegeben werden. Dynamische Gruppen sind Verweise auf das Personenverzeichnis "Create Person" und funktionieren daher mit den meisten "recognitionModels". Die bei "Identifizieren" bereitgestellten FaceIds 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. RegEx-Muster: ^[a-z0-9-_]+$
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
addPersonIds	True	string[]	Array von PersonIds, die vom Personenverzeichnis "Create Person" erstellt wurden, um hinzugefügt zu werden.
name	True	string	Benutzerdefinierter Name, maximale Länge ist 128.
userData		string	Optionale benutzerdefinierte Daten. Die Länge sollte 16.000 nicht überschreiten.

Antworten

Name	Typ	Beschreibung
202 Accepted		Ein erfolgreicher Aufruf gibt einen leeren Antworttext zurück. Der Dienst hat die Anforderung akzeptiert und wird in Kürze mit der Verarbeitung beginnen. Der Client kann den Vorgang status und Ergebnis mithilfe der URL abfragen, die im Antwortheader "Operation-Location" angegeben ist. Die URL ist 48 Stunden lang gültig. Die URL stellt die status bereit, wann das Personenverzeichnis "Get Dynamic Person Group References" die in dieser Anforderung vorgenommenen Änderungen zurückgibt. Header operation-Location: string
Other Status Codes	FaceErrorResponse	Eine 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-Flow

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.1-preview.1/dynamicpersongroups/your_dynamic_person_group_id

{
  "name": "your_dynamic_person_group_name",
  "userData": "your_user_data",
  "addPersonIds": [
    "85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5"
  ]
}

Beispiel für eine Antwort

Statuscode:

202

operation-Location: https://contoso.com/operationstatus

Definitionen

Name	Beschreibung
FaceError	Das Fehlerobjekt. Ausführliche Informationen zu Fehlercodes und Nachrichten, 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 Nachrichten, 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 der vom Server definierten Fehlercodes.
message	string	Eine für Menschen lesbare Darstellung des Fehlers.

FaceErrorResponse

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	FaceError	Das Fehlerobjekt.