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

Corpo do Pedido

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

Respostas

Name	Tipo	Description
202 Accepted		Uma chamada bem-sucedida retorna um corpo de resposta vazio. O serviço aceitou o pedido e começará a processar em breve. O cliente pode consultar o status e o resultado da operação usando a URL especificada no cabeçalho de resposta 'Operation-Location'. O 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 nessa 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 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

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 da amostra

Código de estado:

202

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

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.

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.