Person Directory Operations - Get Person

Dienst:

Azure AI Services

API-Version:

v1.2-preview.1

Dient zum Abrufen des Namens und des Benutzers aus dem Personenverzeichnis.

GET {endpoint}/face/{apiVersion}/persons/{personId}

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).
personId	path	True	string uuid	Personen-ID der Person.

Antworten

Name	Typ	Beschreibung
200 OK	PersonDirectoryPerson	Ein erfolgreicher Anruf gibt die Informationen der Person zurück.
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

Get Person from PeronDirectory

Beispielanforderung

HTTP

GET {endpoint}/face/v1.2-preview.1/persons/85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5

Beispiel für eine Antwort

Statuscode:

200

{
  "personId": "85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5",
  "name": "your_person_name",
  "userData": "your_user_data"
}

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.
PersonDirectoryPerson	Person-Ressource für das Personenverzeichnis

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.

PersonDirectoryPerson

Person-Ressource für das Personenverzeichnis

Name	Typ	Beschreibung
name	string	Benutzerdefinierter Name, maximale Länge beträgt 128.
personId	string	Personen-ID der Person.
userData	string	Optionale benutzerdefinierte Daten. Die Länge darf 16 KB nicht überschreiten.