Face List Operations - Get Face List

  • Riferimento
Servizio:
Azure AI Services
Versione API:
v1.2-preview.1

Recuperare il faceListId di un face List, il nome, userData, il recognitionModel e i visi nell'elenco dei volti.

GET {endpoint}/face/{apiVersion}/facelists/{faceListId}
Con parametri facoltativi: 
GET {endpoint}/face/{apiVersion}/facelists/{faceListId}?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).
faceListId
 path True

string

Il carattere valido è una lettera in lettere minuscole o cifre o '-' o '_', la lunghezza massima è 64.

Criterio di espressione regolare: ^[a-z0-9-_]+$
returnRecognitionModel
 query

boolean

Restituisce o meno 'recognitionModel'. Il valore predefinito è false.

Risposte

Nome Tipo Descrizione
200 OK

FaceList

Una chiamata con esito positivo restituisce le informazioni di Face List.
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 FaceList

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
200 
{
  "name": "your_face_list_name",
  "userData": "your_user_data",
  "recognitionModel": "recognition_01",
  "faceListId": "your_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.
FaceList

L'elenco dei visi è un elenco di visi, fino a 1.000 visi.
FaceListFace

Risorsa viso per l'elenco dei 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.

FaceList

L'elenco dei visi è un elenco di visi, fino a 1.000 visi.

Nome Tipo Descrizione
faceListId

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.
persistedFaces

FaceListFace[]

ID viso dei visi registrati nell'elenco dei volti.
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.

FaceListFace

Risorsa viso per l'elenco dei visi.

Nome Tipo Descrizione
persistedFaceId

string

ID viso del viso.
userData

string

Dati forniti dall'utente collegati al viso. Il limite di lunghezza è 1K.

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.