Face List Operations - Get Large Face List Faces

Serviço:

Azure AI Services

Versão da API:

v1.2-preview.1

Liste faces' persistedFaceId e userData em uma Lista de Faces Grande especificada.
Os rostos são armazenados em ordem alfabética de persistedFaceId criado em "Add Large Face List Face".

• • O parâmetro "start" (string, opcional) especifica um valor de ID a partir do qual as entradas retornadas terão IDs maiores com base na comparação de cadeia de caracteres. Definir "start" como um valor vazio indica que as entradas devem ser retornadas a partir do primeiro item.
  • O parâmetro "top" (int, opcional) determina o número máximo de entradas a serem retornadas, com um limite de até 1000 entradas por chamada. Para recuperar entradas adicionais além desse limite, especifique "start" com o personId da última entrada retornada na chamada atual.

Dica

• Por exemplo, há um total de 5 itens com seus IDs: "itemId1", ..., "itemId5".
  • "start=&top=" retornará todos os 5 itens.
  • "start=&top=2" retornará "itemId1", "itemId2".
  • "start=itemId2&top=3" retornará "itemId3", "itemId4", "itemId5".

GET {endpoint}/face/{apiVersion}/largefacelists/{largeFaceListId}/persistedfaces

Com parâmetros opcionais:

GET {endpoint}/face/{apiVersion}/largefacelists/{largeFaceListId}/persistedfaces?start={start}&top={top}

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).
largeFaceListId	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-_]+$
start	query		string	Listar recursos maiores que o "início". Não contém mais de 64 caracteres. O padrão está vazio.
top	query		integer int32	O número de itens a listar, variando em [1, 1000]. O padrão é 1000.

Respostas

Name	Tipo	Description
200 OK	LargeFaceListFace[]	Uma chamada bem-sucedida retorna uma matriz de rostos persistentes e suas informações (persistedFaceId e userData).
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 Faces from LargeFaceList

Pedido de amostra

HTTP

GET {endpoint}/face/v1.2-preview.1/largefacelists/your_large_face_list_id/persistedfaces?start=00000000-0000-0000-0000-000000000000&top=20

Resposta da amostra

Código de estado:

200

[
  {
    "persistedFaceId": "43897a75-8d6f-42cf-885e-74832febb055",
    "userData": "your_user_data"
  }
]

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.
LargeFaceListFace	Recurso de rosto para lista de rostos grande.

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.

LargeFaceListFace

Recurso de rosto para lista de rostos grande.

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.