Class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentPage

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/documentai_v1beta3/classes.rb,
generated/google/apis/documentai_v1beta3/representations.rb,
generated/google/apis/documentai_v1beta3/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.



2486
2487
2488
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 2486

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

Instance Attribute Details

#blocks ⇒ Array<Google::Apis::DocumentaiV1beta3::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:



2419
2420
2421
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 2419

def blocks
  @blocks
end

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

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

Returns:



2424
2425
2426
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 2424

def detected_languages
  @detected_languages
end

#dimension ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentPageDimension

Dimension for the page. Corresponds to the JSON property dimension

Returns:



2429
2430
2431
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 2429

def dimension
  @dimension
end

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

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

Returns:



2434
2435
2436
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 2434

def form_fields
  @form_fields
end

#image ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentPageImage

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

Returns:



2439
2440
2441
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 2439

def image
  @image
end

#layout ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentPageLayout

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

Returns:



2444
2445
2446
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 2444

def layout
  @layout
end

#lines ⇒ Array<Google::Apis::DocumentaiV1beta3::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:



2450
2451
2452
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 2450

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) 


2456
2457
2458
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 2456

def page_number
  @page_number
end

#paragraphs ⇒ Array<Google::Apis::DocumentaiV1beta3::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:



2462
2463
2464
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 2462

def paragraphs
  @paragraphs
end

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

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

Returns:



2467
2468
2469
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 2467

def tables
  @tables
end

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

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

Returns:



2472
2473
2474
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 2472

def tokens
  @tokens
end

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

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

Returns:



2478
2479
2480
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 2478

def transforms
  @transforms
end

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

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

Returns:



2484
2485
2486
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 2484

def visual_elements
  @visual_elements
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 2491

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