Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPage
- Inherits:
-
Object
- Object
- Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPage
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/documentai_v1/classes.rb,
lib/google/apis/documentai_v1/representations.rb,
lib/google/apis/documentai_v1/representations.rb more...
Overview
A page in a Document.
Instance Attribute Summary collapse
-
#blocks ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageBlock>
A list of visually detected text blocks on the page.
-
#detected_barcodes ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode>
A list of detected barcodes.
-
#detected_languages ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage>
A list of detected languages together with confidence.
-
#dimension ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageDimension
Dimension for the page.
-
#form_fields ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageFormField>
A list of visually detected form fields on the page.
-
#image ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageImage
Rendered image contents for this page.
-
#image_quality_scores ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores
Image quality scores for the page image.
-
#layout ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageLayout
Visual element describing a layout unit on a page.
-
#lines ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageLine>
A list of visually detected text lines on the page.
-
#page_number ⇒ Fixnum
1-based index for current Page in a parent Document.
-
#paragraphs ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageParagraph>
A list of visually detected text paragraphs on the page.
-
#provenance ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentProvenance
Structure to identify provenance relationships between annotations in different revisions.
-
#symbols ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageSymbol>
A list of visually detected symbols on the page.
-
#tables ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageTable>
A list of visually detected tables on the page.
-
#tokens ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageToken>
A list of visually detected tokens on the page.
-
#transforms ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageMatrix>
Transformation matrices that were applied to the original document image to produce Page.image.
-
#visual_elements ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageVisualElement>
A list of detected non-text visual elements e.g.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDocumentaiV1beta1DocumentPage
constructor
A new instance of GoogleCloudDocumentaiV1beta1DocumentPage.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDocumentaiV1beta1DocumentPage
Returns a new instance of GoogleCloudDocumentaiV1beta1DocumentPage.
6032 6033 6034 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 6032 def initialize(**args) update!(**args) end |
Instance Attribute Details
#blocks ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageBlock>
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.
Corresponds to the JSON property blocks
5944 5945 5946 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 5944 def blocks @blocks end |
#detected_barcodes ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode>
A list of detected barcodes.
Corresponds to the JSON property detectedBarcodes
5949 5950 5951 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 5949 def @detected_barcodes end |
#detected_languages ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage>
A list of detected languages together with confidence.
Corresponds to the JSON property detectedLanguages
5954 5955 5956 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 5954 def detected_languages @detected_languages end |
#dimension ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageDimension
Dimension for the page.
Corresponds to the JSON property dimension
5959 5960 5961 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 5959 def dimension @dimension end |
#form_fields ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageFormField>
A list of visually detected form fields on the page.
Corresponds to the JSON property formFields
5964 5965 5966 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 5964 def form_fields @form_fields end |
#image ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageImage
Rendered image contents for this page.
Corresponds to the JSON property image
5969 5970 5971 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 5969 def image @image end |
#image_quality_scores ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores
Image quality scores for the page image.
Corresponds to the JSON property imageQualityScores
5974 5975 5976 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 5974 def image_quality_scores @image_quality_scores end |
#layout ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageLayout
Visual element describing a layout unit on a page.
Corresponds to the JSON property layout
5979 5980 5981 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 5979 def layout @layout end |
#lines ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageLine>
A list of visually detected text lines on the page. A collection of tokens
that a human would perceive as a line.
Corresponds to the JSON property lines
5985 5986 5987 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 5985 def lines @lines end |
#page_number ⇒ Fixnum
1-based index for current Page in a parent Document. Useful when a page is
taken out of a Document for individual processing.
Corresponds to the JSON property pageNumber
5991 5992 5993 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 5991 def page_number @page_number end |
#paragraphs ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageParagraph>
A list of visually detected text paragraphs on the page. A collection of lines
that a human would perceive as a paragraph.
Corresponds to the JSON property paragraphs
5997 5998 5999 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 5997 def paragraphs @paragraphs end |
#provenance ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentProvenance
Structure to identify provenance relationships between annotations in
different revisions.
Corresponds to the JSON property provenance
6003 6004 6005 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 6003 def provenance @provenance end |
#symbols ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageSymbol>
A list of visually detected symbols on the page.
Corresponds to the JSON property symbols
6008 6009 6010 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 6008 def symbols @symbols end |
#tables ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageTable>
A list of visually detected tables on the page.
Corresponds to the JSON property tables
6013 6014 6015 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 6013 def tables @tables end |
#tokens ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageToken>
A list of visually detected tokens on the page.
Corresponds to the JSON property tokens
6018 6019 6020 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 6018 def tokens @tokens end |
#transforms ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageMatrix>
Transformation matrices that were applied to the original document image to
produce Page.image.
Corresponds to the JSON property transforms
6024 6025 6026 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 6024 def transforms @transforms end |
#visual_elements ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageVisualElement>
A list of detected non-text visual elements e.g. checkbox, signature etc. on
the page.
Corresponds to the JSON property visualElements
6030 6031 6032 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 6030 def visual_elements @visual_elements end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 6037 def update!(**args) @blocks = args[:blocks] if args.key?(:blocks) @detected_barcodes = args[:detected_barcodes] if args.key?(:detected_barcodes) @detected_languages = args[:detected_languages] if args.key?(:detected_languages) @dimension = args[:dimension] if args.key?(:dimension) @form_fields = args[:form_fields] if args.key?(:form_fields) @image = args[:image] if args.key?(:image) @image_quality_scores = args[:image_quality_scores] if args.key?(:image_quality_scores) @layout = args[:layout] if args.key?(:layout) @lines = args[:lines] if args.key?(:lines) @page_number = args[:page_number] if args.key?(:page_number) @paragraphs = args[:paragraphs] if args.key?(:paragraphs) @provenance = args[:provenance] if args.key?(:provenance) @symbols = args[:symbols] if args.key?(:symbols) @tables = args[:tables] if args.key?(:tables) @tokens = args[:tokens] if args.key?(:tokens) @transforms = args[:transforms] if args.key?(:transforms) @visual_elements = args[:visual_elements] if args.key?(:visual_elements) end |