Document AI V1 API - Class Google::Cloud::DocumentAI::V1::Document::Page (v0.20.0)

Reference documentation and code samples for the Document AI V1 API class Google::Cloud::DocumentAI::V1::Document::Page.

A page in a Document.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#blocks

def blocks() -> ::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Block>

Returns

(::Array<::Google::Cloud::DocumentAI::V1::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.

#blocks=

def blocks=(value) -> ::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Block>

Parameter

value (::Array<::Google::Cloud::DocumentAI::V1::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.

Returns

(::Array<::Google::Cloud::DocumentAI::V1::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.

#detected_barcodes

def detected_barcodes() -> ::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedBarcode>

Returns

(::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedBarcode>) — A list of detected barcodes.

#detected_barcodes=

def detected_barcodes=(value) -> ::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedBarcode>

Parameter

value (::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedBarcode>) — A list of detected barcodes.

Returns

(::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedBarcode>) — A list of detected barcodes.

#detected_languages

def detected_languages() -> ::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>

Returns

(::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>) — A list of detected languages together with confidence.

#detected_languages=

def detected_languages=(value) -> ::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>

Parameter

value (::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>) — A list of detected languages together with confidence.

Returns

(::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>) — A list of detected languages together with confidence.

#dimension

def dimension() -> ::Google::Cloud::DocumentAI::V1::Document::Page::Dimension

Returns

(::Google::Cloud::DocumentAI::V1::Document::Page::Dimension) — Physical dimension of the page.

#dimension=

def dimension=(value) -> ::Google::Cloud::DocumentAI::V1::Document::Page::Dimension

Parameter

value (::Google::Cloud::DocumentAI::V1::Document::Page::Dimension) — Physical dimension of the page.

Returns

(::Google::Cloud::DocumentAI::V1::Document::Page::Dimension) — Physical dimension of the page.

#form_fields

def form_fields() -> ::Array<::Google::Cloud::DocumentAI::V1::Document::Page::FormField>

Returns

(::Array<::Google::Cloud::DocumentAI::V1::Document::Page::FormField>) — A list of visually detected form fields on the page.

#form_fields=

def form_fields=(value) -> ::Array<::Google::Cloud::DocumentAI::V1::Document::Page::FormField>

Parameter

value (::Array<::Google::Cloud::DocumentAI::V1::Document::Page::FormField>) — A list of visually detected form fields on the page.

Returns

(::Array<::Google::Cloud::DocumentAI::V1::Document::Page::FormField>) — A list of visually detected form fields on the page.

#image

def image() -> ::Google::Cloud::DocumentAI::V1::Document::Page::Image

Returns

(::Google::Cloud::DocumentAI::V1::Document::Page::Image) — Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned.

#image=

def image=(value) -> ::Google::Cloud::DocumentAI::V1::Document::Page::Image

Parameter

value (::Google::Cloud::DocumentAI::V1::Document::Page::Image) — Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned.

Returns

(::Google::Cloud::DocumentAI::V1::Document::Page::Image) — Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned.

#image_quality_scores

def image_quality_scores() -> ::Google::Cloud::DocumentAI::V1::Document::Page::ImageQualityScores

Returns

(::Google::Cloud::DocumentAI::V1::Document::Page::ImageQualityScores) — Image quality scores.

#image_quality_scores=

def image_quality_scores=(value) -> ::Google::Cloud::DocumentAI::V1::Document::Page::ImageQualityScores

Parameter

value (::Google::Cloud::DocumentAI::V1::Document::Page::ImageQualityScores) — Image quality scores.

Returns

(::Google::Cloud::DocumentAI::V1::Document::Page::ImageQualityScores) — Image quality scores.

#layout

def layout() -> ::Google::Cloud::DocumentAI::V1::Document::Page::Layout

Returns

(::Google::Cloud::DocumentAI::V1::Document::Page::Layout) — Layout for the page.

#layout=

def layout=(value) -> ::Google::Cloud::DocumentAI::V1::Document::Page::Layout

Parameter

value (::Google::Cloud::DocumentAI::V1::Document::Page::Layout) — Layout for the page.

Returns

(::Google::Cloud::DocumentAI::V1::Document::Page::Layout) — Layout for the page.

#lines

def lines() -> ::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Line>

Returns

(::Array<::Google::Cloud::DocumentAI::V1::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.

#lines=

def lines=(value) -> ::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Line>

Parameter

value (::Array<::Google::Cloud::DocumentAI::V1::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.

Returns

(::Array<::Google::Cloud::DocumentAI::V1::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.

#page_number

def page_number() -> ::Integer

Returns

(::Integer) — 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.

#page_number=

def page_number=(value) -> ::Integer

Parameter

value (::Integer) — 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.

Returns

(::Integer) — 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.

#paragraphs

def paragraphs() -> ::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Paragraph>

Returns

(::Array<::Google::Cloud::DocumentAI::V1::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.

#paragraphs=

def paragraphs=(value) -> ::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Paragraph>

Parameter

value (::Array<::Google::Cloud::DocumentAI::V1::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.

Returns

(::Array<::Google::Cloud::DocumentAI::V1::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.

#provenance

def provenance() -> ::Google::Cloud::DocumentAI::V1::Document::Provenance

Returns

(::Google::Cloud::DocumentAI::V1::Document::Provenance) — The history of this page.

#provenance=

def provenance=(value) -> ::Google::Cloud::DocumentAI::V1::Document::Provenance

Parameter

value (::Google::Cloud::DocumentAI::V1::Document::Provenance) — The history of this page.

Returns

(::Google::Cloud::DocumentAI::V1::Document::Provenance) — The history of this page.

#symbols

def symbols() -> ::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Symbol>

Returns

(::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Symbol>) — A list of visually detected symbols on the page.

#symbols=

def symbols=(value) -> ::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Symbol>

Parameter

value (::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Symbol>) — A list of visually detected symbols on the page.

Returns

(::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Symbol>) — A list of visually detected symbols on the page.

#tables

def tables() -> ::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Table>

Returns

(::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Table>) — A list of visually detected tables on the page.

#tables=

def tables=(value) -> ::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Table>

Parameter

value (::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Table>) — A list of visually detected tables on the page.

Returns

(::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Table>) — A list of visually detected tables on the page.

#tokens

def tokens() -> ::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Token>

Returns

(::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Token>) — A list of visually detected tokens on the page.

#tokens=

def tokens=(value) -> ::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Token>

Parameter

value (::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Token>) — A list of visually detected tokens on the page.

Returns

(::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Token>) — A list of visually detected tokens on the page.

#transforms

def transforms() -> ::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Matrix>

Returns

(::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Matrix>) — Transformation matrices that were applied to the original document image to produce Page.image.

#transforms=

def transforms=(value) -> ::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Matrix>

Parameter

value (::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Matrix>) — Transformation matrices that were applied to the original document image to produce Page.image.

Returns

(::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Matrix>) — Transformation matrices that were applied to the original document image to produce Page.image.

#visual_elements

def visual_elements() -> ::Array<::Google::Cloud::DocumentAI::V1::Document::Page::VisualElement>

Returns

(::Array<::Google::Cloud::DocumentAI::V1::Document::Page::VisualElement>) — A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.

#visual_elements=

def visual_elements=(value) -> ::Array<::Google::Cloud::DocumentAI::V1::Document::Page::VisualElement>

Parameter

value (::Array<::Google::Cloud::DocumentAI::V1::Document::Page::VisualElement>) — A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.

Returns

(::Array<::Google::Cloud::DocumentAI::V1::Document::Page::VisualElement>) — A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.