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

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.



4578
4579
4580
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4578

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:



4490
4491
4492
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4490

def blocks
  @blocks
end

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

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

Returns:



4495
4496
4497
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4495

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:



4500
4501
4502
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4500

def detected_languages
  @detected_languages
end

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

Dimension for the page. Corresponds to the JSON property dimension

Returns:



4505
4506
4507
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4505

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:



4510
4511
4512
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4510

def form_fields
  @form_fields
end

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

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

Returns:



4515
4516
4517
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4515

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:



4520
4521
4522
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4520

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:



4525
4526
4527
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4525

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:



4531
4532
4533
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4531

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) 


4537
4538
4539
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4537

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:



4543
4544
4545
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4543

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:



4549
4550
4551
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4549

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:



4554
4555
4556
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4554

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:



4559
4560
4561
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4559

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:



4564
4565
4566
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4564

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:



4570
4571
4572
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4570

def transforms
  @transforms
end

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

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

Returns:



4576
4577
4578
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4576

def visual_elements
  @visual_elements
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4583

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