AnalyzeBatchOperation Class

Status and result of the analyze batch operation.

Constructor

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

Variables

Name	Description
result_id	str Analyze batch operation result ID.
status	str or DocumentIntelligenceOperationStatus Operation status. notStarted, running, succeeded, or failed. Required. Known values are: "notStarted", "running", "failed", "succeeded", "canceled", and "skipped".
created_date_time	datetime Date and time (UTC) when the operation was submitted. Required.
last_updated_date_time	datetime Date and time (UTC) when the status was last updated. Required.
percent_completed	int Operation progress (0-100).
error	DocumentIntelligenceError Encountered error during batch document analysis.
result	AnalyzeBatchResult Batch document analysis result.

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. Default value: False

Returns

Type	Description
dict	A dict JSON compatible object

clear

clear() -> None

copy

copy() -> Model

get

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

Parameters

Name	Description
key Required
default	Default value: None

items

items() -> ItemsView[str, Any]

keys

keys() -> KeysView[str]

pop

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

Parameters

Name	Description
key Required
default

popitem

popitem() -> Tuple[str, Any]

setdefault

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

Parameters

Name	Description
key Required
default

update

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

values

values() -> ValuesView[Any]

Attributes

created_date_time

Date and time (UTC) when the operation was submitted. Required.

created_date_time: datetime

error

Encountered error during batch document analysis.

error: _models.DocumentIntelligenceError | None

last_updated_date_time

Date and time (UTC) when the status was last updated. Required.

last_updated_date_time: datetime

percent_completed

Operation progress (0-100).

percent_completed: int | None

result

Batch document analysis result.

result: _models.AnalyzeBatchResult | None

result_id

Analyze batch operation result ID.

result_id: str | None

status

Operation status. notStarted, running, succeeded, or failed. Required. Known values are: "notStarted", "running", "failed", "succeeded", "canceled", and "skipped".

status: str | _models.DocumentIntelligenceOperationStatus