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)

Variables

name

str

The name of the document.

status

str

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

page_count

int

Total number of pages trained.

errors

list[FormRecognizerError]

List of any errors for document.

model_id

str

The model ID that used the document to train.

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) -> azure.ai.formrecognizer._models.TrainingDocumentInfo

Parameters

data

dict

Required

A dictionary in the shape of TrainingDocumentInfo.

data

Required

Returns

TrainingDocumentInfo

Return type

TrainingDocumentInfo

to_dict

Returns a dict representation of TrainingDocumentInfo.

to_dict() -> dict

Returns

dict

Return type

dict