Person Directory Operations - Get Dynamic Person Group

Serviço:

Azure AI Services

Versão da API:

v1.2-preview.1

Recupere as informações de um Grupo de Pessoas Dinâmicas, incluindo seu nome e userData.
Essa API retorna somente informações do Grupo de Pessoas Dinâmicas, use o Diretório de Pessoas "Obter Pessoas Dinâmicas do Grupo de Pessoas" em vez disso para recuperar informações de pessoa no Grupo de Pessoas Dinâmicas.

GET {endpoint}/face/{apiVersion}/dynamicpersongroups/{dynamicPersonGroupId}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
apiVersion	path	True	string	Versão da API
dynamicPersonGroupId	path	True	string	ID do grupo de pessoas dinâmicas. Padrão Regex: ^[a-z0-9-_]+$
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).

Respostas

Nome	Tipo	Description
200 OK	DynamicPersonGroup	Uma chamada bem-sucedida retorna as informações do 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 DynamicPersonGroup

Solicitação de exemplo

HTTP

GET {endpoint}/face/v1.2-preview.1/dynamicpersongroups/your_dynamic_person_group_id

Resposta de exemplo

Código de status:

200

{
  "dynamicPersonGroupId": "your_dynamic_person_group_id",
  "name": "your_dynamic_person_group_name",
  "userData": "your_user_data"
}

Definições

Nome	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 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.

DynamicPersonGroup

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

Nome	Tipo	Description
dynamicPersonGroupId	string	ID do grupo de pessoas dinâmicas.
name	string	Nome definido pelo usuário, o comprimento máximo é 128.
userData	string	Dados definidos pelo usuário opcionais. O comprimento não deve exceder 16 K.

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.