CreateLivenessSessionResult Class

Response of liveness session creation.

Inheritance

azure.ai.vision.face._model_base.Model

CreateLivenessSessionResult

Constructor

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

Variables

Name	Description
session_id	str The unique session ID of the created session. It will expire 48 hours after it was created or may be deleted sooner using the corresponding Session DELETE operation. Required.
auth_token	str Bearer token to provide authentication for the Vision SDK running on a client application. This Bearer token has limited permissions to perform only the required action and expires after the TTL time. It is also auditable. Required.

Methods

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

as_dict

Return a dict that can be turned into json 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

Bearer token to provide authentication for the Vision SDK running on a client application. This Bearer token has limited permissions to perform only the required action and expires after the TTL time. It is also auditable. Required.

auth_token: str

session_id

The unique session ID of the created session. It will expire 48 hours after it was created or may be deleted sooner using the corresponding Session DELETE operation. Required.

session_id: str