Partager via

Liveness Session Operations - Get Liveness With Verify Session Result

  • Référence
Service:
Azure AI Services
Version d'API:
v1.2-preview.1

Obtenez le résultat de session de l’appel detectLivenessWithVerify/singleModal.

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

Paramètres URI

Nom Dans Obligatoire Type Description
apiVersion
 path True

string

Version de l’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 à référencer cette session.

Réponses

Nom Type Description
200 OK

LivenessWithVerifySession

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 LivenessWithVerify Session Result

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
AuditLivenessResponseInfo

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

Entrée d’audit pour une demande 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é.
FaceSessionStatus

État actuel de la session.
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 l’liveness pour le visage cible.
LivenessResponseBody

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

Entrée d’audit pour une demande dans la session.
LivenessWithVerifyImage

Détail du visage pour la vérification.
LivenessWithVerifyOutputs

Sortie de vérification des visages.
LivenessWithVerifySession

Résultat de la session de détection de la durée de vie avec vérification.
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 request.url et request.method utilisés par le client.
latencyInMilliseconds

integer

Le serveur a mesuré la latence de cette requête en millisecondes.
statusCode

integer

Code d’état HTTP retourné au client.

AuditRequestInfo

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

Nom Type Description
contentLength

integer

Longueur du corps de la requête en octets.
contentType

string

Type de contenu de la requête.
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 ensemble de 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 au bord gauche du rectangle, en pixels.
top

integer

Distance du bord supérieur si l’image au bord supérieur du rectangle, en pixels.
width

integer

Largeur du rectangle, en pixels.

FaceSessionStatus

État actuel de la session.

Nom Type Description
NotStarted

string

La session n’a pas démarré.
ResultAvailable

string

La session a un résultat disponible.
Started

string

La session a démarré.

ImageType

Type d’image.

Nom Type Description
Color

string

Image de 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 comme usurpation d’identité.
uncertain

string

L’algorithme n’a pas pu classifier le visage cible comme étant réel ou usurpateur d’identité.

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 l’liveness pour le visage cible.

Nom Type Description
faceRectangle

FaceRectangle

Région de visage sur laquelle la classification de la vie 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 de la durée de vie a été effectuée.

LivenessResponseBody

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

Nom Type Description
livenessDecision

LivenessDecision

Classification de la durée de vie du 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 des visages. Disponible uniquement lorsque la demande est active avec vérification.

LivenessSessionAuditEntry

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

Nom Type Description
clientRequestId

string

ClientRequestId unique envoyé par le client dans l’en-tête « client-request-id ».
digest

string

Digest calculé par le serveur pour cette requête. Si le résumé signalé par le client diffère du digest calculé 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 comment découvrir comment 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 d’audit.
receivedDateTime

string

DateTime UTC reçu par la requête.
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

Id de session unique de la session créée. Il expire 48 heures après sa création ou peut être supprimé plus tôt à l’aide de l’opération DELETE de session correspondante.
sessionImageId

string

ID d’image de la demande de session.
verifyImageHash

string

Hachage sha256 de l’image de vérification dans la requête.

LivenessWithVerifyImage

Détail du visage pour la vérification.

Nom Type Description
faceRectangle

FaceRectangle

Région de visage où la classification de l’image de comparaison a été effectuée.
qualityForRecognition

QualityForRecognition

Qualité de l’image faciale pour la reconnaissance.

LivenessWithVerifyOutputs

Sortie de vérification des visages.

Nom Type Description
isIdentical

boolean

Indique si le visage liveness cible et la correspondance de l’image de comparaison.
matchConfidence

number

Visage cible dynamique et confiance de la vérification des visages de comparaison.
verifyImage

LivenessWithVerifyImage

Détail du visage pour la vérification.

LivenessWithVerifySession

Résultat de la session de détection de la durée de vie avec vérification.

Nom Type Valeur par défaut Description
authTokenTimeToLiveInSeconds

integer

600

Secondes pendant lesquelles la session doit durer. La plage est comprise entre 60 et 86400 secondes. La valeur par défaut est 600.
createdDateTime

string

DateTime lors de la création de cette session.
deviceCorrelationId

string

Guid unique par appareil de l’utilisateur final. Il s’agit de fournir une limitation de débit et un anti-marteau. Si « deviceCorrelationIdSetInClient » a la valeur true dans cette requête, ce « deviceCorrelationId » doit être null.
id

string

ID unique à référencer cette session.
result

LivenessSessionAuditEntry

Le résultat de l’audit de session le plus récent est renseigné uniquement si l’état == 'ResultAvailable'.
sessionExpired

boolean

Indique si la session a expiré ou non.
sessionStartDateTime

string

DateTime quand cette session a été démarrée par le client.
status

FaceSessionStatus

État actuel de la session.

QualityForRecognition

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

Nom Type Description
high

string

Haute qualité.
low

string

Qualité faible.
medium

string

Qualité moyenne.