Partilhar via


Person Group Person - Get

Recupere as informações de uma pessoa, incluindo rostos persistentes registrados, nome e userData.

GET {Endpoint}/face/v1.0/persongroups/{personGroupId}/persons/{personId}

Parâmetros do URI

Name Em Necessário Tipo Description
Endpoint
path True

string

Pontos de extremidade de Serviços Cognitivos suportados (protocolo e nome do host, por exemplo: https://westus.api.cognitive.microsoft.com).

personGroupId
path True

string

maxLength: 64
pattern: ^[a-z0-9-_]+$

Id fazendo referência a um grupo de pessoas específico.

personId
path True

string (uuid)

Id fazendo referência a uma pessoa em particular.

Cabeçalho do Pedido

Name Necessário Tipo Description
Ocp-Apim-Subscription-Key True

string

Respostas

Name 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

Pedido de amostra

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

Resposta da amostra

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

Definições

Name Description
APIError

Informações de erro retornadas pela API

Error

Corpo do erro.

Person

Objeto da pessoa.

APIError

Informações de erro retornadas pela API

Name Tipo Description
error

Error

Corpo do erro.

Error

Corpo do erro.

Name Tipo Description
code

string

message

string

Person

Objeto da pessoa.

Name Tipo Description
name

string

maxLength: 128

Nome definido pelo usuário, comprimento máximo é 128.

persistedFaceIds

string[] (uuid)

PersistedFaceIds de rostos registrados na pessoa. Esses FaceIds persistentes são retornados de Person - Add a Person Face e não expirarão.

personId

string (uuid)

PersonId da lista de rostos alvo.

userData

string

maxLength: 16384

Dados especificados pelo usuário. O comprimento não deve exceder 16KB.