Person Group Operations - Get Large Person Group Person

Serviço:

Azure AI Services

Versão da API:

v1.2-preview.1

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

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

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).
largePersonGroupId	path	True	string	ID do contêiner. Padrão Regex: ^[a-z0-9-_]+$
personId	path	True	string uuid	ID da pessoa.

Respostas

Nome	Tipo	Description
200 OK	LargePersonGroupPerson	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 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

Get Person from LargePersonGroup

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:

200

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

Definições

Nome	Description
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.
LargePersonGroupPerson	A pessoa em um grupo de pessoas grandes especificado. Para adicionar rosto a essa pessoa, chame "Adicionar rosto de pessoa de grupo de pessoas grandes".

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.

LargePersonGroupPerson

A pessoa em um grupo de pessoas grandes especificado. Para adicionar rosto a essa pessoa, chame "Adicionar rosto de pessoa de grupo de pessoas grandes".

Nome	Tipo	Description
name	string	Nome definido pelo usuário, o comprimento máximo é 128.
persistedFaceIds	string[]	IDs de rosto de rostos registrados na pessoa.
personId	string	ID da pessoa.
userData	string	Dados definidos pelo usuário opcionais. O comprimento não deve exceder 16 K.