Module page (0.14.2a0)
Stay organized with collections
Save and categorize content based on your preferences.
Wrappers for Document AI Page type.
Classes
Block(
documentai_object: typing.Union[
google.cloud.documentai_v1.types.document.Document.Page.Paragraph,
google.cloud.documentai_v1.types.document.Document.Page,
google.cloud.documentai_v1.types.document.Document.Page.Token,
google.cloud.documentai_v1.types.document.Document.Page.Block,
google.cloud.documentai_v1.types.document.Document.Page.Symbol,
],
_page: google.cloud.documentai_toolbox.wrappers.page.Page,
)
Represents a wrapped documentai.Document.Page.Block.
FormField(
documentai_object: google.cloud.documentai_v1.types.document.Document.Page.FormField,
_page: google.cloud.documentai_toolbox.wrappers.page.Page,
)
Represents a wrapped documentai.Document.Page.FormField.
Line(
documentai_object: typing.Union[
google.cloud.documentai_v1.types.document.Document.Page.Paragraph,
google.cloud.documentai_v1.types.document.Document.Page,
google.cloud.documentai_v1.types.document.Document.Page.Token,
google.cloud.documentai_v1.types.document.Document.Page.Block,
google.cloud.documentai_v1.types.document.Document.Page.Symbol,
],
_page: google.cloud.documentai_toolbox.wrappers.page.Page,
)
Represents a wrapped documentai.Document.Page.Line.
MathFormula(
documentai_object: typing.Union[
google.cloud.documentai_v1.types.document.Document.Page.Paragraph,
google.cloud.documentai_v1.types.document.Document.Page,
google.cloud.documentai_v1.types.document.Document.Page.Token,
google.cloud.documentai_v1.types.document.Document.Page.Block,
google.cloud.documentai_v1.types.document.Document.Page.Symbol,
],
_page: google.cloud.documentai_toolbox.wrappers.page.Page,
)
Page(
documentai_object: google.cloud.documentai_v1.types.document.Document.Page,
_document_text: str,
)
Represents a wrapped documentai.Document.Page .
Paragraph(
documentai_object: typing.Union[
google.cloud.documentai_v1.types.document.Document.Page.Paragraph,
google.cloud.documentai_v1.types.document.Document.Page,
google.cloud.documentai_v1.types.document.Document.Page.Token,
google.cloud.documentai_v1.types.document.Document.Page.Block,
google.cloud.documentai_v1.types.document.Document.Page.Symbol,
],
_page: google.cloud.documentai_toolbox.wrappers.page.Page,
)
Represents a wrapped documentai.Document.Page.Paragraph.
Symbol(
documentai_object: typing.Union[
google.cloud.documentai_v1.types.document.Document.Page.Paragraph,
google.cloud.documentai_v1.types.document.Document.Page,
google.cloud.documentai_v1.types.document.Document.Page.Token,
google.cloud.documentai_v1.types.document.Document.Page.Block,
google.cloud.documentai_v1.types.document.Document.Page.Symbol,
],
_page: google.cloud.documentai_toolbox.wrappers.page.Page,
)
Table(
documentai_object: google.cloud.documentai_v1.types.document.Document.Page.Table,
_page: google.cloud.documentai_toolbox.wrappers.page.Page,
)
Represents a wrapped documentai.Document.Page.Table.
Token(
documentai_object: typing.Union[
google.cloud.documentai_v1.types.document.Document.Page.Paragraph,
google.cloud.documentai_v1.types.document.Document.Page,
google.cloud.documentai_v1.types.document.Document.Page.Token,
google.cloud.documentai_v1.types.document.Document.Page.Block,
google.cloud.documentai_v1.types.document.Document.Page.Symbol,
],
_page: google.cloud.documentai_toolbox.wrappers.page.Page,
)
Represents a wrapped documentai.Document.Page.Token.
_BasePageElement(
documentai_object: typing.Union[
google.cloud.documentai_v1.types.document.Document.Page.Paragraph,
google.cloud.documentai_v1.types.document.Document.Page,
google.cloud.documentai_v1.types.document.Document.Page.Token,
google.cloud.documentai_v1.types.document.Document.Page.Block,
google.cloud.documentai_v1.types.document.Document.Page.Symbol,
],
_page: google.cloud.documentai_toolbox.wrappers.page.Page,
)
Base class for representing a wrapped Document AI Page element (Symbol, Token, Line, Paragraph, Block).
Modules
Functions
_get_hocr_bounding_box
_get_hocr_bounding_box(
element_with_layout: typing.Union[
google.cloud.documentai_v1.types.document.Document.Page.Paragraph,
google.cloud.documentai_v1.types.document.Document.Page,
google.cloud.documentai_v1.types.document.Document.Page.Token,
google.cloud.documentai_v1.types.document.Document.Page.Block,
google.cloud.documentai_v1.types.document.Document.Page.Symbol,
],
page_dimension: google.cloud.documentai_v1.types.document.Document.Page.Dimension,
) -> typing.Optional[str]
Returns a hOCR bounding box string.
| Parameters |
| Name |
Description |
element_with_layout |
ElementWithLayout
Required. an element with layout fields.
|
dimension |
documentai.Document.Page.Dimension
Required. Page dimension.
|
| Returns |
| Type |
Description |
Optional[str] |
hOCR bounding box string. |
_text_from_layout
_text_from_layout(
layout: google.cloud.documentai_v1.types.document.Document.Page.Layout, text: str
) -> str
Returns a text from a single layout element.
| Parameters |
| Name |
Description |
layout |
documentai.Document.Page.Layout
Required. An element with layout fields.
|
text |
str
Required. UTF-8 encoded text in reading order of the documentai.Document containing the layout element.
|
| Returns |
| Type |
Description |
str |
Text from a single element. |
_trim_text
_trim_text(text: str) -> str
Remove extra space characters from text (blank, newline, tab, etc.)
| Parameter |
| Name |
Description |
text |
str
Required. UTF-8 encoded text in reading order from the document.
|
| Returns |
| Type |
Description |
str |
Text without trailing spaces/newlines |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-09 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Module page (0.14.2a0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.14.2-a0 (latest)](/python/docs/reference/documentai-toolbox/latest/google.cloud.documentai_toolbox.wrappers.page)\n- [0.14.1-a0](/python/docs/reference/documentai-toolbox/0.14.1-a0/google.cloud.documentai_toolbox.wrappers.page)\n- [0.13.5-a0](/python/docs/reference/documentai-toolbox/0.13.5-a0/google.cloud.documentai_toolbox.wrappers.page)\n- [0.12.2-a0](/python/docs/reference/documentai-toolbox/0.12.2-a0/google.cloud.documentai_toolbox.wrappers.page)\n- [0.11.2-a0](/python/docs/reference/documentai-toolbox/0.11.2-a0/google.cloud.documentai_toolbox.wrappers.page)\n- [0.10.3-a0](/python/docs/reference/documentai-toolbox/0.10.3-a0/google.cloud.documentai_toolbox.wrappers.page)\n- [0.9.1-a0](/python/docs/reference/documentai-toolbox/0.9.1-a0/google.cloud.documentai_toolbox.wrappers.page)\n- [0.8.0-a0](/python/docs/reference/documentai-toolbox/0.8.0-a0/google.cloud.documentai_toolbox.wrappers.page)\n- [0.7.0-a0](/python/docs/reference/documentai-toolbox/0.7.0-a0/google.cloud.documentai_toolbox.wrappers.page)\n- [0.6.0-a0](/python/docs/reference/documentai-toolbox/0.6.0-a0/google.cloud.documentai_toolbox.wrappers.page)\n- [0.5.0-a0](/python/docs/reference/documentai-toolbox/0.5.0-a0/google.cloud.documentai_toolbox.wrappers.page)\n- [0.4.1-a0](/python/docs/reference/documentai-toolbox/0.4.1-a0/google.cloud.documentai_toolbox.wrappers.page)\n- [0.3.0-a0](/python/docs/reference/documentai-toolbox/0.3.0-a0/google.cloud.documentai_toolbox.wrappers.page)\n- [0.2.1-a0](/python/docs/reference/documentai-toolbox/0.2.1-a0/google.cloud.documentai_toolbox.wrappers.page)\n- [0.1.1-a0](/python/docs/reference/documentai-toolbox/0.1.1-a0/google.cloud.documentai_toolbox.wrappers.page) \nWrappers for Document AI Page type.\n\nClasses\n-------\n\n### [Block](/python/docs/reference/documentai-toolbox/latest/google.cloud.documentai_toolbox.wrappers.page.Block)\n\n Block(\n documentai_object: typing.Union[\n google.cloud.documentai_v1.types.document.Document.Page.Paragraph,\n google.cloud.documentai_v1.types.document.Document.Page,\n google.cloud.documentai_v1.types.document.Document.Page.Token,\n google.cloud.documentai_v1.types.document.Document.Page.Block,\n google.cloud.documentai_v1.types.document.Document.Page.Symbol,\n ],\n _page: google.cloud.documentai_toolbox.wrappers.page.Page,\n )\n\nRepresents a wrapped documentai.Document.Page.Block.\n\n### [FormField](/python/docs/reference/documentai-toolbox/latest/google.cloud.documentai_toolbox.wrappers.page.FormField)\n\n FormField(\n documentai_object: google.cloud.documentai_v1.types.document.Document.Page.FormField,\n _page: google.cloud.documentai_toolbox.wrappers.page.Page,\n )\n\nRepresents a wrapped documentai.Document.Page.FormField.\n\n### [Line](/python/docs/reference/documentai-toolbox/latest/google.cloud.documentai_toolbox.wrappers.page.Line)\n\n Line(\n documentai_object: typing.Union[\n google.cloud.documentai_v1.types.document.Document.Page.Paragraph,\n google.cloud.documentai_v1.types.document.Document.Page,\n google.cloud.documentai_v1.types.document.Document.Page.Token,\n google.cloud.documentai_v1.types.document.Document.Page.Block,\n google.cloud.documentai_v1.types.document.Document.Page.Symbol,\n ],\n _page: google.cloud.documentai_toolbox.wrappers.page.Page,\n )\n\nRepresents a wrapped documentai.Document.Page.Line.\n\n### [MathFormula](/python/docs/reference/documentai-toolbox/latest/google.cloud.documentai_toolbox.wrappers.page.MathFormula)\n\n MathFormula(\n documentai_object: typing.Union[\n google.cloud.documentai_v1.types.document.Document.Page.Paragraph,\n google.cloud.documentai_v1.types.document.Document.Page,\n google.cloud.documentai_v1.types.document.Document.Page.Token,\n google.cloud.documentai_v1.types.document.Document.Page.Block,\n google.cloud.documentai_v1.types.document.Document.Page.Symbol,\n ],\n _page: google.cloud.documentai_toolbox.wrappers.page.Page,\n )\n\nRepresents a wrapped documentai.Document.Page.VisualElement with type `math_formula`.\n\u003chttps://cloud.google.com/document-ai/docs/process-documents-ocr#math_ocr\u003e\n\n### [Page](/python/docs/reference/documentai-toolbox/latest/google.cloud.documentai_toolbox.wrappers.page.Page)\n\n Page(\n documentai_object: google.cloud.documentai_v1.types.document.Document.Page,\n _document_text: str,\n )\n\nRepresents a wrapped documentai.Document.Page .\n\n### [Paragraph](/python/docs/reference/documentai-toolbox/latest/google.cloud.documentai_toolbox.wrappers.page.Paragraph)\n\n Paragraph(\n documentai_object: typing.Union[\n google.cloud.documentai_v1.types.document.Document.Page.Paragraph,\n google.cloud.documentai_v1.types.document.Document.Page,\n google.cloud.documentai_v1.types.document.Document.Page.Token,\n google.cloud.documentai_v1.types.document.Document.Page.Block,\n google.cloud.documentai_v1.types.document.Document.Page.Symbol,\n ],\n _page: google.cloud.documentai_toolbox.wrappers.page.Page,\n )\n\nRepresents a wrapped documentai.Document.Page.Paragraph.\n\n### [Symbol](/python/docs/reference/documentai-toolbox/latest/google.cloud.documentai_toolbox.wrappers.page.Symbol)\n\n Symbol(\n documentai_object: typing.Union[\n google.cloud.documentai_v1.types.document.Document.Page.Paragraph,\n google.cloud.documentai_v1.types.document.Document.Page,\n google.cloud.documentai_v1.types.document.Document.Page.Token,\n google.cloud.documentai_v1.types.document.Document.Page.Block,\n google.cloud.documentai_v1.types.document.Document.Page.Symbol,\n ],\n _page: google.cloud.documentai_toolbox.wrappers.page.Page,\n )\n\nRepresents a wrapped documentai.Document.Page.Symbol.\n\u003chttps://cloud.google.com/document-ai/docs/process-documents-ocr#enable_symbols\u003e\n\n### [Table](/python/docs/reference/documentai-toolbox/latest/google.cloud.documentai_toolbox.wrappers.page.Table)\n\n Table(\n documentai_object: google.cloud.documentai_v1.types.document.Document.Page.Table,\n _page: google.cloud.documentai_toolbox.wrappers.page.Page,\n )\n\nRepresents a wrapped documentai.Document.Page.Table.\n\n### [Token](/python/docs/reference/documentai-toolbox/latest/google.cloud.documentai_toolbox.wrappers.page.Token)\n\n Token(\n documentai_object: typing.Union[\n google.cloud.documentai_v1.types.document.Document.Page.Paragraph,\n google.cloud.documentai_v1.types.document.Document.Page,\n google.cloud.documentai_v1.types.document.Document.Page.Token,\n google.cloud.documentai_v1.types.document.Document.Page.Block,\n google.cloud.documentai_v1.types.document.Document.Page.Symbol,\n ],\n _page: google.cloud.documentai_toolbox.wrappers.page.Page,\n )\n\nRepresents a wrapped documentai.Document.Page.Token.\n\n### [_BasePageElement](/python/docs/reference/documentai-toolbox/latest/google.cloud.documentai_toolbox.wrappers.page._BasePageElement)\n\n _BasePageElement(\n documentai_object: typing.Union[\n google.cloud.documentai_v1.types.document.Document.Page.Paragraph,\n google.cloud.documentai_v1.types.document.Document.Page,\n google.cloud.documentai_v1.types.document.Document.Page.Token,\n google.cloud.documentai_v1.types.document.Document.Page.Block,\n google.cloud.documentai_v1.types.document.Document.Page.Symbol,\n ],\n _page: google.cloud.documentai_toolbox.wrappers.page.Page,\n )\n\nBase class for representing a wrapped Document AI Page element (Symbol, Token, Line, Paragraph, Block).\n\nModules\nFunctions\n-----------------\n\n### _get_hocr_bounding_box\n\n _get_hocr_bounding_box(\n element_with_layout: typing.Union[\n google.cloud.documentai_v1.types.document.Document.Page.Paragraph,\n google.cloud.documentai_v1.types.document.Document.Page,\n google.cloud.documentai_v1.types.document.Document.Page.Token,\n google.cloud.documentai_v1.types.document.Document.Page.Block,\n google.cloud.documentai_v1.types.document.Document.Page.Symbol,\n ],\n page_dimension: google.cloud.documentai_v1.types.document.Document.Page.Dimension,\n ) -\u003e typing.Optional[str]\n\nReturns a hOCR bounding box string.\n\n### _text_from_layout\n\n _text_from_layout(\n layout: google.cloud.documentai_v1.types.document.Document.Page.Layout, text: str\n ) -\u003e str\n\nReturns a text from a single layout element.\n\n### _trim_text\n\n _trim_text(text: str) -\u003e str\n\nRemove extra space characters from text (blank, newline, tab, etc.)"]]