Liveness Session Operations - Get Liveness Session Audit Entries

Référence

Service:: Azure AI Services

Version d'API:: v1.1-preview.1

Obtient les requêtes de session et le corps de réponse pour la session.

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

Avec des paramètres facultatifs:

GET {endpoint}/face/{apiVersion}/detectLiveness/singleModal/sessions/{sessionId}/audit?start={start}&top={top}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
apiVersion	path	True	string	Version d'API
endpoint	path	True	string uri	Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://{nom-ressource}.cognitiveservices.azure.com).
sessionId	path	True	string	ID unique pour référencer cette session.
start	query		string	Répertorier les ressources supérieures au « start ». Il ne contient pas plus de 64 caractères. La valeur par défaut est vide,
top	query		integer int32	Nombre d’éléments à répertorier, compris dans [1, 1000]. La valeur par défaut est 1000.

Réponses

Nom	Type	Description
200 OK	LivenessSessionAuditEntry[]	La demande a réussi.
Other Status Codes	FaceErrorResponse	Réponse d’erreur inattendue. En-têtes x-ms-error-code: string

Nom

Type

Description

200 OK

LivenessSessionAuditEntry[]

La demande a réussi.

Other Status Codes

FaceErrorResponse

Réponse d’erreur inattendue.

En-têtes

x-ms-error-code: string

Sécurité

Ocp-Apim-Subscription-Key

Clé secrète de votre abonnement Azure AI Face.

Type: apiKey
Dans: header

AADToken

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: accessCode
URL d’autorisation: https://api.example.com/oauth2/authorize
URL du jeton: https://api.example.com/oauth2/token

Étendues

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

Exemples

Get LivenessSession Audit Entries

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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.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"
  }
]

Définitions

Nom	Description
AuditLivenessResponseInfo	Entrée d’audit pour une réponse dans la session.
AuditRequestInfo	Entrée d’audit pour une requête dans la session.
FaceError	Objet d’erreur. Pour plus d’informations sur les codes d’erreur et les messages retournés par le service Visage, reportez-vous au lien suivant : https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Réponse contenant les détails de l’erreur.
FaceRectangle	Rectangle dans lequel un visage peut être trouvé.
ImageType	Type d’image.
LivenessDecision	Résultat de la classification liveness.
LivenessModel	Version du modèle utilisée pour la classification liveness.
LivenessOutputsTarget	Classification de la vivacité pour le visage cible.
LivenessResponseBody	Corps de réponse de détecter l’appel d’API liveness.
LivenessSessionAuditEntry	Entrée d’audit pour une requête en session.
LivenessWithVerifyImage	Détail du visage pour la vérification.
LivenessWithVerifyOutputs	Sortie de vérification faciale.
QualityForRecognition	Indique la qualité de l’image pour la reconnaissance.

AuditLivenessResponseInfo

Entrée d’audit pour une réponse dans la session.

Nom	Type	Description
body	LivenessResponseBody	Corps de la réponse. Le schéma de ce champ dépend de la requête.url et de la méthode request.method utilisées par le client.
latencyInMilliseconds	integer	Le serveur a mesuré la latence de cette requête en millisecondes.
statusCode	integer	Le code http status retourné au client.

AuditRequestInfo

Entrée d’audit pour une requête dans la session.

Nom	Type	Description
contentLength	integer	Longueur du corps de la demande, exprimée en octets.
contentType	string	Type de contenu de la demande.
method	string	Méthode HTTP de la requête (par exemple, GET, POST, DELETE).
url	string	URL relative et requête de la demande liveness.
userAgent	string	Agent utilisateur utilisé pour envoyer la demande.

FaceError

Objet d’erreur. Pour plus d’informations sur les codes d’erreur et les messages retournés par le service Visage, reportez-vous au lien suivant : https://aka.ms/face-error-codes-and-messages.

Nom	Type	Description
code	string	Un des codes d’erreur définis par le serveur.
message	string	Représentation lisible par l’homme de l’erreur.

FaceErrorResponse

Réponse contenant les détails de l’erreur.

Nom	Type	Description
error	FaceError	Objet d’erreur.

FaceRectangle

Rectangle dans lequel un visage peut être trouvé.

Nom	Type	Description
height	integer	Hauteur du rectangle, en pixels.
left	integer	Distance du bord gauche si l’image se trouve sur le bord gauche du rectangle, en pixels.
top	integer	Distance entre le bord supérieur si l’image et le bord supérieur du rectangle, en pixels.
width	integer	Largeur du rectangle, en pixels.

