Face List Operations - Create Face List

Serviço:

Azure AI Services

Versão da API:

v1.2

Crie uma Lista de Rostos vazia com faceListId, nome, userData e recognitionModel opcionais especificados pelo usuário.
Até 64 Listas de Detecção Facial são permitidas em uma assinatura.

A Lista de Rostos é uma lista de rostos, até 1.000 rostos e usada por "Localizar semelhante na lista de rostos".

Após a criação, o usuário deve usar "Adicionar Face List Face" para importar os rostos. Nenhuma imagem será armazenada. Somente os recursos de rosto extraídos serão armazenados no servidor até que "Excluir Lista de Detecção Facial" seja chamado.

"Localizar Semelhante" é usado para cenários como encontrar rostos semelhantes a celebridades, filtragem facial semelhante ou como uma identificação facial de forma leve. Mas se o uso real for identificar a pessoa, use Grupo de Pessoas/Grupo de Pessoas Grandes e "Identificar".

Considere a Lista de Rostos Grandes quando o número de rosto for grande. Ele pode dar suporte a até 1.000.000 faces.

PUT {endpoint}/face/{apiVersion}/facelists/{faceListId}

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).
faceListId	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-z0-9-_]+$	O caractere válido é letra em letras minúsculas ou dígito ou '-' ou '_', o comprimento máximo é 64.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
name	True	string minLength: 1 maxLength: 128	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 maxLength: 16384	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 FaceList

Solicitação de exemplo

HTTP

PUT {endpoint}/face/v1.2/facelists/your_face_list_id

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

Resposta de exemplo

Código de status:

200

Definições

Nome	Description
CreateCollectionRequest	Modelo para criar uma coleção de rostos.
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.
RecognitionModel	O modelo de reconhecimento para o rosto.

CreateCollectionRequest

Objeto

Modelo para criar uma coleção de rostos.

Nome	Tipo	Valor padrão	Description
name	string minLength: 1 maxLength: 128		Nome definido pelo usuário, o comprimento máximo é 128.
recognitionModel	RecognitionModel	recognition_01	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 maxLength: 16384		Dados definidos pelo usuário opcionais. O comprimento não deve exceder 16 K.

FaceError

Objeto

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

Objeto

Uma resposta que contém detalhes do erro.

Nome	Tipo	Description
error	FaceError	O objeto de erro.

RecognitionModel

Enumeração

O modelo de reconhecimento para o rosto.

Valor	Description
recognition_01	O modelo de reconhecimento padrão para "Detectar". Todas essas faceIds criadas antes de março de 2019 são vinculadas a esse modelo de reconhecimento.
recognition_02	Modelo de reconhecimento lançado em março de 2019.
recognition_03	Modelo de reconhecimento lançado em maio de 2020.
recognition_04	Modelo de reconhecimento lançado em fevereiro de 2021. É recomendável usar esse modelo de reconhecimento para melhor precisão de reconhecimento.