Partager via

Person Directory Operations - Create Person

  • Référence
Service:
Azure AI Services
Version d'API:
v1.2-preview.1

Crée une personne dans un répertoire de personnes. Pour ajouter un visage à cette personne, appelez l’annuaire de personnes « Ajouter un visage de personne ».

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

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

Corps de la demande

Nom Obligatoire Type Description
name True

string

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

string

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

Réponses

Nom Type Description
202 Accepted

CreatePersonResult

Un appel réussi retourne un corps de réponse vide. Le service a accepté la demande et commencera à traiter bientôt. Le client peut interroger l’état et le résultat de l’opération à l’aide de l’URL spécifiée dans l’en-tête de réponse « Operation-Location ». L’URL expire dans 48 heures.

En-têtes

  • Location: string
  • operation-Location: string
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

Create Person in PersonDirectory

Exemple de requête

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

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

Exemple de réponse

Code d’état:
202 
location: https://contoso.com/operationstatus
operation-Location: https://contoso.com/operationstatus
{
  "personId": "85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5"
}

Définitions

Nom Description
CreatePersonResult

Réponse de la personne de création.
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.

CreatePersonResult

Réponse de la personne de création.

Nom Type Description
personId

string

ID de personne de la personne.

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.