Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentPage

Inherits:
Object
  • Object
show all
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

Overview

A page in a Document.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1beta2DocumentPage

Returns a new instance of GoogleCloudDocumentaiV1beta2DocumentPage.



5947
5948
5949
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5947

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

Instance Attribute Details

#blocks ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentPageBlock>

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:



5869
5870
5871
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5869

def blocks
  @blocks
end

#detected_languages ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage>

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

Returns:



5874
5875
5876
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5874

def detected_languages
  @detected_languages
end

#dimension ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentPageDimension

Dimension for the page. Corresponds to the JSON property dimension

Returns:



5879
5880
5881
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5879

def dimension
  @dimension
end

#form_fields ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentPageFormField>

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

Returns:



5884
5885
5886
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5884

def form_fields
  @form_fields
end

#image ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentPageImage

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

Returns:



5889
5890
5891
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5889

def image
  @image
end

#layout ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentPageLayout

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

Returns:



5894
5895
5896
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5894

def layout
  @layout
end

#lines ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentPageLine>

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:



5900
5901
5902
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5900

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) 


5906
5907
5908
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5906

def page_number
  @page_number
end

#paragraphs ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentPageParagraph>

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:



5912
5913
5914
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5912

def paragraphs
  @paragraphs
end

#provenance ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentProvenance

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

Returns:



5918
5919
5920
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5918

def provenance
  @provenance
end

#symbols ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentPageSymbol>

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

Returns:



5923
5924
5925
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5923

def symbols
  @symbols
end

#tables ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentPageTable>

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

Returns:



5928
5929
5930
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5928

def tables
  @tables
end

#tokens ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentPageToken>

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

Returns:



5933
5934
5935
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5933

def tokens
  @tokens
end

#transforms ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentPageMatrix>

Transformation matrices (both already applied and not) to the original document image to produce Page.image. Corresponds to the JSON property transforms

Returns:



5939
5940
5941
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5939

def transforms
  @transforms
end

#visual_elements ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentPageVisualElement>

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

Returns:



5945
5946
5947
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5945

def visual_elements
  @visual_elements
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5952

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