Partilhar via

Person Directory Operations - Create Dynamic Person Group

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

Cria um novo Grupo de Pessoas Dinâmicas com dynamicPersonGroupId especificado, nome e userData fornecidos pelo usuário.
Um Grupo de Pessoas Dinâmicas é um contêiner que faz referência ao Diretório de Pessoas "Criar Pessoa". Após a criação, use o Diretório de Pessoas "Atualizar Grupo de Pessoas Dinâmicas" para adicionar/remover pessoas de/para o Grupo de Pessoas Dinâmicas.

O Grupo de Pessoas Dinâmicas e os dados do usuário serão armazenados no servidor até que o Diretório de Pessoas "Excluir Grupo de Pessoas Dinâmicas" seja chamado. Use "Identify From Dynamic Person Group" com o parâmetro dynamicPersonGroupId para identificar pessoas.

Nenhuma imagem será armazenada. Apenas o(s) recurso(s) de rosto extraído(s) da pessoa e os dados de usuário serão armazenados no servidor até que o Diretório de Pessoas "Excluir Pessoa" ou "Excluir Rosto de Pessoa" seja chamado.

'recognitionModel' não precisa ser especificado com Grupos de Pessoas Dinâmicos. Os Grupos de Pessoas Dinâmicas são referências ao Diretório de Pessoas "Criar Pessoa" e, portanto, funcionam com a maioria dos 'recognitionModels'. Os faceId's fornecidos durante "Identify" determinam o 'recognitionModel' usado.

PUT {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

minLength: 1
maxLength: 64
pattern: ^[a-z0-9-_]+$

ID do grupo dinâmico de pessoas.
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).

Corpo do Pedido

Name Necessário Tipo Description
name True

string

minLength: 1
maxLength: 128

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

string

maxLength: 16384

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

Respostas

Name Tipo Description
200 OK

O pedido foi bem-sucedido.
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

Create DynamicPersonGroup

Pedido de amostra

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

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

Resposta da amostra

Código de estado:
200

Definições

Name Description
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.
UserDefinedFields

Campos definidos pelo usuário para a criação de objetos.

FaceError

Object

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

Object

Uma resposta contendo detalhes do erro.

Name Tipo Description
error

FaceError

O objeto de erro.

UserDefinedFields

Object

Campos definidos pelo usuário para a criação de objetos.

Name Tipo Description
name

string

minLength: 1
maxLength: 128

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

string

maxLength: 16384

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