Person Directory Operations - Create Dynamic Person Group With Person

Serviço:

Azure AI Services

Versão da API:

v1.2-preview.1

Cria um novo Grupo de Pessoas Dinâmicas com dynamicPersonGroupId, nome e userData fornecidos pelo usuário especificados.
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.

Os dados do grupo de pessoas dinâmicas e do usuário serão armazenados no servidor até que o Diretório de Pessoas "Excluir Grupo de Pessoas Dinâmicas" seja chamado. Use "Identifique do Grupo de Pessoas Dinâmicas" com o parâmetro dynamicPersonGroupId para identificar em relação às pessoas.

Nenhuma imagem será armazenada. Somente os recursos de rosto extraídos da pessoa e userData serão armazenados no servidor até que o Diretório de Pessoas "Excluir Pessoa" ou "Excluir Rosto da Pessoa" seja chamado.

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

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

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
addPersonIds	True	string[]	Matriz de personIds criadas pelo Diretório de Pessoas "Criar Pessoa" a ser adicionada.
name	True	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.

Respostas

Nome	Tipo	Description
202 Accepted		Uma chamada bem-sucedida retorna um corpo de resposta vazio. O serviço aceitou a solicitação e começará a processar em breve. O cliente pode consultar o status da operação e resultar usando a URL especificada no cabeçalho de resposta 'Operation-Location'. A URL expira em 48 horas. A URL fornece o status de quando o Diretório de Pessoas "Obter Referências de Grupo de Pessoas Dinâmicas" retornará as alterações feitas nesta solicitação. Cabeçalhos operation-Location: string
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

Create DynamicPersonGroup

Solicitação de exemplo

HTTP

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

{
  "name": "your_dynamic_person_group_name",
  "userData": "your_user_data",
  "addPersonIds": [
    "85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5"
  ]
}

Resposta de exemplo

Código de status:

202

operation-Location: https://contoso.com/operationstatus

Definições

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

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.