Face List Operations - Get Face List

Serviço:

Azure AI Services

Versão da API:

v1.2-preview.1

Recupere faceListId, nome, userData, recognitionModel e faces de uma Lista de Rostos na Lista de Rostos.

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

Com parâmetros opcionais:

GET {endpoint}/face/{apiVersion}/facelists/{faceListId}?returnRecognitionModel={returnRecognitionModel}

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	O caractere válido é letra em letras minúsculas ou dígito ou '-' ou '_', o comprimento máximo é 64. Padrão Regex: ^[a-z0-9-_]+$
returnRecognitionModel	query		boolean	Retornar 'recognitionModel' ou não. O valor padrão é false.

Respostas

Nome	Tipo	Description
200 OK	FaceList	Uma chamada bem-sucedida retorna as informações da Lista de Detecção Facial.
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

Get FaceList

Solicitação de exemplo

HTTP

GET {endpoint}/face/v1.2-preview.1/facelists/your_face_list_id?returnRecognitionModel=True

Resposta de exemplo

Código de status:

200

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

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.
FaceList	A lista de rostos é uma lista de rostos, até 1.000 faces.
FaceListFace	Recurso de detecção facial para a lista de detecção facial.
RecognitionModel	O modelo de reconhecimento para o rosto.

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.

FaceList

A lista de rostos é uma lista de rostos, até 1.000 faces.

Nome	Tipo	Description
faceListId	string	O caractere válido é letra em letras minúsculas ou dígito ou '-' ou '_', o comprimento máximo é 64.
name	string	Nome definido pelo usuário, o comprimento máximo é 128.
persistedFaces	FaceListFace[]	IDs de rosto de rostos registrados na lista de rostos.
recognitionModel	RecognitionModel	Nome do modelo de reconhecimento. O modelo de reconhecimento é usado quando os recursos de detecção facial são extraídos e associados a faceIds detectadas.
userData	string	Dados definidos pelo usuário opcionais. O comprimento não deve exceder 16 K.

FaceListFace

Recurso de detecção facial para a lista de detecção facial.

Nome	Tipo	Description
persistedFaceId	string	ID de rosto do rosto.
userData	string	Dados fornecidos pelo usuário anexados à face. O limite de comprimento é 1K.

RecognitionModel

O modelo de reconhecimento para o rosto.

Nome	Tipo	Description
recognition_01	string	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	string	Modelo de reconhecimento lançado em março de 2019.
recognition_03	string	Modelo de reconhecimento lançado em maio de 2020.
recognition_04	string	Modelo de reconhecimento lançado em fevereiro de 2021. É recomendável usar esse modelo de reconhecimento para melhor precisão de reconhecimento.