Partilhar via

Person Directory Operations - Get Dynamic Person Groups

  • Referência
Serviço:
Azure AI Services
Versão da API:
v1.2-preview.1

Liste todos os Grupos de Pessoas Dinâmicas existentes por dynamicPersonGroupId juntamente com name e userData.
Os Grupos de Pessoas Dinâmicas são armazenados em ordem alfabética de dynamicPersonGroupId.

    • O parâmetro "start" (string, opcional) especifica um valor de ID a partir do qual as entradas retornadas terão IDs maiores com base na comparação de cadeia de caracteres. Definir "start" como 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 o personId da última entrada retornada na chamada atual.

Dica

  • Por exemplo, há um total de 5 itens com seus 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}/dynamicpersongroups
Com parâmetros opcionais: 
GET {endpoint}/face/{apiVersion}/dynamicpersongroups?start={start}&top={top}

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

string

Listar recursos maiores que o "início". Não contém mais de 64 caracteres. O padrão está vazio.
top
 query

integer

int32

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

Respostas

Name Tipo Description
200 OK

DynamicPersonGroup[]

Uma chamada bem-sucedida retorna uma matriz de Grupos de Pessoas Dinâmicas e suas informações (dynamicPersonGroupId, name e userData).
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 DynamicPersonGroups

Pedido de amostra

GET {endpoint}/face/v1.2-preview.1/dynamicpersongroups?start=dynamic_person_group_id&top=20

Resposta da amostra

Código de estado:
200 
[
  {
    "dynamicPersonGroupId": "your_dynamic_person_group_id",
    "name": "your_dynamic_person_group_name",
    "userData": "your_user_data"
  }
]

Definições

Name Description
DynamicPersonGroup

Um contêiner que faz referência ao Diretório de Pessoas "Criar Pessoa".
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.

DynamicPersonGroup

Um contêiner que faz referência ao Diretório de Pessoas "Criar Pessoa".

Name Tipo Description
dynamicPersonGroupId

string

ID do grupo dinâmico de pessoas.
name

string

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

string

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

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.