Liveness Session Operations - Get Liveness With Verify Sessions

Servicio:

Azure AI Services

Versión de la API:

v1.2-preview.1

Enumera las sesiones de /detectLivenessWithVerify/SingleModal.
Enumera las sesiones del último sessionId mayor que "start".

El resultado debe ordenarse por sessionId en orden ascendente.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
apiVersion	path	True	string	Versión de API
endpoint	path	True	string uri	Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://{resource-name}.cognitiveservices.azure.com).
start	query		string	Enumera los recursos mayores que el "inicio". No contiene más de 64 caracteres. El valor predeterminado está vacío.
top	query		integer int32	Número de elementos que se van a enumerar, comprendidos en [1, 1000]. El valor predeterminado es 1000.

Respuestas

Nombre	Tipo	Description
200 OK	LivenessSessionItem[]	La solicitud se ha realizado correctamente.
Other Status Codes	FaceErrorResponse	Una respuesta de error inesperada. Encabezados x-ms-error-code: string

Seguridad

Ocp-Apim-Subscription-Key

Clave secreta de la suscripción de Azure AI Face.

Tipo: apiKey
En: header

AADToken

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://api.example.com/oauth2/authorize
Dirección URL del token: https://api.example.com/oauth2/token

Ámbitos

Nombre	Description
https://cognitiveservices.azure.com/.default

Ejemplos

Get LivenessWithVerify Sessions

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:

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
  }
]

Definiciones

Nombre	Description
FaceError	Objeto de error. Para obtener detalles completos sobre los códigos de error y los mensajes devueltos por face Service, consulte el vínculo siguiente: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Respuesta que contiene los detalles del error.
LivenessSessionItem	Datos de sesión devueltos para la enumeración.

FaceError

Objeto de error. Para obtener detalles completos sobre los códigos de error y los mensajes devueltos por face Service, consulte el vínculo siguiente: https://aka.ms/face-error-codes-and-messages.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
message	string	Representación legible del error.

FaceErrorResponse

Respuesta que contiene los detalles del error.

Nombre	Tipo	Description
error	FaceError	Objeto de error.

LivenessSessionItem

Datos de sesión devueltos para la enumeración.

Nombre	Tipo	Valor predeterminado	Description
authTokenTimeToLiveInSeconds	integer	600	Segundos para los que debe durar la sesión. El intervalo es de 60 a 86400 segundos. El valor predeterminado es 600.
createdDateTime	string		DateTime cuando se creó esta sesión.
deviceCorrelationId	string		Guid único por cada dispositivo de usuario final. Esto es para proporcionar limitación de velocidad y anti-martillo. Si "deviceCorrelationIdSetInClient" es true en esta solicitud, "deviceCorrelationId" debe ser NULL.
id	string		Identificador único que se va a hacer referencia a esta sesión.
sessionExpired	boolean		Indica si la sesión ha expirado o no.
sessionStartDateTime	string		DateTime cuando el cliente inició esta sesión.