Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPage

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 more...

Overview

A page in a Document.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1DocumentPage

Returns a new instance of GoogleCloudDocumentaiV1DocumentPage.

[View source]

2307
2308
2309
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2307

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

Instance Attribute Details

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

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:


2219
2220
2221
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2219

def blocks
  @blocks
end

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

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

Returns:


2224
2225
2226
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2224

def detected_barcodes
  @detected_barcodes
end

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

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

Returns:


2229
2230
2231
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2229

def detected_languages
  @detected_languages
end

#dimension ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageDimension

Dimension for the page. Corresponds to the JSON property dimension

Returns:


2234
2235
2236
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2234

def dimension
  @dimension
end

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

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

Returns:


2239
2240
2241
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2239

def form_fields
  @form_fields
end

#image ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageImage

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

Returns:


2244
2245
2246
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2244

def image
  @image
end

#image_quality_scores ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageImageQualityScores

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

Returns:


2249
2250
2251
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2249

def image_quality_scores
  @image_quality_scores
end

#layout ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageLayout

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

Returns:


2254
2255
2256
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2254

def layout
  @layout
end

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

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:


2260
2261
2262
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2260

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) 

2266
2267
2268
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2266

def page_number
  @page_number
end

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

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:


2272
2273
2274
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2272

def paragraphs
  @paragraphs
end

#provenance ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentProvenance

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

Returns:


2278
2279
2280
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2278

def provenance
  @provenance
end

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

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

Returns:


2283
2284
2285
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2283

def symbols
  @symbols
end

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

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

Returns:


2288
2289
2290
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2288

def tables
  @tables
end

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

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

Returns:


2293
2294
2295
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2293

def tokens
  @tokens
end

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

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

Returns:


2299
2300
2301
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2299

def transforms
  @transforms
end

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

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

Returns:


2305
2306
2307
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2305

def visual_elements
  @visual_elements
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2312

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