Large Person Group Person - Get

Serviço:

Azure AI Services

Versão da API:

1.0

Recupere o nome e o userData de uma pessoa e as faceIds persistentes que representam o recurso de detecção facial da pessoa registrada.

GET {Endpoint}/face/v1.0/largepersongroups/{largePersonGroupId}/persons/{personId}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
Endpoint	path	True	string	Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://westus.api.cognitive.microsoft.com).
largePersonGroupId	path	True	string maxLength: 64 pattern: ^[a-z0-9-_]+$	Id referenciando um grupo de pessoas grandes específico.
personId	path	True	string (uuid)	ID referenciando uma pessoa específica.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Respostas

Nome	Tipo	Description
200 OK	Person	Uma chamada bem-sucedida retorna as informações da pessoa.
Other Status Codes	APIError	Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

Get person example

Solicitação de exemplo

HTTP

GET {Endpoint}/face/v1.0/largepersongroups/abc/persons/25985303-c537-4467-b41d-bdb45cd95ca1

Resposta de exemplo

Código de status:

200

{
  "personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
  "persistedFaceIds": [
    "015839fb-fbd9-4f79-ace9-7675fc2f1dd9",
    "fce92aed-d578-4d2e-8114-068f8af4492e",
    "b64d5e15-8257-4af2-b20a-5a750f8940e7"
  ],
  "name": "person-name",
  "userData": "User-provided data attached to the person."
}

Definições

Nome	Description
APIError	Informações de erro retornadas pela API
Error	Corpo do erro.
Person	Objeto Person.

APIError

Objeto

Informações de erro retornadas pela API

Nome	Tipo	Description
error	Error	Corpo do erro.

Error

Objeto

Corpo do erro.

Nome	Tipo	Description
code	string
message	string

Person

Objeto

Objeto Person.

Nome	Tipo	Description
name	string maxLength: 128	Nome definido pelo usuário, o comprimento máximo é 128.
persistedFaceIds	string[] (uuid)	PersistedFaceIds de rostos registrados na pessoa. Esses persistedFaceIds são retornados de Person – Adicionar um Rosto de Pessoa e não expirarão.
personId	string (uuid)	PersonId da lista de rostos de destino.
userData	string maxLength: 16384	Dados especificados pelo usuário. O comprimento não deve exceder 16 KB.