Class Page (0.2.0) 

Page(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A page in a Document.

Attributes

NameDescription
page_number int
1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.
dimension .document.Document.Page.Dimension
Physical dimension of the page.
layout .document.Document.Page.Layout
Layout for the page.
detected_languages Sequence[.document.Document.Page.DetectedLanguage]
A list of detected languages together with confidence.
blocks Sequence[.document.Document.Page.Block]
A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
paragraphs Sequence[.document.Document.Page.Paragraph]
A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.
lines Sequence[.document.Document.Page.Line]
A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.
tokens Sequence[.document.Document.Page.Token]
A list of visually detected tokens on the page.
visual_elements Sequence[.document.Document.Page.VisualElement]
A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.
tables Sequence[.document.Document.Page.Table]
A list of visually detected tables on the page.
form_fields Sequence[.document.Document.Page.FormField]
A list of visually detected form fields on the page.

Classes

Block

Block(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.

DetectedLanguage

DetectedLanguage(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Detected language for a structural component.

Dimension

Dimension(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Dimension for the page.

FormField

FormField(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A form field detected on the page.

Layout

Layout(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Visual element describing a layout unit on a page.

Line

Line(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.

Paragraph

Paragraph(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A collection of lines that a human would perceive as a paragraph.

Table

Table(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A table representation similar to HTML table structure.

Token

Token(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A detected token.

VisualElement

VisualElement(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Detected non-text visual elements e.g. checkbox, signature etc. on the page.

Methods

__delattr__

__delattr__(key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

__eq__

__eq__(other)

Return True if the messages are equal, False otherwise.

__ne__

__ne__(other)

Return True if the messages are unequal, False otherwise.

__setattr__

__setattr__(key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.