Class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPage

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/documentai_v1beta3/classes.rb,
lib/google/apis/documentai_v1beta3/representations.rb,
lib/google/apis/documentai_v1beta3/representations.rb

Overview

A page in a Document.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1beta3DocumentPage

Returns a new instance of GoogleCloudDocumentaiV1beta3DocumentPage.



5630
5631
5632
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5630

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#blocks ⇒ Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageBlock>

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

Returns:



5557
5558
5559
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5557

def blocks
  @blocks
end

#detected_languages ⇒ Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage>

A list of detected languages together with confidence. Corresponds to the JSON property detectedLanguages

Returns:



5562
5563
5564
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5562

def detected_languages
  @detected_languages
end

#dimension ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageDimension

Dimension for the page. Corresponds to the JSON property dimension

Returns:



5567
5568
5569
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5567

def dimension
  @dimension
end

#form_fields ⇒ Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageFormField>

A list of visually detected form fields on the page. Corresponds to the JSON property formFields

Returns:



5572
5573
5574
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5572

def form_fields
  @form_fields
end

#image ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageImage

Rendered image contents for this page. Corresponds to the JSON property image

Returns:



5577
5578
5579
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5577

def image
  @image
end

#layout ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageLayout

Visual element describing a layout unit on a page. Corresponds to the JSON property layout

Returns:



5582
5583
5584
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5582

def layout
  @layout
end

#lines ⇒ Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageLine>

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

Returns:



5588
5589
5590
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5588

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

Returns:

  • (Fixnum) 


5594
5595
5596
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5594

def page_number
  @page_number
end

#paragraphs ⇒ Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageParagraph>

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

Returns:



5600
5601
5602
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5600

def paragraphs
  @paragraphs
end

#provenance ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentProvenance

Structure to identify provenance relationships between annotations in different revisions. Corresponds to the JSON property provenance

Returns:



5606
5607
5608
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5606

def provenance
  @provenance
end

#tables ⇒ Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageTable>

A list of visually detected tables on the page. Corresponds to the JSON property tables

Returns:



5611
5612
5613
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5611

def tables
  @tables
end

#tokens ⇒ Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageToken>

A list of visually detected tokens on the page. Corresponds to the JSON property tokens

Returns:



5616
5617
5618
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5616

def tokens
  @tokens
end

#transforms ⇒ Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageMatrix>

Transformation matrices that were applied to the original document image to produce Page.image. Corresponds to the JSON property transforms

Returns:



5622
5623
5624
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5622

def transforms
  @transforms
end

#visual_elements ⇒ Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageVisualElement>

A list of detected non-text visual elements e.g. checkbox, signature etc. on the page. Corresponds to the JSON property visualElements

Returns:



5628
5629
5630
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5628

def visual_elements
  @visual_elements
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5635

def update!(**args)
  @blocks = args[:blocks] if args.key?(:blocks)
  @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)
  @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)
  @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