LivenessSessionAuditEntry Class

Audit entry for a request in session.

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

Inheritance

azure.ai.vision.face._model_base.Model

LivenessSessionAuditEntry

Constructor

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

Variables

Name	Description
id	int The unique id to refer to this audit request. Use this id with the 'start' query parameter to continue on to the next page of audit results. Required.
session_id	str The unique sessionId 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.
request_id	str The unique requestId that is returned by the service to the client in the 'apim-request-id' header. Required.
client_request_id	str The unique clientRequestId that is sent by the client in the 'client-request-id' header. Required.
received_date_time	datetime The UTC DateTime that the request was received. Required.
request	AuditRequestInfo The request of this entry. Required.
response	AuditLivenessResponseInfo The response of this entry. Required.
digest	str The server calculated digest for this request. If the client reported digest differs from the server calculated digest, then the message integrity between the client and service has been compromised and the result should not be trusted. For more information, see how to guides on how to leverage this value to secure your end-to-end solution. Required.

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

client_request_id

The unique clientRequestId that is sent by the client in the 'client-request-id' header. Required.

client_request_id: str

digest

The server calculated digest for this request. If the client reported digest differs from the server calculated digest, then the message integrity between the client and service has been compromised and the result should not be trusted. For more information, see how to guides on how to leverage this value to secure your end-to-end solution. Required.

digest: str

id

The unique id to refer to this audit request. Use this id with the 'start' query parameter to continue on to the next page of audit results. Required.

id: int

received_date_time

The UTC DateTime that the request was received. Required.

received_date_time: datetime

request

The request of this entry. Required.

request: _models.AuditRequestInfo

request_id

The unique requestId that is returned by the service to the client in the 'apim-request-id' header. Required.

request_id: str

response

The response of this entry. Required.

response: _models.AuditLivenessResponseInfo

session_id

The unique sessionId 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