TrainingDocumentInfo Class

Report for an individual document used for training a custom model.

New in version v2.1: The model_id property, support for to_dict and from_dict methods

Inheritance

builtins.object

TrainingDocumentInfo

Constructor

TrainingDocumentInfo(**kwargs: Any)

Methods

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

from_dict

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

from_dict(data: Dict) -> TrainingDocumentInfo

Parameters

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

Returns

Type	Description
TrainingDocumentInfo	TrainingDocumentInfo

to_dict

Returns a dict representation of TrainingDocumentInfo.

to_dict() -> Dict

Returns

Type	Description
dict	dict

Attributes

errors

List of any errors for document.

errors: List[FormRecognizerError]

model_id

The model ID that used the document to train.

model_id: str

name

The name of the document.

name: str

page_count

Total number of pages trained.

page_count: int

status

The TrainingStatus of the training operation. Possible values include: 'succeeded', 'partiallySucceeded', 'failed'.

status: str