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.
Esta API retorna apenas informações do Grupo de Pessoas Dinâmicas, use o Diretório de Pessoas "Obter Pessoas do Grupo de Pessoas Dinâmicas" em vez de recuperar informações de pessoas no Grupo de Pessoas Dinâmicas.

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

Parâmetros do URI

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

Respostas

Name	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 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 DynamicPersonGroup

Pedido de amostra

HTTP

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

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.