Partilhar via


Person Group Operations - Get Person Group Person

Recupere o nome e os dados de usuário de uma pessoa e os faceIds persistentes que representam o(s) recurso(s) de rosto da pessoa registrada(s).

GET {endpoint}/face/{apiVersion}/persongroups/{personGroupId}/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).

personGroupId
path True

string

ID do contentor.

Padrão Regex: ^[a-z0-9-_]+$

personId
path True

string

uuid

ID da pessoa.

Respostas

Name Tipo Description
200 OK

PersonGroupPerson

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 PersonGroup

Pedido de amostra

GET {endpoint}/face/v1.2-preview.1/persongroups/your_person_group_id/persons/25985303-c537-4467-b41d-bdb45cd95ca1

Resposta da amostra

{
  "personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
  "name": "your_person_group_person_name",
  "userData": "your_user_data",
  "persistedFaceIds": [
    "43897a75-8d6f-42cf-885e-74832febb055"
  ]
}

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.

PersonGroupPerson

A pessoa em um grupo de pessoas especificado. Para adicionar rosto a essa pessoa, ligue para "Adicionar rosto de pessoa de grupo de pessoa grande".

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.

PersonGroupPerson

A pessoa em um grupo de pessoas especificado. Para adicionar rosto a essa pessoa, ligue para "Adicionar rosto de pessoa de grupo de pessoa grande".

Name Tipo Description
name

string

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

persistedFaceIds

string[]

Identificações faciais de rostos registados na pessoa.

personId

string

ID da pessoa.

userData

string

Dados opcionais definidos pelo usuário. O comprimento não deve exceder 16K.