Person Directory Operations - Get Person

Serviço:

Azure AI Services

Versão da API:

v1.2-preview.1

Recupere o nome de uma pessoa e userData do Diretório de Pessoas.

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

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).
personId	path	True	string uuid	Identificação da pessoa da pessoa.

Respostas

Name	Tipo	Description
200 OK	PersonDirectoryPerson	Uma chamada bem-sucedida retorna as informações da pessoa.
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

Get Person from PeronDirectory

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:

200

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

Definições

Name	Description
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.
PersonDirectoryPerson	Recurso de pessoa para diretório de pessoas

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.

PersonDirectoryPerson

Recurso de pessoa para diretório de pessoas

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