CreateLivenessSessionContent Class

Request for creating liveness session.

All required parameters must be populated in order to send to server.

Inheritance

azure.ai.vision.face._model_base.Model

CreateLivenessSessionContent

Constructor

CreateLivenessSessionContent(*args: Any, **kwargs: Any)

Variables

Name	Description
liveness_operation_mode	str or LivenessOperationMode Type of liveness mode the client should follow. Required. Known values are: "Passive" and "PassiveActive".
send_results_to_client	bool 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.
device_correlation_id_set_in_client	bool 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.
device_correlation_id	str 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.
auth_token_time_to_live_in_seconds	int Seconds the session should last for. Range is 60 to 86400 seconds. Default value is 600.

Methods

as_dict	Return a dict that can be JSONify using json.dump.
clear
copy
get
items
keys
pop
popitem
setdefault
update
values

as_dict

Return a dict that can be JSONify using json.dump.

as_dict(*, exclude_readonly: bool = False) -> Dict[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties.

Returns

Type	Description
dict	A dict JSON compatible object

clear

clear() -> None

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties.

copy

copy() -> Model

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties.

get

get(key: str, default: Any = None) -> Any

Parameters

Name	Description
key Required
default	Default value: None

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties.

items

items() -> ItemsView[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties.

keys

keys() -> KeysView[str]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties.

pop

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties.

popitem

popitem() -> Tuple[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties.

setdefault

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties.

update

update(*args: Any, **kwargs: Any) -> None

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties.

values

values() -> ValuesView[Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties.

Attributes

auth_token_time_to_live_in_seconds

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

auth_token_time_to_live_in_seconds: int | None

device_correlation_id

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.

device_correlation_id: str | None

device_correlation_id_set_in_client

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.

device_correlation_id_set_in_client: bool | None

liveness_operation_mode

"Passive" and "PassiveActive".

liveness_operation_mode: str | _models.LivenessOperationMode

send_results_to_client

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.

send_results_to_client: bool | None