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.



8868
8869
8870
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8868

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:



8780
8781
8782
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8780

def blocks
  @blocks
end

#detected_barcodes ⇒ Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageDetectedBarcode>

A list of detected barcodes. Corresponds to the JSON property detectedBarcodes

Returns:



8785
8786
8787
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8785

def detected_barcodes
  @detected_barcodes
end

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

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

Returns:



8790
8791
8792
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8790

def detected_languages
  @detected_languages
end

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

Dimension for the page. Corresponds to the JSON property dimension

Returns:



8795
8796
8797
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8795

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:



8800
8801
8802
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8800

def form_fields
  @form_fields
end

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

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

Returns:



8805
8806
8807
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8805

def image
  @image
end

#image_quality_scores ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScores

Image quality scores for the page image. Corresponds to the JSON property imageQualityScores

Returns:



8810
8811
8812
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8810

def image_quality_scores
  @image_quality_scores
end

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

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

Returns:



8815
8816
8817
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8815

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:



8821
8822
8823
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8821

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) 


8827
8828
8829
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8827

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:



8833
8834
8835
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8833

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:



8839
8840
8841
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8839

def provenance
  @provenance
end

#symbols ⇒ Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageSymbol>

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

Returns:



8844
8845
8846
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8844

def symbols
  @symbols
end

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

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

Returns:



8849
8850
8851
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8849

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:



8854
8855
8856
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8854

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:



8860
8861
8862
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8860

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:



8866
8867
8868
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8866

def visual_elements
  @visual_elements
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8873

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