Face List Operations - Get Face List

Service:

Azure AI Services

API Version:

v1.1-preview.1

Obtenha o faceListId, nome, userData, recognitionModel e rostos de uma Lista de Rostos na Lista de Rostos.

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

With optional parameters:

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 finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: https://{resource-name}.cognitiveservices.azure.com).
faceListId	path	True	string	O caráter válido é letra em minúsculas ou dígitos ou "-" ou "_", o comprimento máximo é 64. Regex pattern: ^[a-z0-9-_]+$
returnRecognitionModel	query		boolean	Devolver "recognitionModel" ou não. O valor predefinido é false.

Respostas

Name	Tipo	Description
200 OK	FaceList	Uma chamada bem-sucedida devolve as informações da Lista de Rostos.
Other Status Codes	FaceErrorResponse	Uma resposta de erro inesperada. Headers x-ms-error-code: string

Segurança

Ocp-Apim-Subscription-Key

A chave secreta da sua subscrição do Azure AI Face.

Type: apiKey
In: header

AADToken

O Fluxo OAuth2 do Azure Active Directory

Type: oauth2
Flow: accessCode
Authorization URL: https://api.example.com/oauth2/authorize
Token URL: https://api.example.com/oauth2/token

Scopes

Name	Description
https://cognitiveservices.azure.com/.default

Exemplos

Get FaceList

Sample Request

HTTP

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

Sample Response

Status code:

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 os códigos de erro e as mensagens devolvidas pelo Serviço Face, veja a seguinte ligação: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Uma resposta que contém detalhes de erro.
FaceList	A lista de rostos é uma lista de rostos, até 1000 rostos.
FaceListFace	Recurso facial para lista de rostos.
RecognitionModel	O modelo de reconhecimento do rosto.

FaceError

O objeto de erro. Para obter detalhes abrangentes sobre os códigos de erro e as mensagens devolvidas pelo Serviço Face, veja a seguinte ligação: https://aka.ms/face-error-codes-and-messages.

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
message	string	Uma representação legível por humanos do erro.

FaceErrorResponse

Uma resposta que contém detalhes de erro.

Name	Tipo	Description
error	FaceError	O objeto de erro.

FaceList

A lista de rostos é uma lista de rostos, até 1000 rostos.

Name	Tipo	Description
faceListId	string	O caráter válido é letra em minúsculas ou dígitos ou "-" ou "_", o comprimento máximo é 64.
name	string	Nome definido pelo utilizador: o comprimento máximo é 128.
persistedFaces	FaceListFace[]	Face ids de rostos registados na lista de rostos.
recognitionModel	RecognitionModel	Nome do modelo de reconhecimento. O modelo de reconhecimento é utilizado quando as funcionalidades faciais são extraídas e associadas a faceIds detetados.
userData	string	Dados definidos pelo utilizador opcionais. O comprimento não deve exceder os 16 000.

FaceListFace

Recurso facial para lista de rostos.

Name	Tipo	Description
persistedFaceId	string	Face ID do rosto.
userData	string	Dados fornecidos pelo utilizador anexados ao rosto. O limite de comprimento é de 1 K.

RecognitionModel

O modelo de reconhecimento do rosto.

Name	Tipo	Description
recognition_01	string	O modelo de reconhecimento predefinido para "Detetar". Todos os faceIds criados antes de março de 2019 estão associados 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 utilizar este modelo de reconhecimento para uma melhor precisão de reconhecimento.