Share via

AnalyzeTextOperationState Class

The object containing the analyze job LRO job state.

Constructor

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

Variables

Name Description
display_name
str

display name.
created_at
datetime

Date and time job created. Required.
expires_on
datetime

Date and time job expires.
job_id
str

job ID. Required.
last_updated_at
datetime

last updated date and time. Required.
status
str or TextActionState

status. Required. Known values are: "notStarted", "running", "succeeded", "partiallyCompleted", "failed", "cancelled", and "cancelling".
errors
list[AnalyzeTextError]

errors.
next_link
str

next link.
actions
TextActions

List of tasks. Required.
statistics
RequestStatistics

if showStats=true was specified in the request this field will contain information about the request payload.

Methods

as_dict

Return a dict that can be turned into json using json.dump.
clear

Remove all items from D.
copy
get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
items
keys
pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
update

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
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.

Default value: False

Returns

Type Description
dict

A dict JSON compatible object

clear

Remove all items from D.

clear() -> None

copy 

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any

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

Parameters

Name Description
key
Required
default
Default value: None

items 

items() -> ItemsView[str, Any]

Returns

Type Description
ItemsView

set-like object providing a view on D's items

keys 

keys() -> KeysView[str]

Returns

Type Description
KeysView

a set-like object providing a view on D's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

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

Parameters

Name Description
key
Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.

popitem() -> tuple[str, Any]

setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any

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

Parameters

Name Description
key
Required
default

update

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.

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

values 

values() -> ValuesView[Any]

Returns

Type Description
ValuesView

an object providing a view on D's values

Attributes

actions

List of tasks. Required.

actions: _models.TextActions

created_at

Date and time job created. Required.

created_at: datetime

display_name

display name.

display_name: str | None

errors

errors.

errors: list['_models.AnalyzeTextError'] | None

expires_on

Date and time job expires.

expires_on: datetime | None

job_id

job ID. Required.

job_id: str

last_updated_at

last updated date and time. Required.

last_updated_at: datetime

next link.

next_link: str | None

statistics

if showStats=true was specified in the request this field will contain information about the request payload.

statistics: _models.RequestStatistics | None

status

"notStarted", "running", "succeeded", "partiallyCompleted", "failed", "cancelled", and "cancelling".

status: str | _models.TextActionState