DocumentIntelligenceOperationDetails Class

Operation info.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: DocumentClassifierBuildOperationDetails, DocumentClassifierCopyToOperationDetails, DocumentModelBuildOperationDetails, DocumentModelComposeOperationDetails, DocumentModelCopyToOperationDetails

Constructor

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

Variables

Name Description
operation_id
str

Operation ID. Required.
status
str or DocumentIntelligenceOperationStatus

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

Operation progress (0-100).
created_date_time
datetime

Date and time (UTC) when the operation was created. Required.
last_updated_date_time
datetime

Date and time (UTC) when the status was last updated. Required.
kind
str or OperationKind

Type of operation. Required. Known values are: "documentModelBuild", "documentModelCompose", "documentModelCopyTo", "documentClassifierCopyTo", and "documentClassifierBuild".
resource_location
str

URL of the resource targeted by this operation. Required.
api_version
str

API version used to create this operation.
tags
dict[str, str]

List of key-value tag attributes associated with the document model.
error
DocumentIntelligenceError

Encountered error.

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

api_version

API version used to create this operation.

api_version: str | None

created_date_time

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

created_date_time: datetime

error

Encountered error.

error: _models.DocumentIntelligenceError | None

kind

"documentModelBuild", "documentModelCompose", "documentModelCopyTo", "documentClassifierCopyTo", and "documentClassifierBuild".

kind: str

last_updated_date_time

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

last_updated_date_time: datetime

operation_id

Operation ID. Required.

operation_id: str

percent_completed

Operation progress (0-100).

percent_completed: int | None

resource_location

URL of the resource targeted by this operation. Required.

resource_location: str

status

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

status: str | _models.DocumentIntelligenceOperationStatus

tags

List of key-value tag attributes associated with the document model.

tags: Dict[str, str] | None