CustomFormModelInfo Class

Custom model information.

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

Inheritance
builtins.object
CustomFormModelInfo

Constructor

CustomFormModelInfo(**kwargs)

Variables

model_id
str

The unique identifier of the model.

status
str

The status of the model, CustomFormModelStatus. Possible values include: 'creating', 'ready', 'invalid'.

training_started_on
datetime

Date and time (UTC) when model training was started.

training_completed_on
datetime

Date and time (UTC) when model training completed.

model_name
str

Optional user defined model name.

properties
CustomFormModelProperties

Optional model properties.

Methods

from_dict

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

to_dict

Returns a dict representation of CustomFormModelInfo.

from_dict

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

from_dict(data: dict) -> azure.ai.formrecognizer._models.CustomFormModelInfo

Parameters

data
dict
Required

A dictionary in the shape of CustomFormModelInfo.

data
Required

Returns

CustomFormModelInfo

Return type

to_dict

Returns a dict representation of CustomFormModelInfo.

to_dict() -> dict

Returns

dict

Return type