Partager via


Liveness Session Operations - Get Liveness Session Result

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

GET {endpoint}/face/{apiVersion}/detectLiveness-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

LivenessSession

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 Result

Exemple de requête

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

Exemple de réponse

{
  "sessionId": "b12e033e-bda7-4b83-a211-e721c661f30e",
  "authToken": "eyJhbGciOiJFUzI1NiIsIm",
  "status": "NotStarted",
  "modelVersion": "2024-11-15",
  "results": {
    "attempts": [
      {
        "attemptId": 2,
        "attemptStatus": "Succeeded",
        "result": {
          "livenessDecision": "realface",
          "targets": {
            "color": {
              "faceRectangle": {
                "top": 669,
                "left": 203,
                "width": 646,
                "height": 724
              }
            }
          },
          "digest": "B0A803BB7B26F3C8F29CD36030F8E63ED3FAF955FEEF8E01C88AB8FD89CCF761",
          "sessionImageId": "Ae3PVWlXAmVAnXgkAFt1QSjGUWONKzWiSr2iPh9p9G4I"
        }
      },
      {
        "attemptId": 1,
        "attemptStatus": "Failed",
        "error": {
          "code": "FaceWithMaskDetected",
          "message": "Mask detected on face image.",
          "targets": {
            "color": {
              "faceRectangle": {
                "top": 669,
                "left": 203,
                "width": 646,
                "height": 724
              }
            }
          }
        }
      }
    ]
  }
}

Définitions

Nom Description
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é.

LivenessColorDecisionTarget

Cible de l’image de couleur utilisée pour la classification liveness.

LivenessDecision

Résultat de la classification liveness.

LivenessDecisionTargets

Cibles utilisées pour la classification liveness.

LivenessError

Erreur de la classification liveness.

LivenessModel

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

LivenessResult

Résultats de la classification liveness.

LivenessSession

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

LivenessSessionAttempt

Tentative de session liveness.

LivenessSessionResults

Résultats de la session liveness.

OperationState

État actuel de 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.

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 (int32)

Hauteur du rectangle, en pixels.

left

integer (int32)

Distance du bord gauche si l’image au bord gauche du rectangle, en pixels.

top

integer (int32)

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

width

integer (int32)

Largeur du rectangle, en pixels.

LivenessColorDecisionTarget

Cible de l’image de couleur utilisée pour la classification liveness.

Nom Type Description
faceRectangle

FaceRectangle

Région de visage sur laquelle la classification de la vie a été effectuée.

LivenessDecision

Résultat de la classification liveness.

Valeur Description
uncertain

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

realface

L’algorithme a classé le visage cible comme réel.

spoofface

L’algorithme a classé le visage cible comme usurpation d’identité.

LivenessDecisionTargets

Cibles utilisées pour la classification liveness.

Nom Type Description
color

LivenessColorDecisionTarget

Cible de l’image de couleur utilisée pour la classification liveness.

LivenessError

Erreur de la classification liveness.

Nom Type Description
code

string

Code d’erreur.

message

string

Message d’erreur.

targets

LivenessDecisionTargets

Cibles utilisées pour la classification liveness.

LivenessModel

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

Valeur Description
2024-11-15

LivenessResult

Résultats de la classification liveness.

Nom Type Description
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.

livenessDecision

LivenessDecision

Classification de la durée de vie du visage cible.

sessionImageId

string

ID d’image de la demande de session.

targets

LivenessDecisionTargets

Cibles utilisées pour la classification liveness.

LivenessSession

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

Nom Type Description
authToken

string

Jeton du porteur pour fournir l’authentification pour le Kit de développement logiciel (SDK) Vision s’exécutant sur une application cliente. Ce jeton du porteur dispose d’autorisations limitées pour effectuer uniquement l’action requise et expire après la durée de vie. Il est également auditable.

modelVersion

LivenessModel

Version du modèle utilisée pour la classification liveness. Il s’agit d’un paramètre facultatif et, s’il n’est pas spécifié, la dernière version de modèle prise en charge sera choisie.

results

LivenessSessionResults

Résultats de la session liveness.

sessionId

string

ID unique à référencer cette session.

status

OperationState

État actuel de la session.

LivenessSessionAttempt

Tentative de session liveness.

Nom Type Description
attemptId

integer (int32)

L’ID de tentative, commence à partir de 1.

attemptStatus

OperationState

État de la tentative.

error

LivenessError

L’erreur de l’appel liveness est null en cas de résultat.

result

LivenessResult

Le résultat de l’appel liveness est null en cas d’erreur.

LivenessSessionResults

Résultats de la session liveness.

Nom Type Description
attempts

LivenessSessionAttempt[]

Les tentatives de données d’appel liveness sous-jacent avec la session.

OperationState

État actuel de la session.

Valeur Description
NotStarted

L’opération n’a pas démarré.

Running

L’opération est en cours.

Succeeded

L’opération s’est terminée avec succès.

Failed

L’opération a échoué.

Canceled

L’opération a été annulée par l’utilisateur.