CustomFormModel Class

Represents a trained model.

New in version v2.1: The model_name and properties properties, support for to_dict and from_dict methods

Inheritance

builtins.object

CustomFormModel

Constructor

CustomFormModel(**kwargs: Any)

Methods

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

from_dict

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

from_dict(data: Dict) -> CustomFormModel

Parameters

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

Returns

Type	Description
CustomFormModel	CustomFormModel

to_dict

Returns a dict representation of CustomFormModel.

to_dict() -> Dict

Returns

Type	Description
dict	dict

Attributes

errors

List of any training errors.

errors: List[FormRecognizerError]

model_id

The unique identifier of this model.

model_id: str

model_name

Optional user defined model name.

model_name: str

properties

Optional model properties.

properties: CustomFormModelProperties

status

Status indicating the model's readiness for use, CustomFormModelStatus. Possible values include: 'creating', 'ready', 'invalid'.

status: str

submodels

A list of submodels that are part of this model, each of which can recognize and extract fields from a different type of form.

submodels: List[CustomFormSubmodel]

training_completed_on

Date and time (UTC) when model training completed.

training_completed_on: datetime

training_documents

Metadata about each of the documents used to train the model.

training_documents: List[TrainingDocumentInfo]

training_started_on

The date and time (UTC) when model training was started.

training_started_on: datetime