Person Group Operations - Create Person Group

Serviço:

Azure AI Services

Versão da API:

v1.2-preview.1

Crie um novo Grupo de Pessoas com personGroupId, nome, userData e recognitionModel fornecidos pelo usuário especificados.
Um Grupo de Pessoas é um contêiner que contém os dados da pessoa carregada, incluindo recursos de reconhecimento facial.

Após a criação, use "Criar Pessoa do Grupo de Pessoas" para adicionar pessoas ao grupo e, em seguida, chame "Treinar Grupo de Pessoas" para preparar esse grupo para "Identificar do Grupo de Pessoas".

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

'recognitionModel' deve ser especificado para associar a esse Grupo de Pessoas. O valor padrão para 'recognitionModel' é 'recognition_01', se o modelo mais recente for necessário, especifique explicitamente o modelo necessário neste parâmetro. Novos rostos adicionados a um grupo de pessoas existente usarão o modelo de reconhecimento que já está associado à coleção. Os recursos de detecção facial existentes em um Grupo de Pessoas não podem ser atualizados para recursos extraídos por outra versão do modelo de reconhecimento.

Nota

• • Cota de assinatura de camada gratuita: 1.000 Grupos de Pessoas. Cada um tem até 1.000 pessoas.
  • Cota de assinatura de nível S0: 1.000.000 Grupos de Pessoas. Cada um tem até 10.000 pessoas.
  • para lidar com um problema de identificação facial de maior escala, considere o uso do Grupo de Pessoas Grandes.

PUT {endpoint}/face/{apiVersion}/persongroups/{personGroupId}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
apiVersion	path	True	string	Versão da API
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).
personGroupId	path	True	string	ID do contêiner. Padrão Regex: ^[a-z0-9-_]+$

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
name	True	string	Nome definido pelo usuário, o comprimento máximo é 128.
recognitionModel		RecognitionModel	O 'recognitionModel' associado a essa lista de rostos. Os valores 'recognitionModel' com suporte incluem 'recognition_01', 'recognition_02, 'recognition_03' e 'recognition_04'. O valor padrão é 'recognition_01'. 'recognition_04' é recomendado, pois sua precisão é melhorada em rostos usando máscaras em comparação com 'recognition_03', e sua precisão geral é melhorada em comparação com 'recognition_01' e 'recognition_02'.
userData		string	Dados definidos pelo usuário opcionais. O comprimento não deve exceder 16 K.

Respostas

Nome	Tipo	Description
200 OK		A solicitação foi bem-sucedida.
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 PersonGroup

Solicitação de exemplo

HTTP

PUT {endpoint}/face/v1.2-preview.1/persongroups/your_person_group_id

{
  "name": "your_person_group_name",
  "userData": "your_user_data",
  "recognitionModel": "recognition_01"
}

Resposta de exemplo

Código de status:

200

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.