Compartir a través de


Liveness Session Operations - Get Liveness Session Result

Obtiene el resultado de la sesión de la llamada detectLiveness/singleModal.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
apiVersion
path True

string

Versión de la API

endpoint
path True

string

uri

Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://{nombre-recurso}.cognitiveservices.azure.com).

sessionId
path True

string

Identificador único para hacer referencia a esta sesión.

Respuestas

Nombre Tipo Description
200 OK

LivenessSession

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 LivenessSession Result

Solicitud de ejemplo

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

Respuesta de muestra

{
  "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"
  }
}

Definiciones

Nombre Description
AuditLivenessResponseInfo

Entrada de auditoría para una respuesta en la sesión.

AuditRequestInfo

Entrada de auditoría para una solicitud en la sesión.

FaceError

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

FaceErrorResponse

Respuesta que contiene los detalles del error.

FaceRectangle

Rectángulo dentro del cual se puede encontrar una cara.

FaceSessionStatus

Estado actual de la sesión.

ImageType

Tipo de imagen.

LivenessDecision

Resultado de la clasificación de vida.

LivenessModel

La versión del modelo utilizada para la clasificación de ejecución.

LivenessOutputsTarget

Clasificación de vida de la cara de destino.

LivenessResponseBody

Cuerpo de respuesta de la llamada API de detección de liveness.

LivenessSession

Resultado de la sesión de detección de ejecución.

LivenessSessionAuditEntry

Entrada de auditoría de una solicitud en la sesión.

LivenessWithVerifyImage

Detalle de la cara para la verificación.

LivenessWithVerifyOutputs

Salida de comprobación facial.

QualityForRecognition

Indica la calidad de la imagen para el reconocimiento.

AuditLivenessResponseInfo

Entrada de auditoría para una respuesta en la sesión.

Nombre Tipo Description
body

LivenessResponseBody

Cuerpo de la respuesta. El esquema de este campo dependerá del método request.url y request.method usado por el cliente.

latencyInMilliseconds

integer

Latencia de medición del servidor para esta solicitud en milisegundos.

statusCode

integer

Código de estado HTTP devuelto al cliente.

AuditRequestInfo

Entrada de auditoría para una solicitud en la sesión.

Nombre Tipo Description
contentLength

integer

La longitud del cuerpo de la solicitud en bytes.

contentType

string

Tipo de contenido de la solicitud.

method

string

Método HTTP de la solicitud (es decir, GET, POST, DELETE).

url

string

Dirección URL relativa y consulta de la solicitud de ejecución.

userAgent

string

Agente de usuario usado para enviar la solicitud.

FaceError

Objeto de error. Para obtener detalles completos sobre los códigos de error y los mensajes devueltos por face Service, consulte el siguiente vínculo: 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.

FaceRectangle

Rectángulo dentro del cual se puede encontrar una cara.

Nombre Tipo Description
height

integer

Alto del rectángulo, en píxeles.

left

integer

Distancia desde el borde izquierdo si la imagen al borde izquierdo del rectángulo, en píxeles.

top

integer

Distancia desde el borde superior si la imagen hasta el borde superior del rectángulo, en píxeles.

width

integer

Ancho del rectángulo, en píxeles.

FaceSessionStatus

Estado actual de la sesión.

Nombre Tipo Description
NotStarted

string

La sesión no se ha iniciado.

ResultAvailable

string

La sesión tiene el resultado disponible.

Started

string

Se ha iniciado la sesión.

ImageType

Tipo de imagen.

Nombre Tipo Description
Color

string

Imagen de color.

Depth

string

Imagen de profundidad.

Infrared

string

Imagen de infrarrojos.

LivenessDecision

Resultado de la clasificación de vida.

Nombre Tipo Description
realface

string

El algoritmo ha clasificado la cara de destino como real.

spoofface

string

El algoritmo ha clasificado la cara de destino como una suplantación de identidad.

