RecognizedForm Class
Represents a form that has been recognized by a trained or prebuilt model. The fields property contains the form fields that were extracted from the form. Tables, text lines/words, and selection marks are extracted per page and found in the pages property.
New in version v2.1: The form_type_confidence and model_id properties, support for to_dict and from_dict methods
Constructor
RecognizedForm(**kwargs: Any)Methods
| from_dict |
Converts a dict in the shape of a RecognizedForm to the model itself. |
| to_dict |
Returns a dict representation of RecognizedForm. |
from_dict
Converts a dict in the shape of a RecognizedForm to the model itself.
from_dict(data: Dict) -> RecognizedFormParameters
| Name | Description |
|---|---|
|
data
Required
|
A dictionary in the shape of RecognizedForm. |
Returns
| Type | Description |
|---|---|
|
RecognizedForm |
to_dict
Returns a dict representation of RecognizedForm.
to_dict() -> DictReturns
| Type | Description |
|---|---|
|
dict |
Attributes
fields
A dictionary of the fields found on the form. The fields dictionary keys are the name of the field. For models trained with labels, this is the training-time label of the field. For models trained without labels, a unique name is generated for each field.
fields: Dict[str, FormField]form_type
The type of form the model identified the submitted form to be.
form_type: strform_type_confidence
Confidence of the type of form the model identified the submitted form to be.
form_type_confidence: intmodel_id
Model identifier of model used to analyze form if not using a prebuilt model.
model_id: strpage_range
The first and last page number of the input form.
page_range: FormPageRangepages
A list of pages recognized from the input document. Contains lines, words, selection marks, tables and page metadata.
pages: List[FormPage]