Liveness Session Operations - Get Liveness With Verify Session Result

Servizio:

Azure AI Services

Versione API:

v1.1-preview.1

Ottenere il risultato della sessione della chiamata detectLivenessWithVerify/singleModal.

GET {endpoint}/face/{apiVersion}/detectLivenessWithVerify/singleModal/sessions/{sessionId}

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).
sessionId	path	True	string	ID univoco per fare riferimento a questa sessione.

Risposte

Nome	Tipo	Descrizione
200 OK	LivenessWithVerifySession	La richiesta ha avuto esito positivo.
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 LivenessWithVerify Session Result

Esempio di richiesta

HTTP

GET {endpoint}/face/v1.1-preview.1/detectLivenessWithVerify/singleModal/sessions/b12e033e-bda7-4b83-a211-e721c661f30e

Risposta di esempio

Codice di stato:

200

{
  "id": "b12e033e-bda7-4b83-a211-e721c661f30e",
  "createdDateTime": "2024-03-05T11:07:29.698Z",
  "sessionStartDateTime": "2024-03-05T11:07:29.698Z",
  "sessionExpired": true,
  "deviceCorrelationId": "your_device_correlation_id",
  "authTokenTimeToLiveInSeconds": 600,
  "status": "NotStarted",
  "result": {
    "id": 4,
    "sessionId": "b12e033e-bda7-4b83-a211-e721c661f30e",
    "requestId": "4af681e9-0e25-43e9-9922-a7adebf13b2f",
    "clientRequestId": "4af681e9-0e25-43e9-9922-a7adebf13b2f",
    "receivedDateTime": "2024-03-05T11:07:29.698Z",
    "request": {
      "url": "/face/v1.1-preview.1/detectliveness/singlemodal",
      "method": "POST",
      "contentLength": 18,
      "contentType": "multipart/form-data",
      "userAgent": "Mozilla/5.0 (Linux) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/117.0.0.0 Mobile Safari/537.36"
    },
    "response": {
      "body": {},
      "statusCode": 200,
      "latencyInMilliseconds": 1200
    },
    "digest": "1CC98BA83EAF1D0FF7F566FAEFCCCC787819FFA01251E2D9299143F7AD6651DB"
  }
}

Definizioni

Nome	Descrizione
AuditLivenessResponseInfo	Voce di controllo per una risposta nella sessione.
AuditRequestInfo	Voce di controllo per una richiesta nella sessione.
FaceError	Oggetto error. Per informazioni dettagliate sui codici di errore e i messaggi restituiti dal servizio Viso, fare riferimento al collegamento seguente: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Risposta contenente i dettagli dell'errore.
FaceRectangle	Rettangolo all'interno del quale è possibile trovare un viso.
FaceSessionStatus	Stato corrente della sessione.
ImageType	Tipo di immagine.
LivenessDecision	Risultato della classificazione dell'attività.
LivenessModel	Versione del modello usata per la classificazione della attività.
LivenessOutputsTarget	Classificazione del liveness per il viso di destinazione.
LivenessResponseBody	Corpo della risposta di rilevare la chiamata API di attività.
LivenessSessionAuditEntry	Voce di controllo per una richiesta nella sessione.
LivenessWithVerifyImage	Dettaglio del viso per la verifica.
LivenessWithVerifyOutputs	Output della verifica del viso.
LivenessWithVerifySession	Risultato della sessione di rilevamento dell'attività con verifica.
QualityForRecognition	Indica la qualità dell'immagine per il riconoscimento.

AuditLivenessResponseInfo

Voce di controllo per una risposta nella sessione.

Nome	Tipo	Descrizione
body	LivenessResponseBody	Corpo della risposta. Lo schema di questo campo dipenderà dal metodo request.url e request.method usato dal client.
latencyInMilliseconds	integer	Latenza misurata dal server per questa richiesta in millisecondi.
statusCode	integer	Codice di stato HTTP restituito al client.

AuditRequestInfo

Voce di controllo per una richiesta nella sessione.

Nome	Tipo	Descrizione
contentLength	integer	Lunghezza del corpo della richiesta in byte.
contentType	string	Tipo di contenuto della richiesta.
method	string	Metodo HTTP della richiesta (ad esempio GET, POST, DELETE).
url	string	URL relativo e query della richiesta di attività.
userAgent	string	Agente utente utilizzato per inviare la richiesta.

FaceError

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

Nome	Tipo	Descrizione
code	string	Uno dei set definiti 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.

FaceRectangle

Rettangolo all'interno del quale è possibile trovare un viso.

Nome	Tipo	Descrizione
height	integer	Altezza del rettangolo, in pixel.
left	integer	Distanza dal bordo sinistro se l'immagine al bordo sinistro del rettangolo, espressa in pixel.
top	integer	Distanza dal bordo superiore se l'immagine al bordo superiore del rettangolo, espressa in pixel.
width	integer	Larghezza del rettangolo, in pixel.

FaceSessionStatus

Stato corrente della sessione.

Nome	Tipo	Descrizione
NotStarted	string	La sessione non è stata avviata.
ResultAvailable	string	Il risultato della sessione è disponibile.
Started	string	Sessione avviata.

ImageType

Tipo di immagine.

