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]

2314
2315
2316
# File 'lib/google/apis/documentai_v1/classes.rb', line 2314

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

Instance Attribute Details

#blocksArray<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


2226
2227
2228
# File 'lib/google/apis/documentai_v1/classes.rb', line 2226

def blocks
  @blocks
end

#detected_barcodesArray<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageDetectedBarcode>

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


2231
2232
2233
# File 'lib/google/apis/documentai_v1/classes.rb', line 2231

def detected_barcodes
  @detected_barcodes
end

#detected_languagesArray<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageDetectedLanguage>

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


2236
2237
2238
# File 'lib/google/apis/documentai_v1/classes.rb', line 2236

def detected_languages
  @detected_languages
end

#dimensionGoogle::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageDimension

Dimension for the page. Corresponds to the JSON property dimension


2241
2242
2243
# File 'lib/google/apis/documentai_v1/classes.rb', line 2241

def dimension
  @dimension
end

#form_fieldsArray<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageFormField>

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


2246
2247
2248
# File 'lib/google/apis/documentai_v1/classes.rb', line 2246

def form_fields
  @form_fields
end

#imageGoogle::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageImage

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


2251
2252
2253
# File 'lib/google/apis/documentai_v1/classes.rb', line 2251

def image
  @image
end

#image_quality_scoresGoogle::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageImageQualityScores

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


2256
2257
2258
# File 'lib/google/apis/documentai_v1/classes.rb', line 2256

def image_quality_scores
  @image_quality_scores
end

#layoutGoogle::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageLayout

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


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

def layout
  @layout
end

#linesArray<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


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

def lines
  @lines
end

#page_numberFixnum

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)

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

def page_number
  @page_number
end

#paragraphsArray<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


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

def paragraphs
  @paragraphs
end

#provenanceGoogle::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentProvenance

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


2285
2286
2287
# File 'lib/google/apis/documentai_v1/classes.rb', line 2285

def provenance
  @provenance
end

#symbolsArray<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageSymbol>

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


2290
2291
2292
# File 'lib/google/apis/documentai_v1/classes.rb', line 2290

def symbols
  @symbols
end

#tablesArray<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageTable>

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


2295
2296
2297
# File 'lib/google/apis/documentai_v1/classes.rb', line 2295

def tables
  @tables
end

#tokensArray<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageToken>

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


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

def tokens
  @tokens
end

#transformsArray<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageMatrix>

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


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

def transforms
  @transforms
end

#visual_elementsArray<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


2312
2313
2314
# File 'lib/google/apis/documentai_v1/classes.rb', line 2312

def visual_elements
  @visual_elements
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
# File 'lib/google/apis/documentai_v1/classes.rb', line 2319

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