Class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentPage

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

Overview

A page in a Document.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1beta1DocumentPage

Returns a new instance of GoogleCloudDocumentaiV1beta1DocumentPage.



753
754
755
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 753

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

Instance Attribute Details

#blocks ⇒ Array<Google::Apis::DocumentaiV1beta3::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

Returns:



686
687
688
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 686

def blocks
  @blocks
end

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

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

Returns:



691
692
693
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 691

def detected_languages
  @detected_languages
end

#dimension ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentPageDimension

Dimension for the page. Corresponds to the JSON property dimension

Returns:



696
697
698
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 696

def dimension
  @dimension
end

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

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

Returns:



701
702
703
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 701

def form_fields
  @form_fields
end

#image ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentPageImage

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

Returns:



706
707
708
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 706

def image
  @image
end

#layout ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentPageLayout

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

Returns:



711
712
713
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 711

def layout
  @layout
end

#lines ⇒ Array<Google::Apis::DocumentaiV1beta3::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

Returns:



717
718
719
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 717

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) 


723
724
725
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 723

def page_number
  @page_number
end

#paragraphs ⇒ Array<Google::Apis::DocumentaiV1beta3::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

Returns:



729
730
731
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 729

def paragraphs
  @paragraphs
end

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

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

Returns:



734
735
736
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 734

def tables
  @tables
end

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

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

Returns:



739
740
741
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 739

def tokens
  @tokens
end

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

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

Returns:



745
746
747
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 745

def transforms
  @transforms
end

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

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

Returns:



751
752
753
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 751

def visual_elements
  @visual_elements
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 758

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)
  @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