Share via

OperationSummary Class

  • Reference

Model operation information, including the kind and status of the operation, when it was created, and more.

Note that operation information only persists for 24 hours. If the operation was successful, the model can be accessed using the <xref:azure.ai.formrecognizer.get_document_model>, <xref:azure.ai.formrecognizer.list_document_models>, <xref:azure.ai.formrecognizer.get_document_classifier>, <xref:azure.ai.formrecognizer.list_document_classifiers> APIs. To find out why an operation failed, use <xref:azure.ai.formrecognizer.get_operation> and provide the operation_id.

New in version 2023-07-31: The documentClassifierBuild kind.

Inheritance
builtins.object
OperationSummary

Constructor

OperationSummary(**kwargs: Any)

Methods

from_dict

Converts a dict in the shape of a OperationSummary to the model itself.
to_dict

Returns a dict representation of OperationSummary.

from_dict

Converts a dict in the shape of a OperationSummary to the model itself.

from_dict(data: Dict) -> OperationSummary

Parameters

Name Description
data
Required
dict

A dictionary in the shape of OperationSummary.

Returns

Type Description
OperationSummary

OperationSummary

to_dict

Returns a dict representation of OperationSummary.

to_dict() -> Dict

Returns

Type Description
dict

dict

Attributes

api_version

API version used to create this operation.

api_version: str | None

created_on

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

created_on: datetime

kind

"documentModelBuild", "documentModelCompose", "documentModelCopyTo", "documentClassifierBuild".

kind: str

last_updated_on

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

last_updated_on: datetime

operation_id

Operation ID.

operation_id: str

percent_completed

Operation progress (0-100).

percent_completed: int | None

resource_location

URL of the resource targeted by this operation.

resource_location: str

status

"notStarted", "running", "failed", "succeeded", "canceled".

status: str

tags

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

tags: Dict[str, str] | None