Person Directory Operations - Create Person

Servicio:

Azure AI Services

Versión de la API:

v1.2-preview.1

Crea una nueva persona en un directorio de personas. Para agregar cara a esta persona, llame al directorio de personas "Agregar cara de persona".

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
apiVersion	path	True	string	Versión de API
endpoint	path	True	string uri	Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://{resource-name}.cognitiveservices.azure.com).

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
name	True	string	Nombre definido por el usuario, la longitud máxima es 128.
userData		string	Datos opcionales definidos por el usuario. La longitud no debe superar los 16 000.

Respuestas

Nombre	Tipo	Description
202 Accepted	CreatePersonResult	Una llamada correcta devuelve un cuerpo de respuesta vacío. El servicio ha aceptado la solicitud y comenzará a procesarse pronto. El cliente puede consultar el estado de la operación y el resultado mediante la dirección URL especificada en el encabezado de respuesta "Operation-Location". La dirección URL expira en 48 horas. Encabezados Location: string operation-Location: string
Other Status Codes	FaceErrorResponse	Una respuesta de error inesperada. Encabezados x-ms-error-code: string

Seguridad

Ocp-Apim-Subscription-Key

Clave secreta de la suscripción de Azure AI Face.

Tipo: apiKey
En: header

AADToken

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://api.example.com/oauth2/authorize
Dirección URL del token: https://api.example.com/oauth2/token

Ámbitos

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

Ejemplos

Create Person in PersonDirectory

Solicitud de ejemplo

HTTP

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

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

Respuesta de muestra

status code:

202

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

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

Definiciones

Nombre	Description
CreatePersonResult	Respuesta de la persona de creación.
FaceError	Objeto de error. Para obtener detalles completos sobre los códigos de error y los mensajes devueltos por face Service, consulte el vínculo siguiente: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Respuesta que contiene los detalles del error.

CreatePersonResult

Respuesta de la persona de creación.

Nombre	Tipo	Description
personId	string	Id. de persona de la persona.

FaceError

Objeto de error. Para obtener detalles completos sobre los códigos de error y los mensajes devueltos por face Service, consulte el vínculo siguiente: https://aka.ms/face-error-codes-and-messages.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
message	string	Representación legible del error.

FaceErrorResponse

Respuesta que contiene los detalles del error.

Nombre	Tipo	Description
error	FaceError	Objeto de error.