Partager via


Person Directory Operations - Get Person

Récupérez le nom d’une personne et userData à partir de Person Directory.

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

Paramètres URI

Nom Dans Obligatoire Type Description
apiVersion
path True

string

Version de l’API

endpoint
path True

string

uri

Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://{nom-ressource}.cognitiveservices.azure.com).

personId
path True

string

uuid

ID de personne de la personne.

Réponses

Nom Type Description
200 OK

PersonDirectoryPerson

Un appel réussi retourne les informations de la personne.

Other Status Codes

FaceErrorResponse

Réponse d’erreur inattendue.

En-têtes

x-ms-error-code: string

Sécurité

Ocp-Apim-Subscription-Key

Clé secrète de votre abonnement Azure AI Face.

Type: apiKey
Dans: header

AADToken

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: accessCode
URL d’autorisation: https://api.example.com/oauth2/authorize
URL du jeton: https://api.example.com/oauth2/token

Étendues

Nom Description
https://cognitiveservices.azure.com/.default

Exemples

Get Person from PeronDirectory

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
FaceError

Objet d’erreur. Pour plus d’informations sur les codes d’erreur et les messages retournés par le service Visage, reportez-vous au lien suivant : https://aka.ms/face-error-codes-and-messages.

FaceErrorResponse

Réponse contenant les détails de l’erreur.

PersonDirectoryPerson

Ressource de personne pour l’annuaire de personnes

FaceError

Objet d’erreur. Pour plus d’informations sur les codes d’erreur et les messages retournés par le service Visage, reportez-vous au lien suivant : https://aka.ms/face-error-codes-and-messages.

Nom Type Description
code

string

Un ensemble de codes d’erreur définis par le serveur.

message

string

Représentation lisible par l’homme de l’erreur.

FaceErrorResponse

Réponse contenant les détails de l’erreur.

Nom Type Description
error

FaceError

Objet d’erreur.

PersonDirectoryPerson

Ressource de personne pour l’annuaire de personnes

Nom Type Description
name

string

Nom défini par l’utilisateur, la longueur maximale est 128.

personId

string

ID de personne de la personne.

userData

string

Données définies par l’utilisateur facultatives. La longueur ne doit pas dépasser 16 Ko.