google-cloud-document_ai-v1beta3 0.10.0 → 0.11.0
Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: e10c45db6849956a79a1b0c83d137746c5007bbc64104dd134dae12682a31503
|
|
4
|
+
data.tar.gz: 82db138a621be98e50bb58490aad1cdc42c614fff43d4b0b888849987d649e46
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 50f2f7f98cc9c98ba705359484ddb6c47a2dd15f0b5e5b704da4398e4d1e15187308dae5eaa96ffb716aa33d1a8766b0ff4b64983302926c46eed24736a446f8
|
|
7
|
+
data.tar.gz: b8f65426674274bc75c64dffabc850e9f3bb04c45db701a13074eb2c3e37596978d625eac912886a5ab1921106d3813408fe15fb99f6178386cd7403b8975f67
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
|
2
2
|
# source: google/cloud/documentai/v1beta3/document.proto
|
|
3
3
|
|
|
4
|
+
require 'google/api/annotations_pb'
|
|
4
5
|
require 'google/api/field_behavior_pb'
|
|
5
6
|
require 'google/cloud/documentai/v1beta3/geometry_pb'
|
|
6
7
|
require 'google/protobuf/timestamp_pb'
|
|
@@ -10,7 +11,6 @@ require 'google/type/date_pb'
|
|
|
10
11
|
require 'google/type/datetime_pb'
|
|
11
12
|
require 'google/type/money_pb'
|
|
12
13
|
require 'google/type/postal_address_pb'
|
|
13
|
-
require 'google/api/annotations_pb'
|
|
14
14
|
require 'google/protobuf'
|
|
15
15
|
|
|
16
16
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
@@ -63,6 +63,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
|
63
63
|
repeated :visual_elements, :message, 9, "google.cloud.documentai.v1beta3.Document.Page.VisualElement"
|
|
64
64
|
repeated :tables, :message, 10, "google.cloud.documentai.v1beta3.Document.Page.Table"
|
|
65
65
|
repeated :form_fields, :message, 11, "google.cloud.documentai.v1beta3.Document.Page.FormField"
|
|
66
|
+
repeated :symbols, :message, 12, "google.cloud.documentai.v1beta3.Document.Page.Symbol"
|
|
66
67
|
optional :provenance, :message, 16, "google.cloud.documentai.v1beta3.Document.Provenance"
|
|
67
68
|
end
|
|
68
69
|
add_message "google.cloud.documentai.v1beta3.Document.Page.Dimension" do
|
|
@@ -125,6 +126,10 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
|
125
126
|
value :WIDE_SPACE, 2
|
|
126
127
|
value :HYPHEN, 3
|
|
127
128
|
end
|
|
129
|
+
add_message "google.cloud.documentai.v1beta3.Document.Page.Symbol" do
|
|
130
|
+
optional :layout, :message, 1, "google.cloud.documentai.v1beta3.Document.Page.Layout"
|
|
131
|
+
repeated :detected_languages, :message, 2, "google.cloud.documentai.v1beta3.Document.Page.DetectedLanguage"
|
|
132
|
+
end
|
|
128
133
|
add_message "google.cloud.documentai.v1beta3.Document.Page.VisualElement" do
|
|
129
134
|
optional :layout, :message, 1, "google.cloud.documentai.v1beta3.Document.Page.Layout"
|
|
130
135
|
optional :type, :string, 2
|
|
@@ -275,6 +280,7 @@ module Google
|
|
|
275
280
|
Document::Page::Token = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.Document.Page.Token").msgclass
|
|
276
281
|
Document::Page::Token::DetectedBreak = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.Document.Page.Token.DetectedBreak").msgclass
|
|
277
282
|
Document::Page::Token::DetectedBreak::Type = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.Document.Page.Token.DetectedBreak.Type").enummodule
|
|
283
|
+
Document::Page::Symbol = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.Document.Page.Symbol").msgclass
|
|
278
284
|
Document::Page::VisualElement = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.Document.Page.VisualElement").msgclass
|
|
279
285
|
Document::Page::Table = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.Document.Page.Table").msgclass
|
|
280
286
|
Document::Page::Table::TableRow = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.Document.Page.Table.TableRow").msgclass
|
|
@@ -48,22 +48,26 @@ module Google
|
|
|
48
48
|
# Optional. UTF-8 encoded text in reading order from the document.
|
|
49
49
|
# @!attribute [rw] text_styles
|
|
50
50
|
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Style>]
|
|
51
|
-
# Styles for the
|
|
51
|
+
# Placeholder. Styles for the
|
|
52
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
|
|
52
53
|
# @!attribute [rw] pages
|
|
53
54
|
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page>]
|
|
54
|
-
# Visual page layout for the
|
|
55
|
+
# Visual page layout for the
|
|
56
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document Document}.
|
|
55
57
|
# @!attribute [rw] entities
|
|
56
58
|
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Entity>]
|
|
57
|
-
# A list of entities detected on
|
|
58
|
-
#
|
|
59
|
+
# A list of entities detected on
|
|
60
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}. For
|
|
61
|
+
# document shards, entities in this list may cross shard boundaries.
|
|
59
62
|
# @!attribute [rw] entity_relations
|
|
60
63
|
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::EntityRelation>]
|
|
61
|
-
# Relationship among
|
|
64
|
+
# Placeholder. Relationship among
|
|
65
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document#entities Document.entities}.
|
|
62
66
|
# @!attribute [rw] text_changes
|
|
63
67
|
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::TextChange>]
|
|
64
|
-
# A list of text corrections made to [Document.text]. This is
|
|
65
|
-
# used for annotating corrections to OCR mistakes. Text changes for
|
|
66
|
-
# revision may not overlap with each other.
|
|
68
|
+
# Placeholder. A list of text corrections made to [Document.text]. This is
|
|
69
|
+
# usually used for annotating corrections to OCR mistakes. Text changes for
|
|
70
|
+
# a given revision may not overlap with each other.
|
|
67
71
|
# @!attribute [rw] shard_info
|
|
68
72
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::ShardInfo]
|
|
69
73
|
# Information about the sharding if this document is sharded part of a larger
|
|
@@ -73,7 +77,7 @@ module Google
|
|
|
73
77
|
# Any error that occurred while processing this document.
|
|
74
78
|
# @!attribute [rw] revisions
|
|
75
79
|
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Revision>]
|
|
76
|
-
# Revision history of this document.
|
|
80
|
+
# Placeholder. Revision history of this document.
|
|
77
81
|
class Document
|
|
78
82
|
include ::Google::Protobuf::MessageExts
|
|
79
83
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -89,8 +93,9 @@ module Google
|
|
|
89
93
|
# Total number of shards.
|
|
90
94
|
# @!attribute [rw] text_offset
|
|
91
95
|
# @return [::Integer]
|
|
92
|
-
# The index of the first character in
|
|
93
|
-
#
|
|
96
|
+
# The index of the first character in
|
|
97
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text} in the
|
|
98
|
+
# overall document global text.
|
|
94
99
|
class ShardInfo
|
|
95
100
|
include ::Google::Protobuf::MessageExts
|
|
96
101
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -100,7 +105,8 @@ module Google
|
|
|
100
105
|
# conventions as much as possible.
|
|
101
106
|
# @!attribute [rw] text_anchor
|
|
102
107
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::TextAnchor]
|
|
103
|
-
# Text anchor indexing into the
|
|
108
|
+
# Text anchor indexing into the
|
|
109
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
|
|
104
110
|
# @!attribute [rw] color
|
|
105
111
|
# @return [::Google::Type::Color]
|
|
106
112
|
# Text color.
|
|
@@ -143,9 +149,11 @@ module Google
|
|
|
143
149
|
# A page in a {::Google::Cloud::DocumentAI::V1beta3::Document Document}.
|
|
144
150
|
# @!attribute [rw] page_number
|
|
145
151
|
# @return [::Integer]
|
|
146
|
-
# 1-based index for current
|
|
147
|
-
#
|
|
148
|
-
#
|
|
152
|
+
# 1-based index for current
|
|
153
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page Page} in a parent
|
|
154
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document Document}. Useful when a page
|
|
155
|
+
# is taken out of a {::Google::Cloud::DocumentAI::V1beta3::Document Document}
|
|
156
|
+
# for individual processing.
|
|
149
157
|
# @!attribute [rw] image
|
|
150
158
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Image]
|
|
151
159
|
# Rendered image for this page. This image is preprocessed to remove any
|
|
@@ -154,13 +162,15 @@ module Google
|
|
|
154
162
|
# @!attribute [rw] transforms
|
|
155
163
|
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::Matrix>]
|
|
156
164
|
# Transformation matrices that were applied to the original document image
|
|
157
|
-
# to produce
|
|
165
|
+
# to produce
|
|
166
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page#image Page.image}.
|
|
158
167
|
# @!attribute [rw] dimension
|
|
159
168
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Dimension]
|
|
160
169
|
# Physical dimension of the page.
|
|
161
170
|
# @!attribute [rw] layout
|
|
162
171
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
|
|
163
|
-
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for the
|
|
172
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for the
|
|
173
|
+
# page.
|
|
164
174
|
# @!attribute [rw] detected_languages
|
|
165
175
|
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>]
|
|
166
176
|
# A list of detected languages together with confidence.
|
|
@@ -190,6 +200,9 @@ module Google
|
|
|
190
200
|
# @!attribute [rw] form_fields
|
|
191
201
|
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::FormField>]
|
|
192
202
|
# A list of visually detected form fields on the page.
|
|
203
|
+
# @!attribute [rw] symbols
|
|
204
|
+
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::Symbol>]
|
|
205
|
+
# A list of visually detected symbols on the page.
|
|
193
206
|
# @!attribute [rw] provenance
|
|
194
207
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Provenance]
|
|
195
208
|
# The history of this page.
|
|
@@ -255,18 +268,23 @@ module Google
|
|
|
255
268
|
# Visual element describing a layout unit on a page.
|
|
256
269
|
# @!attribute [rw] text_anchor
|
|
257
270
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::TextAnchor]
|
|
258
|
-
# Text anchor indexing into the
|
|
271
|
+
# Text anchor indexing into the
|
|
272
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
|
|
259
273
|
# @!attribute [rw] confidence
|
|
260
274
|
# @return [::Float]
|
|
261
|
-
# Confidence of the current
|
|
262
|
-
#
|
|
263
|
-
#
|
|
275
|
+
# Confidence of the current
|
|
276
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} within
|
|
277
|
+
# context of the object this layout is for. e.g. confidence can be for a
|
|
278
|
+
# single token, a table, a visual element, etc. depending on context.
|
|
279
|
+
# Range [0, 1].
|
|
264
280
|
# @!attribute [rw] bounding_poly
|
|
265
281
|
# @return [::Google::Cloud::DocumentAI::V1beta3::BoundingPoly]
|
|
266
|
-
# The bounding polygon for the
|
|
282
|
+
# The bounding polygon for the
|
|
283
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout}.
|
|
267
284
|
# @!attribute [rw] orientation
|
|
268
285
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout::Orientation]
|
|
269
|
-
# Detected orientation for the
|
|
286
|
+
# Detected orientation for the
|
|
287
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout}.
|
|
270
288
|
class Layout
|
|
271
289
|
include ::Google::Protobuf::MessageExts
|
|
272
290
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -297,7 +315,8 @@ module Google
|
|
|
297
315
|
# common line-spacing and orientation.
|
|
298
316
|
# @!attribute [rw] layout
|
|
299
317
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
|
|
300
|
-
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for
|
|
318
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for
|
|
319
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Block Block}.
|
|
301
320
|
# @!attribute [rw] detected_languages
|
|
302
321
|
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>]
|
|
303
322
|
# A list of detected languages together with confidence.
|
|
@@ -312,7 +331,8 @@ module Google
|
|
|
312
331
|
# A collection of lines that a human would perceive as a paragraph.
|
|
313
332
|
# @!attribute [rw] layout
|
|
314
333
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
|
|
315
|
-
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for
|
|
334
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for
|
|
335
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Paragraph Paragraph}.
|
|
316
336
|
# @!attribute [rw] detected_languages
|
|
317
337
|
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>]
|
|
318
338
|
# A list of detected languages together with confidence.
|
|
@@ -328,7 +348,8 @@ module Google
|
|
|
328
348
|
# Does not cross column boundaries, can be horizontal, vertical, etc.
|
|
329
349
|
# @!attribute [rw] layout
|
|
330
350
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
|
|
331
|
-
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for
|
|
351
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for
|
|
352
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Line Line}.
|
|
332
353
|
# @!attribute [rw] detected_languages
|
|
333
354
|
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>]
|
|
334
355
|
# A list of detected languages together with confidence.
|
|
@@ -343,10 +364,12 @@ module Google
|
|
|
343
364
|
# A detected token.
|
|
344
365
|
# @!attribute [rw] layout
|
|
345
366
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
|
|
346
|
-
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for
|
|
367
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for
|
|
368
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token Token}.
|
|
347
369
|
# @!attribute [rw] detected_break
|
|
348
370
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token::DetectedBreak]
|
|
349
|
-
# Detected break at the end of a
|
|
371
|
+
# Detected break at the end of a
|
|
372
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token Token}.
|
|
350
373
|
# @!attribute [rw] detected_languages
|
|
351
374
|
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>]
|
|
352
375
|
# A list of detected languages together with confidence.
|
|
@@ -357,7 +380,8 @@ module Google
|
|
|
357
380
|
include ::Google::Protobuf::MessageExts
|
|
358
381
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
359
382
|
|
|
360
|
-
# Detected break at the end of a
|
|
383
|
+
# Detected break at the end of a
|
|
384
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token Token}.
|
|
361
385
|
# @!attribute [rw] type
|
|
362
386
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token::DetectedBreak::Type]
|
|
363
387
|
# Detected break type.
|
|
@@ -382,14 +406,29 @@ module Google
|
|
|
382
406
|
end
|
|
383
407
|
end
|
|
384
408
|
|
|
409
|
+
# A detected symbol.
|
|
410
|
+
# @!attribute [rw] layout
|
|
411
|
+
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
|
|
412
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for
|
|
413
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Symbol Symbol}.
|
|
414
|
+
# @!attribute [rw] detected_languages
|
|
415
|
+
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>]
|
|
416
|
+
# A list of detected languages together with confidence.
|
|
417
|
+
class Symbol
|
|
418
|
+
include ::Google::Protobuf::MessageExts
|
|
419
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
420
|
+
end
|
|
421
|
+
|
|
385
422
|
# Detected non-text visual elements e.g. checkbox, signature etc. on the
|
|
386
423
|
# page.
|
|
387
424
|
# @!attribute [rw] layout
|
|
388
425
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
|
|
389
|
-
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for
|
|
426
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for
|
|
427
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::VisualElement VisualElement}.
|
|
390
428
|
# @!attribute [rw] type
|
|
391
429
|
# @return [::String]
|
|
392
|
-
# Type of the
|
|
430
|
+
# Type of the
|
|
431
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::VisualElement VisualElement}.
|
|
393
432
|
# @!attribute [rw] detected_languages
|
|
394
433
|
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>]
|
|
395
434
|
# A list of detected languages together with confidence.
|
|
@@ -401,7 +440,8 @@ module Google
|
|
|
401
440
|
# A table representation similar to HTML table structure.
|
|
402
441
|
# @!attribute [rw] layout
|
|
403
442
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
|
|
404
|
-
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for
|
|
443
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for
|
|
444
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Table Table}.
|
|
405
445
|
# @!attribute [rw] header_rows
|
|
406
446
|
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::Table::TableRow>]
|
|
407
447
|
# Header rows of the table.
|
|
@@ -427,7 +467,8 @@ module Google
|
|
|
427
467
|
# A cell representation inside the table.
|
|
428
468
|
# @!attribute [rw] layout
|
|
429
469
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
|
|
430
|
-
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for
|
|
470
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for
|
|
471
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Table::TableCell TableCell}.
|
|
431
472
|
# @!attribute [rw] row_span
|
|
432
473
|
# @return [::Integer]
|
|
433
474
|
# How many rows this cell spans.
|
|
@@ -446,11 +487,14 @@ module Google
|
|
|
446
487
|
# A form field detected on the page.
|
|
447
488
|
# @!attribute [rw] field_name
|
|
448
489
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
|
|
449
|
-
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for the
|
|
450
|
-
#
|
|
490
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for the
|
|
491
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::FormField FormField}
|
|
492
|
+
# name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
|
|
451
493
|
# @!attribute [rw] field_value
|
|
452
494
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
|
|
453
|
-
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for the
|
|
495
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for the
|
|
496
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::FormField FormField}
|
|
497
|
+
# value.
|
|
454
498
|
# @!attribute [rw] name_detected_languages
|
|
455
499
|
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>]
|
|
456
500
|
# A list of detected languages for name together with confidence.
|
|
@@ -477,7 +521,7 @@ module Google
|
|
|
477
521
|
# @return [::String]
|
|
478
522
|
# The BCP-47 language code, such as "en-US" or "sr-Latn". For more
|
|
479
523
|
# information, see
|
|
480
|
-
#
|
|
524
|
+
# https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
|
|
481
525
|
# @!attribute [rw] confidence
|
|
482
526
|
# @return [::Float]
|
|
483
527
|
# Confidence of detected language. Range [0, 1].
|
|
@@ -487,18 +531,21 @@ module Google
|
|
|
487
531
|
end
|
|
488
532
|
end
|
|
489
533
|
|
|
490
|
-
#
|
|
491
|
-
#
|
|
534
|
+
# An entity that could be a phrase in the text or a property that belongs to
|
|
535
|
+
# the document. It is a known entity type, such as a person, an organization,
|
|
536
|
+
# or location.
|
|
492
537
|
# @!attribute [rw] text_anchor
|
|
493
538
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::TextAnchor]
|
|
494
539
|
# Optional. Provenance of the entity.
|
|
495
|
-
# Text anchor indexing into the
|
|
540
|
+
# Text anchor indexing into the
|
|
541
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
|
|
496
542
|
# @!attribute [rw] type
|
|
497
543
|
# @return [::String]
|
|
498
544
|
# Entity type from a schema e.g. `Address`.
|
|
499
545
|
# @!attribute [rw] mention_text
|
|
500
546
|
# @return [::String]
|
|
501
|
-
# Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`.
|
|
547
|
+
# Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If
|
|
548
|
+
# the entity is not present in the document, this field will be empty.
|
|
502
549
|
# @!attribute [rw] mention_id
|
|
503
550
|
# @return [::String]
|
|
504
551
|
# Optional. Deprecated. Use `id` field instead.
|
|
@@ -507,28 +554,29 @@ module Google
|
|
|
507
554
|
# Optional. Confidence of detected Schema entity. Range [0, 1].
|
|
508
555
|
# @!attribute [rw] page_anchor
|
|
509
556
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::PageAnchor]
|
|
510
|
-
# Optional. Represents the provenance of this entity wrt. the location on
|
|
511
|
-
# page where it was found.
|
|
557
|
+
# Optional. Represents the provenance of this entity wrt. the location on
|
|
558
|
+
# the page where it was found.
|
|
512
559
|
# @!attribute [rw] id
|
|
513
560
|
# @return [::String]
|
|
514
561
|
# Optional. Canonical id. This will be a unique value in the entity list
|
|
515
562
|
# for this document.
|
|
516
563
|
# @!attribute [rw] normalized_value
|
|
517
564
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Entity::NormalizedValue]
|
|
518
|
-
# Optional. Normalized entity value. Absent if the extracted value could
|
|
519
|
-
# converted or the type (e.g. address) is not supported for certain
|
|
565
|
+
# Optional. Normalized entity value. Absent if the extracted value could
|
|
566
|
+
# not be converted or the type (e.g. address) is not supported for certain
|
|
520
567
|
# parsers. This field is also only populated for certain supported document
|
|
521
568
|
# types.
|
|
522
569
|
# @!attribute [rw] properties
|
|
523
570
|
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Entity>]
|
|
524
|
-
# Optional. Entities can be nested to form a hierarchical data structure
|
|
525
|
-
# the content in the document.
|
|
571
|
+
# Optional. Entities can be nested to form a hierarchical data structure
|
|
572
|
+
# representing the content in the document.
|
|
526
573
|
# @!attribute [rw] provenance
|
|
527
574
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Provenance]
|
|
528
575
|
# Optional. The history of this annotation.
|
|
529
576
|
# @!attribute [rw] redacted
|
|
530
577
|
# @return [::Boolean]
|
|
531
|
-
# Optional. Whether the entity will be redacted for de-identification
|
|
578
|
+
# Optional. Whether the entity will be redacted for de-identification
|
|
579
|
+
# purposes.
|
|
532
580
|
class Entity
|
|
533
581
|
include ::Google::Protobuf::MessageExts
|
|
534
582
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -556,10 +604,13 @@ module Google
|
|
|
556
604
|
# checkboxes.
|
|
557
605
|
# @!attribute [rw] text
|
|
558
606
|
# @return [::String]
|
|
559
|
-
#
|
|
560
|
-
#
|
|
561
|
-
#
|
|
607
|
+
# Optional. An optional field to store a normalized string.
|
|
608
|
+
# For some entity types, one of respective `structured_value` fields may
|
|
609
|
+
# also be populated. Also not all the types of `structured_value` will be
|
|
610
|
+
# normalized. For example, some processors may not generate float
|
|
611
|
+
# or int normalized text by default.
|
|
562
612
|
#
|
|
613
|
+
# Below are sample formats mapped to structured values.
|
|
563
614
|
# - Money/Currency type (`money_value`) is in the ISO 4217 text format.
|
|
564
615
|
# - Date type (`date_value`) is in the ISO 8601 text format.
|
|
565
616
|
# - Datetime type (`datetime_value`) is in the ISO 8601 text format.
|
|
@@ -569,7 +620,8 @@ module Google
|
|
|
569
620
|
end
|
|
570
621
|
end
|
|
571
622
|
|
|
572
|
-
# Relationship between
|
|
623
|
+
# Relationship between
|
|
624
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Entity Entities}.
|
|
573
625
|
# @!attribute [rw] subject_id
|
|
574
626
|
# @return [::String]
|
|
575
627
|
# Subject entity id.
|
|
@@ -584,27 +636,35 @@ module Google
|
|
|
584
636
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
585
637
|
end
|
|
586
638
|
|
|
587
|
-
# Text reference indexing into the
|
|
639
|
+
# Text reference indexing into the
|
|
640
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
|
|
588
641
|
# @!attribute [rw] text_segments
|
|
589
642
|
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::TextAnchor::TextSegment>]
|
|
590
|
-
# The text segments from the
|
|
643
|
+
# The text segments from the
|
|
644
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
|
|
591
645
|
# @!attribute [rw] content
|
|
592
646
|
# @return [::String]
|
|
593
647
|
# Contains the content of the text span so that users do
|
|
594
|
-
# not have to look it up in the text_segments.
|
|
648
|
+
# not have to look it up in the text_segments. It is always
|
|
649
|
+
# populated for formFields.
|
|
595
650
|
class TextAnchor
|
|
596
651
|
include ::Google::Protobuf::MessageExts
|
|
597
652
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
598
653
|
|
|
599
|
-
# A text segment in the
|
|
600
|
-
#
|
|
601
|
-
#
|
|
654
|
+
# A text segment in the
|
|
655
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}. The
|
|
656
|
+
# indices may be out of bounds which indicate that the text extends into
|
|
657
|
+
# another document shard for large sharded documents. See
|
|
658
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::ShardInfo#text_offset ShardInfo.text_offset}
|
|
602
659
|
# @!attribute [rw] start_index
|
|
603
660
|
# @return [::Integer]
|
|
604
|
-
# {::Google::Cloud::DocumentAI::V1beta3::Document::TextAnchor::TextSegment TextSegment}
|
|
661
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::TextAnchor::TextSegment TextSegment}
|
|
662
|
+
# start UTF-8 char index in the
|
|
663
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
|
|
605
664
|
# @!attribute [rw] end_index
|
|
606
665
|
# @return [::Integer]
|
|
607
|
-
# {::Google::Cloud::DocumentAI::V1beta3::Document::TextAnchor::TextSegment TextSegment}
|
|
666
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::TextAnchor::TextSegment TextSegment}
|
|
667
|
+
# half open end UTF-8 char index in the
|
|
608
668
|
# {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
|
|
609
669
|
class TextSegment
|
|
610
670
|
include ::Google::Protobuf::MessageExts
|
|
@@ -612,8 +672,9 @@ module Google
|
|
|
612
672
|
end
|
|
613
673
|
end
|
|
614
674
|
|
|
615
|
-
# Referencing the visual context of the entity in the
|
|
616
|
-
#
|
|
675
|
+
# Referencing the visual context of the entity in the
|
|
676
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document#pages Document.pages}. Page
|
|
677
|
+
# anchors can be cross-page, consist of multiple bounding polygons and
|
|
617
678
|
# optionally reference specific layout element types.
|
|
618
679
|
# @!attribute [rw] page_refs
|
|
619
680
|
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::PageAnchor::PageRef>]
|
|
@@ -625,22 +686,29 @@ module Google
|
|
|
625
686
|
# Represents a weak reference to a page element within a document.
|
|
626
687
|
# @!attribute [rw] page
|
|
627
688
|
# @return [::Integer]
|
|
628
|
-
# Required. Index into the
|
|
629
|
-
#
|
|
630
|
-
#
|
|
689
|
+
# Required. Index into the
|
|
690
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document#pages Document.pages}
|
|
691
|
+
# element, for example using [Document.pages][page_refs.page] to locate
|
|
692
|
+
# the related page element. This field is skipped when its value is the
|
|
693
|
+
# default 0. See
|
|
631
694
|
# https://developers.google.com/protocol-buffers/docs/proto3#json.
|
|
632
695
|
# @!attribute [rw] layout_type
|
|
633
696
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::PageAnchor::PageRef::LayoutType]
|
|
634
|
-
# Optional. The type of the layout element that is being referenced if
|
|
697
|
+
# Optional. The type of the layout element that is being referenced if
|
|
698
|
+
# any.
|
|
635
699
|
# @!attribute [rw] layout_id
|
|
636
700
|
# @return [::String]
|
|
637
|
-
# Optional. Deprecated. Use
|
|
701
|
+
# Optional. Deprecated. Use
|
|
702
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::PageAnchor::PageRef#bounding_poly PageRef.bounding_poly}
|
|
703
|
+
# instead.
|
|
638
704
|
# @!attribute [rw] bounding_poly
|
|
639
705
|
# @return [::Google::Cloud::DocumentAI::V1beta3::BoundingPoly]
|
|
640
|
-
# Optional. Identifies the bounding polygon of a layout element on the
|
|
706
|
+
# Optional. Identifies the bounding polygon of a layout element on the
|
|
707
|
+
# page.
|
|
641
708
|
# @!attribute [rw] confidence
|
|
642
709
|
# @return [::Float]
|
|
643
|
-
# Optional. Confidence of detected page element, if applicable. Range [0,
|
|
710
|
+
# Optional. Confidence of detected page element, if applicable. Range [0,
|
|
711
|
+
# 1].
|
|
644
712
|
class PageRef
|
|
645
713
|
include ::Google::Protobuf::MessageExts
|
|
646
714
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -650,25 +718,39 @@ module Google
|
|
|
650
718
|
# Layout Unspecified.
|
|
651
719
|
LAYOUT_TYPE_UNSPECIFIED = 0
|
|
652
720
|
|
|
653
|
-
# References a
|
|
721
|
+
# References a
|
|
722
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page#blocks Page.blocks}
|
|
723
|
+
# element.
|
|
654
724
|
BLOCK = 1
|
|
655
725
|
|
|
656
|
-
# References a
|
|
726
|
+
# References a
|
|
727
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page#paragraphs Page.paragraphs}
|
|
728
|
+
# element.
|
|
657
729
|
PARAGRAPH = 2
|
|
658
730
|
|
|
659
|
-
# References a
|
|
731
|
+
# References a
|
|
732
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page#lines Page.lines}
|
|
733
|
+
# element.
|
|
660
734
|
LINE = 3
|
|
661
735
|
|
|
662
|
-
# References a
|
|
736
|
+
# References a
|
|
737
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page#tokens Page.tokens}
|
|
738
|
+
# element.
|
|
663
739
|
TOKEN = 4
|
|
664
740
|
|
|
665
|
-
# References a
|
|
741
|
+
# References a
|
|
742
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page#visual_elements Page.visual_elements}
|
|
743
|
+
# element.
|
|
666
744
|
VISUAL_ELEMENT = 5
|
|
667
745
|
|
|
668
|
-
# Refrrences a
|
|
746
|
+
# Refrrences a
|
|
747
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page#tables Page.tables}
|
|
748
|
+
# element.
|
|
669
749
|
TABLE = 6
|
|
670
750
|
|
|
671
|
-
# References a
|
|
751
|
+
# References a
|
|
752
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page#form_fields Page.form_fields}
|
|
753
|
+
# element.
|
|
672
754
|
FORM_FIELD = 7
|
|
673
755
|
end
|
|
674
756
|
end
|
|
@@ -693,16 +775,15 @@ module Google
|
|
|
693
775
|
include ::Google::Protobuf::MessageExts
|
|
694
776
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
695
777
|
|
|
696
|
-
#
|
|
697
|
-
#
|
|
698
|
-
# are replaced.
|
|
778
|
+
# The parent element the current element is based on. Used for
|
|
779
|
+
# referencing/aligning, removal and replacement operations.
|
|
699
780
|
# @!attribute [rw] revision
|
|
700
781
|
# @return [::Integer]
|
|
701
|
-
# The index of the
|
|
782
|
+
# The index of the index into current revision's parent_ids list.
|
|
702
783
|
# @!attribute [rw] index
|
|
703
784
|
# @return [::Integer]
|
|
704
|
-
# The index of the parent
|
|
705
|
-
#
|
|
785
|
+
# The index of the parent item in the corresponding item list (eg. list
|
|
786
|
+
# of entities, properties within entities, etc.) in the parent revision.
|
|
706
787
|
# @!attribute [rw] id
|
|
707
788
|
# @return [::Integer]
|
|
708
789
|
# The id of the parent provenance.
|
|
@@ -713,19 +794,20 @@ module Google
|
|
|
713
794
|
|
|
714
795
|
# If a processor or agent does an explicit operation on existing elements.
|
|
715
796
|
module OperationType
|
|
716
|
-
# Operation type unspecified.
|
|
797
|
+
# Operation type unspecified. If no operation is specified a provenance
|
|
798
|
+
# entry is simply used to match against a `parent`.
|
|
717
799
|
OPERATION_TYPE_UNSPECIFIED = 0
|
|
718
800
|
|
|
719
|
-
# Add an element.
|
|
801
|
+
# Add an element.
|
|
720
802
|
ADD = 1
|
|
721
803
|
|
|
722
|
-
#
|
|
804
|
+
# Remove an element identified by `parent`.
|
|
723
805
|
REMOVE = 2
|
|
724
806
|
|
|
725
|
-
#
|
|
807
|
+
# Replace an element identified by `parent`.
|
|
726
808
|
REPLACE = 3
|
|
727
809
|
|
|
728
|
-
#
|
|
810
|
+
# Request human review for the element identified by `parent`.
|
|
729
811
|
EVAL_REQUESTED = 4
|
|
730
812
|
|
|
731
813
|
# Element is reviewed and approved at human review, confidence will be
|
|
@@ -782,10 +864,11 @@ module Google
|
|
|
782
864
|
# @!attribute [rw] text_anchor
|
|
783
865
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::TextAnchor]
|
|
784
866
|
# Provenance of the correction.
|
|
785
|
-
# Text anchor indexing into the
|
|
786
|
-
#
|
|
787
|
-
#
|
|
788
|
-
#
|
|
867
|
+
# Text anchor indexing into the
|
|
868
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}. There
|
|
869
|
+
# can only be a single `TextAnchor.text_segments` element. If the start
|
|
870
|
+
# and end index of the text segment are the same, the text change is
|
|
871
|
+
# inserted before that index.
|
|
789
872
|
# @!attribute [rw] changed_text
|
|
790
873
|
# @return [::String]
|
|
791
874
|
# The text that replaces the text identified in the `text_anchor`.
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-document_ai-v1beta3
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.11.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2022-02-
|
|
11
|
+
date: 2022-02-16 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: gapic-common
|