Liveness Session Operations - Get Liveness Sessions

Service:

Azure AI Services

Version d'API:

v1.2-preview.1

Répertorie les sessions pour /detectLiveness/SingleModal.
Répertorie les sessions de la dernière sessionId supérieure à la valeur « start ».

Le résultat doit être ordonné par sessionId dans l’ordre croissant.

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

Avec des paramètres facultatifs:

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

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).
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 1 000.

Réponses

Nom	Type	Description
200 OK	LivenessSessionItem[]	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 LivenessSessions

Exemple de requête

HTTP

GET {endpoint}/face/v1.2-preview.1/detectLiveness/singleModal/sessions?start=00000000-0000-0000-0000-000000000000&top=20

Exemple de réponse

Code d’état:

200

[
  {
    "id": "b12e033e-bda7-4b83-a211-e721c661f30e",
    "createdDateTime": "2024-03-05T11:07:28.540Z",
    "sessionStartDateTime": "2024-03-05T11:07:28.540Z",
    "sessionExpired": true,
    "deviceCorrelationId": "your_device_correlation_id",
    "authTokenTimeToLiveInSeconds": 60
  }
]

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.
LivenessSessionItem	Données de session retournées pour l’énumération.

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.

LivenessSessionItem

Données de session retournées pour l’énumération.

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.
sessionExpired	boolean		Indique si la session a expiré ou non.
sessionStartDateTime	string		DateTime quand cette session a été démarrée par le client.