CreateLivenessSessionContent interface

Package:

@azure-rest/ai-vision-face

Request model for creating liveness session.

Properties

authTokenTimeToLiveInSeconds	Seconds the session should last for. Range is 60 to 86400 seconds. Default value is 600.
deviceCorrelationId	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.
deviceCorrelationIdSetInClient	Whether or not to allow client to set their own 'deviceCorrelationId' via the Vision SDK. Default is false, and 'deviceCorrelationId' must be set in this request body.
enableSessionImage	Whether or not store the session image.
livenessModelVersion	The model version used for liveness classification. This is an optional parameter, and if this is not specified, then the latest supported model version will be chosen Possible values: "2024-11-15"
livenessOperationMode	Type of liveness mode the client should follow. Possible values: "Passive", "PassiveActive"

Property Details

authTokenTimeToLiveInSeconds

Seconds the session should last for. Range is 60 to 86400 seconds. Default value is 600.

authTokenTimeToLiveInSeconds?: number

Property Value

number

deviceCorrelationId

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.

deviceCorrelationId?: string

Property Value

string

deviceCorrelationIdSetInClient

Whether or not to allow client to set their own 'deviceCorrelationId' via the Vision SDK. Default is false, and 'deviceCorrelationId' must be set in this request body.

deviceCorrelationIdSetInClient?: boolean

Property Value

boolean

enableSessionImage

Whether or not store the session image.

enableSessionImage?: boolean

Property Value

boolean

livenessModelVersion

The model version used for liveness classification. This is an optional parameter, and if this is not specified, then the latest supported model version will be chosen

Possible values: "2024-11-15"

livenessModelVersion?: string

Property Value

string

livenessOperationMode

Type of liveness mode the client should follow.

Possible values: "Passive", "PassiveActive"

livenessOperationMode: string

Property Value

string