Person Directory - Get Persons

Serviço:
Azure AI Services
Versão da API:
1.0-preview

Recuperar lista de informações pessoais no diretório pessoal.

GET {Endpoint}/face/v1.0-preview/persons
Com parâmetros opcionais: 
GET {Endpoint}/face/v1.0-preview/persons?start={start}&top={top}

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).
start
 query

string (uuid)

Listar pessoas do menor personId maior que o "start". Não contém mais de 64 caracteres. O padrão está vazio.
top
 query

string

O número de pessoas a listar, variando em [1, 1000]. O padrão é 1000.

Cabeçalho do Pedido

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

string

Respostas

Name Tipo Description
200 OK

EnrollmentResponse[]

Sucesso
Other Status Codes

Error

Entidade de resposta que acompanha respostas não bem-sucedidas contendo detalhes adicionais sobre o erro.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

Get person directory persons example

Pedido de amostra

GET {Endpoint}/face/v1.0-preview/persons

Resposta da amostra

Código de estado:
200 
[
  {
    "personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
    "name": "Ryan",
    "userData": "User-provided data attached to the person."
  },
  {
    "personId": "2ae4935b-9659-44c3-977f-61fac20d0538",
    "name": "David",
    "userData": "User-provided data attached to the person."
  }
]

Definições

Name Description
EnrollmentResponse
Error

Corpo do erro.

EnrollmentResponse

Object
Name Tipo Description
name

string

personId

string (uuid)

userData

string

Error

Object

Corpo do erro.

Name Tipo Description
code

string

message

string