Nome	Tipo	Descrizione
Color	string	Immagine a colori.
Depth	string	Immagine di profondità.
Infrared	string	Immagine a infrarossi.

LivenessDecision

Risultato della classificazione dell'attività.

Nome	Tipo	Descrizione
realface	string	L'algoritmo ha classificato il viso di destinazione come reale.
spoofface	string	L'algoritmo ha classificato il viso di destinazione come spoofing.
uncertain	string	L'algoritmo non è riuscito a classificare il viso di destinazione come reale o spoofing.

LivenessModel

Versione del modello usata per la classificazione della attività.

Nome	Tipo	Descrizione
2020-02-15-preview.01	string
2021-11-12-preview.03	string
2022-10-15-preview.04	string
2023-03-02-preview.05	string

LivenessOutputsTarget

Classificazione del liveness per il viso di destinazione.

Nome	Tipo	Descrizione
faceRectangle	FaceRectangle	Area del viso in cui è stata effettuata la classificazione di attività.
fileName	string	Nome del file che contiene il rettangolo del viso in cui è stata eseguita la classificazione di attività.
imageType	ImageType	Tipo di immagine che contiene il rettangolo del viso in cui è stata eseguita la classificazione della dinamica.
timeOffsetWithinFile	integer	Offset temporale all'interno del file del frame che contiene il rettangolo del viso in cui è stata eseguita la classificazione di attività.

LivenessResponseBody

Corpo della risposta di rilevare la chiamata API di attività.

Nome	Tipo	Descrizione
livenessDecision	LivenessDecision	Classificazione del liveness per il viso di destinazione.
modelVersionUsed	LivenessModel	Versione del modello usata per la classificazione della attività.
target	LivenessOutputsTarget	Destinazioni specifiche usate per la classificazione dell'attività.
verifyResult	LivenessWithVerifyOutputs	Output della verifica del viso. Disponibile solo quando la richiesta è attiva con verifica.

LivenessSessionAuditEntry

Voce di controllo per una richiesta nella sessione.

Nome	Tipo	Descrizione
clientRequestId	string	ClientRequestId univoco inviato dal client nell'intestazione 'client-request-id'.
digest	string	Digest calcolato dal server per questa richiesta. Se il digest segnalato dal client è diverso dal digest calcolato dal server, l'integrità del messaggio tra il client e il servizio è stata compromessa e il risultato non deve essere considerato attendibile. Per altre informazioni, vedere le guide su come sfruttare questo valore per proteggere la soluzione end-to-end.
id	integer	ID univoco da fare riferimento a questa richiesta di controllo. Usare questo ID con il parametro di query "start" per continuare con la pagina successiva dei risultati del controllo.
receivedDateTime	string	DateTime UTC ricevuto dalla richiesta.
request	AuditRequestInfo	Richiesta di questa voce.
requestId	string	Id richiesta univoco restituito dal servizio al client nell'intestazione 'apim-request-id'.
response	AuditLivenessResponseInfo	Risposta di questa voce.
sessionId	string	SessionId univoco della sessione creata. Scadrà 48 ore dopo la creazione o potrebbe essere eliminato prima usando l'operazione DELETE di sessione corrispondente.

LivenessWithVerifyImage

Dettaglio del viso per la verifica.

Nome	Tipo	Descrizione
faceRectangle	FaceRectangle	Area del viso in cui è stata effettuata la classificazione dell'immagine di confronto.
qualityForRecognition	QualityForRecognition	Qualità dell'immagine del viso per il riconoscimento.

LivenessWithVerifyOutputs

Output della verifica del viso.

Nome	Tipo	Descrizione
isIdentical	boolean	Indica se il viso di liveness di destinazione e il viso dell'immagine di confronto corrispondono.
matchConfidence	number	Attendibilità della verifica del viso e dell'immagine di confronto del viso di destinazione.
verifyImage	LivenessWithVerifyImage	Dettaglio del viso per la verifica.

LivenessWithVerifySession

Risultato della sessione di rilevamento dell'attività con verifica.

Nome	Tipo	Valore predefinito	Descrizione
authTokenTimeToLiveInSeconds	integer	600	Secondi per cui la sessione deve durare. L'intervallo è compreso tra 60 e 86400 secondi. Il valore predefinito è 600.
createdDateTime	string		DateTime al momento della creazione di questa sessione.
deviceCorrelationId	string		Guid univoco per ogni dispositivo dell'utente finale. Questo è quello di fornire limitazione della velocità e anti-martello. Se 'deviceCorrelationIdSetInClient' è true in questa richiesta, questo 'deviceCorrelationId' deve essere null.
id	string		ID univoco per fare riferimento a questa sessione.
result	LivenessSessionAuditEntry		Il risultato del controllo della sessione più recente viene popolato solo se lo stato == 'ResultAvailable'.
sessionExpired	boolean		Indica se la sessione è scaduta o meno.
sessionStartDateTime	string		DateTime quando la sessione è stata avviata dal client.
status	FaceSessionStatus		Stato corrente della sessione.

QualityForRecognition

Indica la qualità dell'immagine per il riconoscimento.

Nome	Tipo	Descrizione
high	string	Qualità elevata.
low	string	Bassa qualità.
medium	string	Qualità media.