Person Directory Operations - Create Person

Dienst:

Azure AI Services

API-Version:

v1.1-preview.1

Erstellt eine neue Person in einem Personenverzeichnis. Um dieser Person ein Gesicht hinzuzufügen, rufen Sie das Personenverzeichnis "Person Face 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 ist 128.
userData		string	Optionale benutzerdefinierte Daten. Die Länge sollte 16.000 nicht überschreiten.

Antworten

Name	Typ	Beschreibung
202 Accepted	CreatePersonResult	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 das Ergebnis mithilfe der url abfragen, die im Antwortheader "Operation-Location" angegeben ist. Die URL ist 48 Stunden lang gültig. Header Location: string 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 KI-Gesichtserkennungsabonnement.

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 Person in PersonDirectory

Beispielanforderung

HTTP

POST {endpoint}/face/v1.1-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 der Erstellen-Person.
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.

CreatePersonResult

Antwort der Erstellen-Person.

Name	Typ	Beschreibung
personId	string	Personen-ID der Person.

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.