Partilhar via

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 especificado pelo usuário, nome, um userData opcional e recognitionModel.
São permitidas até 64 Listas de Rostos numa subscrição.

Face List é uma lista de rostos, até 1.000 rostos, e usada por "Find Similar From Face List".

Após a criação, o usuário deve usar "Add Face List Face" para importar os rostos. Nenhuma imagem será armazenada. Apenas o(s) recurso(s) de rosto extraído(s) será(ão) armazenado(s) no servidor até que "Delete Face List" seja chamado.

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

Por favor, considere a Lista de Rostos Grandes quando o número de rosto for grande. Pode suportar até 1.000.000 de rostos.

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

Parâmetros do URI

Name Em Necessário Tipo Description
apiVersion
 path True

string

Versão da API
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).
faceListId
 path True

string

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

Caractere válido é letra em minúscula ou dígito ou '-' ou '_', comprimento máximo é 64.

Corpo do Pedido

Name Necessário Tipo Description
name True

string

minLength: 1
maxLength: 128

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

RecognitionModel

O 'recognitionModel' associado a esta lista de rostos. Os valores 'recognitionModel' suportados incluem 'recognition_01', 'recognition_02, 'recognition_03' e 'recognition_04'. O valor padrão é 'recognition_01'. 'recognition_04' é recomendado, uma vez que a sua precisão é melhorada em rostos que usam máscaras em comparação com 'recognition_03', e a sua precisão geral é melhorada em comparação com 'recognition_01' e 'recognition_02'.
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 FaceList

Pedido de amostra

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

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

Resposta da amostra

Código de estado:
200

Definições

Name Description
CreateCollectionRequest

Modelo para criação de coleção facial.
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.
RecognitionModel

O modelo de reconhecimento para o rosto.

CreateCollectionRequest

Object

Modelo para criação de coleção facial.

Name Tipo Default value Description
name

string

minLength: 1
maxLength: 128

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

RecognitionModel

recognition_01

O 'recognitionModel' associado a esta lista de rostos. Os valores 'recognitionModel' suportados incluem 'recognition_01', 'recognition_02, 'recognition_03' e 'recognition_04'. O valor padrão é 'recognition_01'. 'recognition_04' é recomendado, uma vez que a sua precisão é melhorada em rostos que usam máscaras em comparação com 'recognition_03', e a sua precisão geral é melhorada em comparação com 'recognition_01' e 'recognition_02'.
userData

string

maxLength: 16384

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

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.

RecognitionModel

Enumeração

O modelo de reconhecimento para o rosto.

Valor Description
recognition_01

O modelo de reconhecimento padrão para "Detetar". Todos os faceIds criados antes de março de 2019 estão ligados a este 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. Recomenda-se usar este modelo de reconhecimento para uma melhor precisão de reconhecimento.