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, chame o Diretório de Pessoas de "Adicionar Rosto de Pessoa".

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

Parâmetros de URI

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

Corpo da solicitação

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

Respostas

Nome	Tipo	Description
202 Accepted	CreatePersonResult	Uma chamada bem-sucedida retorna um corpo de resposta vazio. O serviço aceitou a solicitação e começará a processar em breve. O cliente pode consultar o status da operação e resultar usando a URL especificada no cabeçalho de resposta 'Operation-Location'. A 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 Active Directory

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

Escopos

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

Exemplos

Create Person in PersonDirectory

Solicitação de exemplo

HTTP

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

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

Resposta de exemplo

Código de status:

202

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

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

Definições

Nome	Description
CreatePersonResult	Resposta da pessoa de criação.
FaceError	O objeto de erro. Para obter detalhes abrangentes sobre códigos de erro e mensagens retornadas pelo Serviço de Detecção Facial, consulte o seguinte link: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Uma resposta que contém detalhes do erro.

CreatePersonResult

Resposta da pessoa de criação.

Nome	Tipo	Description
personId	string	ID da pessoa.

FaceError

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

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

FaceErrorResponse

Uma resposta que contém detalhes do erro.

Nome	Tipo	Description
error	FaceError	O objeto de erro.