Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPage

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) ⇒ GoogleCloudDocumentaiV1beta1DocumentPage

Returns a new instance of GoogleCloudDocumentaiV1beta1DocumentPage.



3846
3847
3848
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3846

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

Instance Attribute Details

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

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:



3773
3774
3775
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3773

def blocks
  @blocks
end

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

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

Returns:



3778
3779
3780
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3778

def detected_languages
  @detected_languages
end

#dimension ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageDimension

Dimension for the page. Corresponds to the JSON property dimension

Returns:



3783
3784
3785
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3783

def dimension
  @dimension
end

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

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

Returns:



3788
3789
3790
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3788

def form_fields
  @form_fields
end

#image ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageImage

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

Returns:



3793
3794
3795
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3793

def image
  @image
end

#layout ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageLayout

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

Returns:



3798
3799
3800
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3798

def layout
  @layout
end

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

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:



3804
3805
3806
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3804

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) 


3810
3811
3812
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3810

def page_number
  @page_number
end

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

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:



3816
3817
3818
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3816

def paragraphs
  @paragraphs
end

#provenance ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentProvenance

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

Returns:



3822
3823
3824
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3822

def provenance
  @provenance
end

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

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

Returns:



3827
3828
3829
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3827

def tables
  @tables
end

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

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

Returns:



3832
3833
3834
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3832

def tokens
  @tokens
end

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

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

Returns:



3838
3839
3840
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3838

def transforms
  @transforms
end

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

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

Returns:



3844
3845
3846
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3844

def visual_elements
  @visual_elements
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3851

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)
  @provenance = args[:provenance] if args.key?(:provenance)
  @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