ImageType

Type d’image.

Nom	Type	Description
Color	string	Image en couleur.
Depth	string	Image de profondeur.
Infrared	string	Image infrarouge.

LivenessDecision

Résultat de la classification liveness.

Nom	Type	Description
realface	string	L’algorithme a classé le visage cible comme réel.
spoofface	string	L’algorithme a classé le visage cible en tant qu’usurpation.
uncertain	string	L’algorithme n’a pas pu classer le visage cible comme étant réel ou usurpé.

LivenessModel

Version du modèle utilisée pour la classification liveness.

Nom	Type	Description
2022-10-15-preview.04	string
2023-12-20-preview.06	string

LivenessOutputsTarget

Classification de la vivacité pour le visage cible.

Nom	Type	Description
faceRectangle	FaceRectangle	Région de visage sur laquelle la classification liveness a été effectuée.
fileName	string	Nom de fichier qui contient le rectangle de visage sur lequel la classification liveness a été effectuée.
imageType	ImageType	Type d’image qui contient le rectangle de visage sur lequel la classification liveness a été effectuée.
timeOffsetWithinFile	integer	Décalage de temps dans le fichier de l’image qui contient le rectangle de visage sur lequel la classification d’animation a été effectuée.

LivenessResponseBody

Corps de réponse de détecter l’appel d’API liveness.

Nom	Type	Description
livenessDecision	LivenessDecision	Classification de la vivacité pour le visage cible.
modelVersionUsed	LivenessModel	Version du modèle utilisée pour la classification liveness.
target	LivenessOutputsTarget	Cibles spécifiques utilisées pour la classification liveness.
verifyResult	LivenessWithVerifyOutputs	Sortie de vérification faciale. Disponible uniquement lorsque la demande est active avec verify.

LivenessSessionAuditEntry

Entrée d’audit pour une requête en session.

Nom	Type	Description
clientRequestId	string	ClientRequestId unique envoyé par le client dans l’en-tête « client-request-id ».
digest	string	Le serveur a calculé la synthèse pour cette requête. Si la synthèse signalée par le client diffère de la synthèse calculée par le serveur, l’intégrité du message entre le client et le service a été compromise et le résultat ne doit pas être approuvé. Pour plus d’informations, consultez guide sur la façon de tirer parti de cette valeur pour sécuriser votre solution de bout en bout.
id	integer	ID unique à référencer à cette demande d’audit. Utilisez cet ID avec le paramètre de requête « start » pour passer à la page suivante des résultats de l’audit.
receivedDateTime	string	DateTime UTC à laquelle la demande a été reçue.
request	AuditRequestInfo	Demande de cette entrée.
requestId	string	Id de requête unique retourné par le service au client dans l’en-tête « apim-request-id ».
response	AuditLivenessResponseInfo	Réponse de cette entrée.
sessionId	string	SessionId unique de la session créée. Il expirera 48 heures après sa création ou peut être supprimé plus tôt à l’aide de l’opération DELETE de session correspondante.

LivenessWithVerifyImage

Détail du visage pour la vérification.

Nom	Type	Description
faceRectangle	FaceRectangle	Région du visage où la classification de l’image de comparaison a été effectuée.
qualityForRecognition	QualityForRecognition	Qualité de l’image du visage pour la reconnaissance.

LivenessWithVerifyOutputs

Sortie de vérification faciale.

Nom	Type	Description
isIdentical	boolean	Si le visage liveness cible et le visage de l’image de comparaison correspondent.
matchConfidence	number	Confiance de la vérification du visage et de l’image de comparaison du visage cible.
verifyImage	LivenessWithVerifyImage	Détail du visage pour la vérification.

QualityForRecognition

Indique la qualité de l’image pour la reconnaissance.

Nom	Type	Description
high	string	Qualité élevée.
low	string	Qualité médiocre.
medium	string	Qualité moyenne.

Partager via

Liveness Session Operations - Get Liveness Session Audit Entries

Paramètres URI

Réponses

Sécurité

Ocp-Apim-Subscription-Key

AADToken

Étendues

Exemples

Get LivenessSession Audit Entries

Exemple de requête

Exemple de réponse

Définitions

AuditLivenessResponseInfo

AuditRequestInfo

FaceError

FaceErrorResponse

FaceRectangle

ImageType

LivenessDecision

LivenessModel

LivenessOutputsTarget

LivenessResponseBody

LivenessSessionAuditEntry

LivenessWithVerifyImage

LivenessWithVerifyOutputs

QualityForRecognition

Ressources supplémentaires