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.



1159
1160
1161
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1159

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:



1086
1087
1088
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1086

def blocks
  @blocks
end

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

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

Returns:



1091
1092
1093
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1091

def detected_languages
  @detected_languages
end

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

Dimension for the page. Corresponds to the JSON property dimension

Returns:



1096
1097
1098
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1096

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:



1101
1102
1103
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1101

def form_fields
  @form_fields
end

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

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

Returns:



1106
1107
1108
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1106

def image
  @image
end

#layout ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageLayout

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

Returns:



1111
1112
1113
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1111

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:



1117
1118
1119
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1117

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) 


1123
1124
1125
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1123

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:



1129
1130
1131
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1129

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:



1135
1136
1137
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1135

def provenance
  @provenance
end

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

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

Returns:



1140
1141
1142
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1140

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:



1145
1146
1147
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1145

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:



1151
1152
1153
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1151

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:



1157
1158
1159
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1157

def visual_elements
  @visual_elements
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1164

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