GenericDocument

Generic document. More...

Public Member Functions
None	__init__ (self, *, GenericDocumentType type, Sequence[Field] fields, Sequence["GenericDocument"] children, Sequence[PointF] quad, Sequence[PointF] quad_in_root, Optional[ImageRef] crop=None, float confidence=0.0, float confidence_weight=0.0)
	Constructs GenericDocument with the given params.
GenericDocumentType	type (self)
	Getter for type field.
Sequence[Field]	fields (self)
	Getter for fields field.
Sequence["GenericDocument"]	children (self)
	Getter for children field.
Sequence[PointF]	quad (self)
	Getter for quad field.
Sequence[PointF]	quad_in_root (self)
	Getter for quad_in_root field.
Optional[ImageRef]	crop (self)
	Getter for crop field.
float	confidence (self)
	Getter for confidence field.
float	confidence_weight (self)
	Getter for confidence_weight field.

Public Attributes
	fields
	children
	quad
	quad_in_root

Detailed Description

Generic document.

Constructor & Destructor Documentation

__init__()

None __init__	(		self,
		*	,
		GenericDocumentType	type,
		Sequence[Field]	fields,
		Sequence["GenericDocument"]	children,
		Sequence[PointF]	quad,
		Sequence[PointF]	quad_in_root,
		Optional[ImageRef]	crop = None,
		float	confidence = 0.0,
		float	confidence_weight = 0.0 )

Constructs GenericDocument with the given params.

Parameters

type	Document type.
fields	List of document fields.
children	List of document sub-documents.
quad	Coordinates of the document in the parent document coordinate system.
quad_in_root	Coordinates of the document in the root document coordinate system.
crop	Image crop of the document.
confidence	The average confidence in the accuracy of the document recognition result. Default is 0
confidence_weight	The weight of the confidence. Can be used to calculate the weighted average confidence of two documents. Default is 0

Member Function Documentation

children()

Sequence["GenericDocument"] children

(

self

)

Getter for children field.

See __init__ method documentation for more information about the field.

confidence()

float confidence

(

self

)

Getter for confidence field.

See __init__ method documentation for more information about the field.

confidence_weight()

float confidence_weight

(

self

)

Getter for confidence_weight field.

See __init__ method documentation for more information about the field.

crop()

Optional[ImageRef] crop

(

self

)

Getter for crop field.

See __init__ method documentation for more information about the field.

fields()

Sequence[Field] fields

(

self

)

Getter for fields field.

See __init__ method documentation for more information about the field.

quad()

Sequence[PointF] quad

(

self

)

Getter for quad field.

See __init__ method documentation for more information about the field.

quad_in_root()

Sequence[PointF] quad_in_root

(

self

)

Getter for quad_in_root field.

See __init__ method documentation for more information about the field.

type()

GenericDocumentType type

(

self

)

Getter for type 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