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.



2724
2725
2726
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2724

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:



2636
2637
2638
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2636

def blocks
  @blocks
end

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

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

Returns:



2641
2642
2643
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2641

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:



2646
2647
2648
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2646

def detected_languages
  @detected_languages
end

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

Dimension for the page. Corresponds to the JSON property dimension

Returns:



2651
2652
2653
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2651

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:



2656
2657
2658
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2656

def form_fields
  @form_fields
end

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

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

Returns:



2661
2662
2663
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2661

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:



2666
2667
2668
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2666

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:



2671
2672
2673
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2671

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:



2677
2678
2679
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2677

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) 


2683
2684
2685
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2683

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:



2689
2690
2691
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2689

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:



2695
2696
2697
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2695

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:



2700
2701
2702
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2700

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:



2705
2706
2707
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2705

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:



2710
2711
2712
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2710

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:



2716
2717
2718
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2716

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:



2722
2723
2724
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2722

def visual_elements
  @visual_elements
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2729

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