OperationDetails Class

OperationDetails consists of information about the model operation, including the result or error of the operation if it has completed.

Note that operation information only persists for 24 hours. If the operation was successful, the model can also 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.

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

Inheritance

azure.ai.formrecognizer._models.OperationSummary

OperationDetails

Constructor

OperationDetails(**kwargs: Any)

Methods

from_dict	Converts a dict in the shape of a OperationDetails to the model itself.
to_dict	Returns a dict representation of OperationDetails.

from_dict

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

from_dict(data: Dict) -> OperationDetails

Parameters

Name	Description
data Required	dict A dictionary in the shape of OperationDetails.

Returns

Type	Description
OperationDetails	OperationDetails

to_dict

Returns a dict representation of OperationDetails.

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

error

Encountered error, includes the error code, message, and details for why the operation failed.

error: DocumentAnalysisError | None

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

result

Operation result upon success. Returns a DocumentModelDetails or DocumentClassifierDetails which contains all the information about the model.

result: DocumentModelDetails | DocumentClassifierDetails | None

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