liveness_session_results

Creates, updates, deletes, gets or lists a liveness_session_results resource.

Overview

Name	liveness_session_results
Type	Resource
Id	azure.ai_vision_face.liveness_session_results

Fields

The following fields are returned by SELECT queries:

get_liveness_session_result

Name	Datatype	Description
id	string	The unique ID to reference this session. Required.
authTokenTimeToLiveInSeconds	integer	Seconds the session should last for. Range is 60 to 86400 seconds. Default value is 600.
createdDateTime	string (date-time)	DateTime when this session was created. Required.
deviceCorrelationId	string	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.
result	object	The latest session audit result only populated if status == 'ResultAvailable'.
sessionExpired	boolean	Whether or not the session is expired. Required.
sessionStartDateTime	string (date-time)	DateTime when this session was started by the client.
status	string	The current status of the session. Required. Known values are: "NotStarted", "Started", and "ResultAvailable". (NotStarted, Started, ResultAvailable)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_liveness_session_result	select	session_id, endpoint, api_version		Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-liveness-session-result for more details.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_version	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client apiVersion parameter. (default: )
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
session_id	string	The unique ID to reference this session. Required.

SELECT examples

get_liveness_session_result

Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-liveness-session-result for more details.

SELECT
id,
authTokenTimeToLiveInSeconds,
createdDateTime,
deviceCorrelationId,
result,
sessionExpired,
sessionStartDateTime,
status
FROM azure.ai_vision_face.liveness_session_results
WHERE session_id = '{{ session_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND api_version = '{{ api_version }}' -- required
;