Generic document field. More...
Public Member Functions | |
| None | __init__ (self, *, FieldType type, Optional[OcrResult] value, float confidence_weight=1.0, Optional[ImageRef] image=None, Sequence[PointF] polygon_in_root, FieldValidationStatus validation_status=FieldValidationStatus.NONE, Optional[Sequence[FieldParsedData]] parsed_data=None) |
| Constructs Field with the given params. | |
| FieldType | type (self) |
| Getter for type field. | |
| Optional[OcrResult] | value (self) |
| Getter for value field. | |
| float | confidence_weight (self) |
| Getter for confidence_weight field. | |
| Optional[ImageRef] | image (self) |
| Getter for image field. | |
| Sequence[PointF] | polygon_in_root (self) |
| Getter for polygon_in_root field. | |
| FieldValidationStatus | validation_status (self) |
| Getter for validation_status field. | |
| Sequence[FieldParsedData] | parsed_data (self) |
| Getter for parsed_data field. | |
Public Attributes | |
| polygon_in_root | |
| parsed_data | |
Detailed Description
Generic document field.
Constructor & Destructor Documentation
◆ __init__()
| None __init__ | ( | self, | |
| * | , | ||
| FieldType | type, | ||
| Optional[OcrResult] | value, | ||
| float | confidence_weight = 1.0, | ||
| Optional[ImageRef] | image = None, | ||
| Sequence[PointF] | polygon_in_root, | ||
| FieldValidationStatus | validation_status = FieldValidationStatus.NONE, | ||
| Optional[Sequence[FieldParsedData]] | parsed_data = None ) |
Constructs Field with the given params.
- Parameters
-
type The type of the field. value Value of the field. Applicable only to text fields. confidence_weight Confidence weight. Default is 1.0 image Crop of the field. polygon_in_root Coordinates of the field in the root document coordinate system. validation_status Field validation status. Applicable only to fields that support some kind of validation. Default is NONE parsed_data Parsed data.
Member Function Documentation
◆ confidence_weight()
| float confidence_weight | ( | self | ) |
Getter for confidence_weight field.
See __init__ method documentation for more information about the field.
◆ image()
| Optional[ImageRef] image | ( | self | ) |
Getter for image field.
See __init__ method documentation for more information about the field.
◆ parsed_data()
| Sequence[FieldParsedData] parsed_data | ( | self | ) |
Getter for parsed_data field.
See __init__ method documentation for more information about the field.
◆ polygon_in_root()
| Sequence[PointF] polygon_in_root | ( | self | ) |
Getter for polygon_in_root field.
See __init__ method documentation for more information about the field.
◆ type()
| FieldType type | ( | self | ) |
Getter for type field.
See __init__ method documentation for more information about the field.
◆ validation_status()
| FieldValidationStatus validation_status | ( | self | ) |
Getter for validation_status field.
See __init__ method documentation for more information about the field.
◆ value()
| Optional[OcrResult] value | ( | self | ) |
Getter for value field.
See __init__ method documentation for more information about the field.
The documentation for this class was generated from the following file:
- api/generic_document/generic_document.py
Generated by
1.13.2