uncertain

string

El algoritmo no pudo clasificar la cara de destino como real o suplantación de identidad.

LivenessModel

La versión del modelo utilizada para la clasificación de ejecución.

Nombre Tipo Description
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

Clasificación de vida de la cara de destino.

Nombre Tipo Description
faceRectangle

FaceRectangle

Región de cara en la que se realizó la clasificación de vida.

fileName

string

Nombre de archivo que contiene el rectángulo facial en el que se realizó la clasificación de vida.

imageType

ImageType

Tipo de imagen que contiene el rectángulo facial en el que se realizó la clasificación de ejecución.

timeOffsetWithinFile

integer

Desplazamiento de tiempo dentro del archivo del marco que contiene el rectángulo facial en el que se realizó la clasificación de vida.

LivenessResponseBody

Cuerpo de respuesta de la llamada API de detección de liveness.

Nombre Tipo Description
livenessDecision

LivenessDecision

Clasificación de vida de la cara de destino.

modelVersionUsed

LivenessModel

La versión del modelo utilizada para la clasificación de ejecución.

target

LivenessOutputsTarget

Destinos específicos usados para la clasificación de vida.

verifyResult

LivenessWithVerifyOutputs

Salida de comprobación facial. Solo está disponible cuando la solicitud es activa con comprobación.

LivenessSession

Resultado de la sesión de detección de ejecució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 para hacer referencia a esta sesión.

result

LivenessSessionAuditEntry

El resultado de la auditoría de sesión más reciente solo se rellena si status == 'ResultAvailable'.

sessionExpired

boolean

Si la sesión ha expirado o no.

sessionStartDateTime

string

DateTime cuando el cliente inició esta sesión.

status

FaceSessionStatus

Estado actual de la sesión.

LivenessSessionAuditEntry

Entrada de auditoría de una solicitud en la sesión.

Nombre Tipo Description
clientRequestId

string

ClientRequestId único que envía el cliente en el encabezado "client-request-id".

digest

string

Resumen calculado del servidor para esta solicitud. Si el resumen notificado por el cliente difiere del resumen calculado del servidor, la integridad del mensaje entre el cliente y el servicio se ha puesto en peligro y el resultado no debe ser de confianza. Para obtener más información, consulte guías sobre cómo aprovechar este valor para proteger la solución de un extremo a otro.

id

integer

Identificador único para hacer referencia a esta solicitud de auditoría. Use este identificador con el parámetro de consulta "start" para continuar con la página siguiente de los resultados de auditoría.

receivedDateTime

string

Fecha UTC DateTime que se recibió la solicitud.

request

AuditRequestInfo

Solicitud de esta entrada.

requestId

string

RequestId único que devuelve el servicio al cliente en el encabezado "apim-request-id".

response

AuditLivenessResponseInfo

Respuesta de esta entrada.

sessionId

string

El valor de sessionId único de la sesión creada. Expirará 48 horas después de crearla o puede eliminarse antes mediante la operación DELETE de sesión correspondiente.

LivenessWithVerifyImage

Detalle de la cara para la verificación.

Nombre Tipo Description
faceRectangle

FaceRectangle

Región de la cara donde se realizó la clasificación de la imagen de comparación.

qualityForRecognition

QualityForRecognition

Calidad de la imagen facial para el reconocimiento.

LivenessWithVerifyOutputs

Salida de comprobación facial.

Nombre Tipo Description
isIdentical

boolean

Si la cara de la vida de destino y la coincidencia de la cara de imagen de comparación.

matchConfidence

number

La cara de destino cara activa y la confianza de la comprobación facial de la imagen de comparación.

verifyImage

LivenessWithVerifyImage

Detalle de la cara para la verificación.

QualityForRecognition

Indica la calidad de la imagen para el reconocimiento.

Nombre Tipo Description
high

string

Calidad alta.

low

string

Baja calidad.

medium

string

Calidad media.