Person Directory Operations - Create Person

Serviço:

Azure AI Services

Versão da API:

v1.2-preview.1

Cria uma nova pessoa em um Diretório de Pessoas. Para adicionar rosto a essa pessoa, ligue para o Diretório de Pessoas "Adicionar Rosto de Pessoa".

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
apiVersion	path	True	string	Versão da API
endpoint	path	True	string uri	Pontos de extremidade de Serviços Cognitivos suportados (protocolo e nome do host, por exemplo: https://{resource-name}.cognitiveservices.azure.com).

Corpo do Pedido

Name	Necessário	Tipo	Description
name	True	string	Nome definido pelo usuário, comprimento máximo é 128.
userData		string	Dados opcionais definidos pelo usuário. O comprimento não deve exceder 16K.

Respostas

Name	Tipo	Description
202 Accepted	CreatePersonResult	Uma chamada bem-sucedida retorna um corpo de resposta vazio. O serviço aceitou o pedido e começará a processar em breve. O cliente pode consultar o status e o resultado da operação usando a URL especificada no cabeçalho de resposta 'Operation-Location'. O URL expira em 48 horas. Cabeçalhos Location: string operation-Location: string
Other Status Codes	FaceErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Segurança

Ocp-Apim-Subscription-Key

A chave secreta para sua assinatura do Azure AI Face.

Tipo: apiKey
Em: header

AADToken

O fluxo OAuth2 do Azure Ative Directory

Tipo: oauth2
Fluxo: accessCode
URL de Autorização: https://api.example.com/oauth2/authorize
Token URL: https://api.example.com/oauth2/token

Âmbitos

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

Exemplos

Create Person in PersonDirectory

Pedido de amostra

HTTP

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

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

Resposta da amostra

Código de estado:

202

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

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

Definições

Name	Description
CreatePersonResult	Resposta de criar pessoa.
FaceError	O objeto de erro. Para obter detalhes abrangentes sobre códigos de erro e mensagens retornadas pelo Face Service, consulte o seguinte link: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Uma resposta contendo detalhes do erro.

CreatePersonResult

Resposta de criar pessoa.

Name	Tipo	Description
personId	string	Identificação da pessoa da pessoa.

FaceError

O objeto de erro. Para obter detalhes abrangentes sobre códigos de erro e mensagens retornadas pelo Face Service, consulte o seguinte link: https://aka.ms/face-error-codes-and-messages.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
message	string	Uma representação legível por humanos do erro.

FaceErrorResponse

Uma resposta contendo detalhes do erro.

Name	Tipo	Description
error	FaceError	O objeto de erro.