Person Directory Operations - Create Person

Dienst:

Azure AI Services

API-Version:

v1.2-preview.1

Erstellt eine neue Person in einem Personenverzeichnis. Um dieser Person Gesicht hinzuzufügen, rufen Sie bitte "Person-Verzeichnis hinzufügen" auf.

POST {endpoint}/face/{apiVersion}/persons

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).

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
202 Accepted	CreatePersonResult	Ein erfolgreicher Aufruf gibt einen leeren Antworttext zurück. Der Dienst hat die Anforderung angenommen und wird in Kürze mit der Verarbeitung beginnen. Der Client kann den Vorgangsstatus und das Ergebnis mithilfe der im Antwortheader "Operation-Location" angegebenen URL abfragen. Die URL läuft in 48 Stunden ab. Header Location: string operation-Location: string
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 Person in PersonDirectory

Beispielanforderung

HTTP

POST {endpoint}/face/v1.2-preview.1/persons

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

Beispiel für eine Antwort

Statuscode:

202

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

{
  "personId": "85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5"
}

Definitionen

Name	Beschreibung
CreatePersonResult	Antwort des Erstellens einer Person.
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.

CreatePersonResult

Antwort des Erstellens einer Person.

Name	Typ	Beschreibung
personId	string	Personen-ID der Person.

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.

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

FaceErrorResponse

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	FaceError	Das Fehlerobjekt.