Share via


CreateLivenessSessionContent Class

Definition

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Request model for creating liveness session.

public class CreateLivenessSessionContent : System.ClientModel.Primitives.IJsonModel<Azure.AI.Vision.Face.CreateLivenessSessionContent>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Vision.Face.CreateLivenessSessionContent>
Inheritance
CreateLivenessSessionContent
Implements

Constructors

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.

LivenessOperationMode

Type of liveness mode the client should follow.

LivenessSingleModalModel

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.

SendResultsToClient

Whether or not to allow a '200 - Success' response body to be sent to the client, which may be undesirable for security reasons. Default is false, clients will receive a '204 - NoContent' empty body response. Regardless of selection, calling Session GetResult will always contain a response body enabling business logic to be implemented.

Explicit Interface Implementations

Applies to

Product Versions
Azure SDK for .NET Preview