Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPage

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) ⇒ GoogleCloudDocumentaiV1beta1DocumentPage

Returns a new instance of GoogleCloudDocumentaiV1beta1DocumentPage.



5199
5200
5201
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5199

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

Returns:



5111
5112
5113
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5111

def blocks
  @blocks
end

#detected_barcodes ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode>

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

Returns:



5116
5117
5118
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5116

def detected_barcodes
  @detected_barcodes
end

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

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

Returns:



5121
5122
5123
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5121

def detected_languages
  @detected_languages
end

#dimension ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageDimension

Dimension for the page. Corresponds to the JSON property dimension

Returns:



5126
5127
5128
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5126

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

Returns:



5131
5132
5133
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5131

def form_fields
  @form_fields
end

#image ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageImage

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

Returns:



5136
5137
5138
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5136

def image
  @image
end

#image_quality_scores ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores

Image Quality Scores for the page image Corresponds to the JSON property imageQualityScores

Returns:



5141
5142
5143
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5141

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

Returns:



5146
5147
5148
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5146

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

Returns:



5152
5153
5154
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5152

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) 


5158
5159
5160
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5158

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

Returns:



5164
5165
5166
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5164

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

Returns:



5170
5171
5172
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5170

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

Returns:



5175
5176
5177
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5175

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

Returns:



5180
5181
5182
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5180

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

Returns:



5185
5186
5187
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5185

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

Returns:



5191
5192
5193
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5191

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

Returns:



5197
5198
5199
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5197

def visual_elements
  @visual_elements
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5204

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