Liveness Session Operations - Get Liveness With Verify Sessions

Servizio:

Azure AI Services

Versione API:

v1.2-preview.1

Elenca le sessioni per /detectLivenessWithVerify/SingleModal.
Elencare le sessioni dall'ultimo sessionId maggiore di 'start'.

Il risultato deve essere ordinato in base a sessionId in ordine crescente.

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

Con parametri facoltativi:

GET {endpoint}/face/{apiVersion}/detectLivenessWithVerify/singleModal/sessions?start={start}&top={top}

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).
start	query		string	Elencare le risorse maggiori di "start". Non contiene più di 64 caratteri. Il valore predefinito è vuoto.
top	query		integer (int32) minimum: 1 maximum: 1000	Numero di elementi da elencare, compreso tra [1, 1000]. Il valore predefinito è 1000.

Risposte

Nome	Tipo	Descrizione
200 OK	LivenessSessionItem[]	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 Sessions

Esempio di richiesta

HTTP

GET {endpoint}/face/v1.2-preview.1/detectLivenessWithVerify/singleModal/sessions?start=00000000-0000-0000-0000-000000000000&top=20

Risposta di esempio

Codice di stato:

200

[
  {
    "id": "b12e033e-bda7-4b83-a211-e721c661f30e",
    "createdDateTime": "2024-03-05T11:07:28.540Z",
    "sessionStartDateTime": "2024-03-05T11:07:28.540Z",
    "sessionExpired": true,
    "deviceCorrelationId": "your_device_correlation_id",
    "authTokenTimeToLiveInSeconds": 60
  }
]

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.
LivenessSessionItem	Dati di sessione restituiti per l'enumerazione.

FaceError

Object

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

Object

Risposta contenente i dettagli dell'errore.

Nome	Tipo	Descrizione
error	FaceError	Oggetto error.

LivenessSessionItem

Object

Dati di sessione restituiti per l'enumerazione.

Nome	Tipo	Valore predefinito	Descrizione
authTokenTimeToLiveInSeconds	integer (int32) minimum: 60 maximum: 86400	600	Secondi per cui la sessione deve durare. L'intervallo è compreso tra 60 e 86400 secondi. Il valore predefinito è 600.
createdDateTime	string (date-time)		DateTime quando è stata creata la sessione.
deviceCorrelationId	string		Guid univoco per ogni dispositivo dell'utente finale. Questo è quello di fornire limitazione della frequenza e anti-martello. Se 'deviceCorrelationIdSetInClient' è true in questa richiesta, questo 'deviceCorrelationId' deve essere null.
id	string		ID univoco per fare riferimento a questa sessione.
sessionExpired	boolean		Indica se la sessione è scaduta o meno.
sessionStartDateTime	string (date-time)		DateTime quando la sessione è stata avviata dal client.