Person Directory Operations - Get Persons

Serviço:

Azure AI Services

Versão da API:

v1.2-preview.1

Liste as informações de todas as pessoas no Diretório de Pessoas, incluindo personId, name e userData.
As pessoas são armazenadas em ordem alfabética de personId criada no Diretório de Pessoas "Criar Pessoa".

• • O parâmetro "start" (cadeia de caracteres, opcional) especifica um valor de ID do qual as entradas retornadas terão IDs maiores com base na comparação de cadeia de caracteres. A configuração "start" para um valor vazio indica que as entradas devem ser retornadas a partir do primeiro item.
  • O parâmetro "top" (int, opcional) determina o número máximo de entradas a serem retornadas, com um limite de até 1000 entradas por chamada. Para recuperar entradas adicionais além desse limite, especifique "start" com a personId da última entrada retornada na chamada atual.

Ponta

• Por exemplo, há um total de 5 itens com suas IDs: "itemId1", ..., "itemId5".
  • "start=&top=" retornará todos os 5 itens.
  • "start=&top=2" retornará "itemId1", "itemId2".
  • "start=itemId2&top=3" retornará "itemId3", "itemId4", "itemId5".

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

Com parâmetros opcionais:

GET {endpoint}/face/{apiVersion}/persons?start={start}&top={top}

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).
start	query		string	Listar recursos maiores que o "start". Ele não contém mais de 64 caracteres. O padrão está vazio.
top	query		integer int32	O número de itens a serem listados, variando em [1,1000]. O padrão é 1000.

Respostas

Nome	Tipo	Description
200 OK	PersonDirectoryPerson[]	Uma chamada bem-sucedida retorna uma matriz de Pessoas do Diretório de Pessoas contidas no Grupo de Pessoas Dinâmicas.
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 Persons from PersonDirectory

Solicitação de exemplo

HTTP

GET {endpoint}/face/v1.2-preview.1/persons?start=00000000-0000-0000-0000-000000000000&top=20

Resposta de exemplo

Código de status:

200

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

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

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.

PersonDirectoryPerson

Recurso de pessoa para diretório de pessoa

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