Face List Operations - Get Large Face Lists

Servizio:

Azure AI Services

Versione API:

v1.2-preview.1

Elencare le informazioni degli elenchi di visi di grandi dimensioni di largeFaceListId, nome, userData e recognitionModel.
Per ottenere informazioni sui visi all'interno di largeFaceList, usare "Get Large Face List Face".

Gli elenchi di volti di grandi dimensioni vengono archiviati in ordine alfabetico di largeFaceListId.

• • Il parametro "start" (stringa, facoltativo) specifica un valore ID da cui le voci restituite avranno ID più grandi in base al confronto tra stringhe. L'impostazione di "start" su un valore vuoto indica che le voci devono essere restituite a partire dal primo elemento.
  • Il parametro "top" (int, facoltativo) determina il numero massimo di voci da restituire, con un limite massimo di 1000 voci per chiamata. Per recuperare voci aggiuntive oltre questo limite, specificare "start" con personId dell'ultima voce restituita nella chiamata corrente.

Mancia

• Ad esempio, sono presenti 5 elementi totali con i relativi ID: "itemId1", ..., "itemId5".
  • "start=&top=" restituirà tutti e 5 gli elementi.
  • "start=&top=2" restituirà "itemId1", "itemId2".
  • "start=itemId2&top=3" restituirà "itemId3", "itemId4", "itemId5".

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
apiVersion	path	True	string	Versione API
endpoint	path	True	string uri	Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://{nome-risorsa}.cognitiveservices.azure.com).
returnRecognitionModel	query		boolean	Restituisce o meno 'recognitionModel'. Il valore predefinito è false.
start	query		string	Elencare le risorse maggiori di "start". Non contiene più di 64 caratteri. Il valore predefinito è vuoto.
top	query		integer int32	Numero di elementi da elencare, compreso tra [1, 1000]. Il valore predefinito è 1000.

Risposte

Nome	Tipo	Descrizione
200 OK	LargeFaceList[]	Una chiamata riuscita restituisce una matrice di elenchi di visi di grandi dimensioni e le relative informazioni (largeFaceListId, nome e userData).
Other Status Codes	FaceErrorResponse	Risposta di errore imprevista. Intestazioni x-ms-error-code: string

Sicurezza

Ocp-Apim-Subscription-Key

Chiave privata per la sottoscrizione di Viso di Intelligenza artificiale di Azure.

Tipo: apiKey
In: header

AADToken

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://api.example.com/oauth2/authorize
URL token: https://api.example.com/oauth2/token

Ambiti

Nome	Descrizione
https://cognitiveservices.azure.com/.default

Esempio

Get LargeFaceLists

Esempio di richiesta

HTTP

GET {endpoint}/face/v1.2-preview.1/largefacelists?start=my_list_id&top=20&returnRecognitionModel=True

Risposta di esempio

Codice di stato:

200

[
  {
    "name": "your_large_face_list_name",
    "userData": "your_user_data",
    "recognitionModel": "recognition_01",
    "largeFaceListId": "your_large_face_list_id"
  }
]

Definizioni

Nome	Descrizione
FaceError	Oggetto error. Per informazioni dettagliate sui codici di errore e i messaggi restituiti dal servizio Viso, vedere il collegamento seguente: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Risposta contenente i dettagli dell'errore.
LargeFaceList	Elenco di visi di grandi dimensioni è un elenco di visi, fino a 1.000.000 visi.
RecognitionModel	Modello di riconoscimento per il viso.

FaceError

Oggetto error. Per informazioni dettagliate sui codici di errore e i messaggi restituiti dal servizio Viso, vedere il collegamento seguente: https://aka.ms/face-error-codes-and-messages.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
message	string	Rappresentazione leggibile dell'errore.

FaceErrorResponse

Risposta contenente i dettagli dell'errore.

Nome	Tipo	Descrizione
error	FaceError	Oggetto error.

LargeFaceList

Elenco di visi di grandi dimensioni è un elenco di visi, fino a 1.000.000 visi.

Nome	Tipo	Descrizione
largeFaceListId	string	Il carattere valido è una lettera in lettere minuscole o cifre o '-' o '_', la lunghezza massima è 64.
name	string	Il nome definito dall'utente, la lunghezza massima è 128.
recognitionModel	RecognitionModel	Nome del modello di riconoscimento. Il modello di riconoscimento viene usato quando le funzionalità del viso vengono estratte e associate ai faceId rilevati.
userData	string	Dati facoltativi definiti dall'utente. La lunghezza non deve superare 16.000.

RecognitionModel

Modello di riconoscimento per il viso.

Nome	Tipo	Descrizione
recognition_01	string	Modello di riconoscimento predefinito per "Detect". Tutti i faceId creati prima del 2019 marzo sono associati a questo modello di riconoscimento.
recognition_02	string	Modello di riconoscimento rilasciato nel marzo 2019.
recognition_03	string	Modello di riconoscimento rilasciato nel maggio 2020.
recognition_04	string	Modello di riconoscimento rilasciato nel 2021 febbraio. È consigliabile usare questo modello di riconoscimento per migliorare l'accuratezza del riconoscimento.