Azure AI Face API (preview:v1.2.1)

2025/01/18 • 1 updated methods

LivenessSessionOperations_GetLivenessWithVerifySessions (updated)
Description :  List sessions from the last sessionId greater than the 'start'. The result should be ordered by sessionId in ascending order.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LivenessSessionOperations_GetLivenessWithVerifySessions",
  "Description": {
    "new": "List sessions from the last sessionId greater than the 'start'.\n\nThe result should be ordered by sessionId in ascending order.",
    "old": "List sessions from the last sessionId greater than the \"start\".\n\nThe result should be ordered by sessionId in ascending order."
  }
}

⚼ Request

GET:  /detectLivenessWithVerify/singleModal/sessions
{
start:
{
Description: List resources greater than the "start". It contains no more than 64 characters. Default is empty. ,
Required: False ,
}
string ,
top:
{
Description: The number of items to list, ranging in [1, 1000]. Default is 1000. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
id:
{
Description: The unique ID to reference this session. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: DateTime when this session was created. ,
Format: date-time ,
Required: True ,
}
string ,
sessionStartDateTime:
{
Description: DateTime when this session was started by the client. ,
Format: date-time ,
Required: False ,
}
string ,
sessionExpired:
{
Description: Whether or not the session is expired. ,
Required: True ,
}
boolean ,
deviceCorrelationId:
{
Description: Unique Guid per each end-user device. This is to provide rate limiting and anti-hammering. If 'deviceCorrelationIdSetInClient' is true in this request, this 'deviceCorrelationId' must be null. ,
Required: False ,
}
string ,
authTokenTimeToLiveInSeconds:
{
Description: Seconds the session should last for. Range is 60 to 86400 seconds. Default value is 600. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
}
,
}
,
}