Face List Operations - Get Face List

Serviço:

Azure AI Services

Versão da API:

v1.2-preview.1

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

Respostas

Name	Tipo	Description
200 OK	FaceList	Uma chamada bem-sucedida retorna as informações da Face List.
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

Get FaceList

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:

200

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

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.
FaceList	Face list é uma lista de rostos, até 1.000 rostos.
FaceListFace	Recurso de rosto para lista de rostos.
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 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.

FaceList

Face list é uma lista de rostos, até 1.000 rostos.

Name	Tipo	Description
faceListId	string	Caractere válido é letra em minúscula ou dígito ou '-' ou '_', comprimento máximo é 64.
name	string	Nome definido pelo usuário, comprimento máximo é 128.
persistedFaces	FaceListFace[]	Identificações faciais de rostos registados na lista de rostos.
recognitionModel	RecognitionModel	Nome do modelo de reconhecimento. O modelo de reconhecimento é usado quando as características do rosto são extraídas e associadas aos faceIds detetados.
userData	string	Dados opcionais definidos pelo usuário. O comprimento não deve exceder 16K.

FaceListFace

Recurso de rosto para lista de rostos.

Name	Tipo	Description
persistedFaceId	string	Identificação facial do rosto.
userData	string	Dados fornecidos pelo usuário anexados ao rosto. O limite de comprimento é 1K.

RecognitionModel

O modelo de reconhecimento para o rosto.

Name	Tipo	Description
recognition_01	string	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	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. Recomenda-se usar este modelo de reconhecimento para uma melhor precisão de reconhecimento.