Liveness Session Operations - Get Liveness With Verify Session Audit Entries

Servicio:

Azure AI Services

Versión de la API:

v1.2-preview.1

Obtiene las solicitudes de sesión y el cuerpo de la respuesta de la sesión.

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

Con parámetros opcionales:

GET {endpoint}/face/{apiVersion}/detectLivenessWithVerify/singleModal/sessions/{sessionId}/audit?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).
sessionId	path	True	string	Identificador único que se va a hacer referencia a esta sesión.
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	LivenessSessionAuditEntry[]	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 Session Audit Entries

Solicitud de ejemplo

HTTP

GET {endpoint}/face/v1.2-preview.1/detectLivenessWithVerify/singleModal/sessions/b12e033e-bda7-4b83-a211-e721c661f30e/audit?start=0&top=20

Respuesta de muestra

status code:

200

[
  {
    "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.2-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 de una respuesta en la sesión.
AuditRequestInfo	Entrada de auditoría de 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 vínculo siguiente: 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.
ImageType	Tipo de imagen.
LivenessDecision	Resultado de la clasificación de vida.
LivenessModel	Versión del modelo que se usa para la clasificación de vida.
LivenessOutputsTarget	Clasificación de vida de la cara de destino.
LivenessResponseBody	Cuerpo de respuesta de la llamada API de detección de liveness.
LivenessSessionAuditEntry	Entrada de auditoría de una solicitud en la sesión.
LivenessWithVerifyImage	Detalle de la cara para la comprobación.
LivenessWithVerifyOutputs	Salida de comprobación facial.
QualityForRecognition	Indica la calidad de la imagen para el reconocimiento.

AuditLivenessResponseInfo

Entrada de auditoría de 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	La latencia medida del servidor para esta solicitud en milisegundos.
statusCode	integer	Código de estado HTTP devuelto al cliente.

AuditRequestInfo

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

Nombre	Tipo	Description
contentLength	integer	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 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.

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.

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

Versión del modelo que se usa para la clasificación de vida.

Nombre	Tipo	Description
2022-10-15-preview.04	string
2023-12-20-preview.06	string

LivenessOutputsTarget

Clasificación de vida de la cara de destino.

Nombre	Tipo	Description
faceRectangle	FaceRectangle	Región facial 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 vida.
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	Versión del modelo que se usa para la clasificación de vida.
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 la comprobació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 siguiente página de resultados de auditoría.
receivedDateTime	string	Fecha y hora UTC en que se recibió la solicitud.
request	AuditRequestInfo	Solicitud de esta entrada.
requestId	string	RequestId único devuelto por el servicio al cliente en el encabezado "apim-request-id".
response	AuditLivenessResponseInfo	Respuesta de esta entrada.
sessionId	string	SessionId único de la sesión creada. Expirará 48 horas después de su creación o se puede eliminar antes mediante la operación DELETE de sesión correspondiente.
sessionImageId	string	Identificador de imagen de la solicitud de sesión.
verifyImageHash	string	Hash sha256 de la imagen de comprobación en la solicitud.

LivenessWithVerifyImage

Detalle de la cara para la comprobación.

Nombre	Tipo	Description
faceRectangle	FaceRectangle	Región facial en la que 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	Confianza de verificación facial de comparación y cara de destino.
verifyImage	LivenessWithVerifyImage	Detalle de la cara para la comprobación.

QualityForRecognition

Indica la calidad de la imagen para el reconocimiento.

Nombre	Tipo	Description
high	string	Alta calidad.
low	string	Baja calidad.
medium	string	Calidad media.