google-cloud-document_ai-v1beta3 0.12.0 → 0.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (24) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/document_ai/v1beta3/document_processor_service/client.rb +957 -123
  3. data/lib/google/cloud/document_ai/v1beta3/document_processor_service/paths.rb +21 -0
  4. data/lib/google/cloud/document_ai/v1beta3/version.rb +1 -1
  5. data/lib/google/cloud/documentai/v1beta3/barcode_pb.rb +24 -0
  6. data/lib/google/cloud/documentai/v1beta3/document_io_pb.rb +0 -2
  7. data/lib/google/cloud/documentai/v1beta3/document_pb.rb +12 -1
  8. data/lib/google/cloud/documentai/v1beta3/document_processor_service_pb.rb +83 -0
  9. data/lib/google/cloud/documentai/v1beta3/document_processor_service_services_pb.rb +21 -1
  10. data/lib/google/cloud/documentai/v1beta3/document_schema_pb.rb +60 -0
  11. data/lib/google/cloud/documentai/v1beta3/geometry_pb.rb +0 -2
  12. data/lib/google/cloud/documentai/v1beta3/operation_metadata_pb.rb +1 -1
  13. data/lib/google/cloud/documentai/v1beta3/processor_pb.rb +27 -2
  14. data/lib/google/cloud/documentai/v1beta3/processor_type_pb.rb +2 -1
  15. data/proto_docs/google/api/launch_stage.rb +71 -0
  16. data/proto_docs/google/cloud/documentai/v1beta3/barcode.rb +71 -0
  17. data/proto_docs/google/cloud/documentai/v1beta3/document.rb +111 -138
  18. data/proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb +223 -10
  19. data/proto_docs/google/cloud/documentai/v1beta3/document_schema.rb +154 -0
  20. data/proto_docs/google/cloud/documentai/v1beta3/operation_metadata.rb +3 -0
  21. data/proto_docs/google/cloud/documentai/v1beta3/processor.rb +92 -7
  22. data/proto_docs/google/cloud/documentai/v1beta3/processor_type.rb +9 -6
  23. data/proto_docs/google/protobuf/empty.rb +0 -2
  24. metadata +27 -2
data/proto_docs/google/cloud/documentai/v1beta3/document.rb CHANGED
@@ -21,11 +21,10 @@ module Google
21
21
  module Cloud
22
22
  module DocumentAI
23
23
  module V1beta3
24
- # Document represents the canonical document resource in Document Understanding
25
- # AI.
26
- # It is an interchange format that provides insights into documents and allows
27
- # for collaboration between users and Document Understanding AI to iterate and
28
- # optimize for quality.
24
+ # Document represents the canonical document resource in Document AI. It is an
25
+ # interchange format that provides insights into documents and allows for
26
+ # collaboration between users and Document AI to iterate and optimize for
27
+ # quality.
29
28
  # @!attribute [rw] uri
30
29
  # @return [::String]
31
30
  # Optional. Currently supports Google Cloud Storage URI of the form
@@ -48,21 +47,17 @@ module Google
48
47
  # Optional. UTF-8 encoded text in reading order from the document.
49
48
  # @!attribute [rw] text_styles
50
49
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Style>]
51
- # Placeholder. Styles for the
52
- # {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
50
+ # Placeholder. Styles for the {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
53
51
  # @!attribute [rw] pages
54
52
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page>]
55
- # Visual page layout for the
56
- # {::Google::Cloud::DocumentAI::V1beta3::Document Document}.
53
+ # Visual page layout for the {::Google::Cloud::DocumentAI::V1beta3::Document Document}.
57
54
  # @!attribute [rw] entities
58
55
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Entity>]
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.
56
+ # A list of entities detected on {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}. For document shards,
57
+ # entities in this list may cross shard boundaries.
62
58
  # @!attribute [rw] entity_relations
63
59
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::EntityRelation>]
64
- # Placeholder. Relationship among
65
- # {::Google::Cloud::DocumentAI::V1beta3::Document#entities Document.entities}.
60
+ # Placeholder. Relationship among {::Google::Cloud::DocumentAI::V1beta3::Document#entities Document.entities}.
66
61
  # @!attribute [rw] text_changes
67
62
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::TextChange>]
68
63
  # Placeholder. A list of text corrections made to [Document.text]. This is
@@ -93,9 +88,8 @@ module Google
93
88
  # Total number of shards.
94
89
  # @!attribute [rw] text_offset
95
90
  # @return [::Integer]
96
- # The index of the first character in
97
- # {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text} in the
98
- # overall document global text.
91
+ # The index of the first character in {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text} in the overall
92
+ # document global text.
99
93
  class ShardInfo
100
94
  include ::Google::Protobuf::MessageExts
101
95
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -105,8 +99,7 @@ module Google
105
99
  # conventions as much as possible.
106
100
  # @!attribute [rw] text_anchor
107
101
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::TextAnchor]
108
- # Text anchor indexing into the
109
- # {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
102
+ # Text anchor indexing into the {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
110
103
  # @!attribute [rw] color
111
104
  # @return [::Google::Type::Color]
112
105
  # Text color.
@@ -149,11 +142,9 @@ module Google
149
142
  # A page in a {::Google::Cloud::DocumentAI::V1beta3::Document Document}.
150
143
  # @!attribute [rw] page_number
151
144
  # @return [::Integer]
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.
145
+ # 1-based index for current {::Google::Cloud::DocumentAI::V1beta3::Document::Page Page} in a parent {::Google::Cloud::DocumentAI::V1beta3::Document Document}.
146
+ # Useful when a page is taken out of a {::Google::Cloud::DocumentAI::V1beta3::Document Document} for individual
147
+ # processing.
157
148
  # @!attribute [rw] image
158
149
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Image]
159
150
  # Rendered image for this page. This image is preprocessed to remove any
@@ -162,15 +153,13 @@ module Google
162
153
  # @!attribute [rw] transforms
163
154
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::Matrix>]
164
155
  # Transformation matrices that were applied to the original document image
165
- # to produce
166
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page#image Page.image}.
156
+ # to produce {::Google::Cloud::DocumentAI::V1beta3::Document::Page#image Page.image}.
167
157
  # @!attribute [rw] dimension
168
158
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Dimension]
169
159
  # Physical dimension of the page.
170
160
  # @!attribute [rw] layout
171
161
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
172
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for the
173
- # page.
162
+ # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for the page.
174
163
  # @!attribute [rw] detected_languages
175
164
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>]
176
165
  # A list of detected languages together with confidence.
@@ -203,6 +192,9 @@ module Google
203
192
  # @!attribute [rw] symbols
204
193
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::Symbol>]
205
194
  # A list of visually detected symbols on the page.
195
+ # @!attribute [rw] detected_barcodes
196
+ # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedBarcode>]
197
+ # A list of detected barcodes.
206
198
  # @!attribute [rw] provenance
207
199
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Provenance]
208
200
  # The history of this page.
@@ -268,23 +260,18 @@ module Google
268
260
  # Visual element describing a layout unit on a page.
269
261
  # @!attribute [rw] text_anchor
270
262
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::TextAnchor]
271
- # Text anchor indexing into the
272
- # {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
263
+ # Text anchor indexing into the {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
273
264
  # @!attribute [rw] confidence
274
265
  # @return [::Float]
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].
266
+ # Confidence of the current {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} within context of the object this
267
+ # layout is for. e.g. confidence can be for a single token, a table,
268
+ # a visual element, etc. depending on context. Range [0, 1].
280
269
  # @!attribute [rw] bounding_poly
281
270
  # @return [::Google::Cloud::DocumentAI::V1beta3::BoundingPoly]
282
- # The bounding polygon for the
283
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout}.
271
+ # The bounding polygon for the {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout}.
284
272
  # @!attribute [rw] orientation
285
273
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout::Orientation]
286
- # Detected orientation for the
287
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout}.
274
+ # Detected orientation for the {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout}.
288
275
  class Layout
289
276
  include ::Google::Protobuf::MessageExts
290
277
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -315,8 +302,7 @@ module Google
315
302
  # common line-spacing and orientation.
316
303
  # @!attribute [rw] layout
317
304
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
318
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for
319
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Block Block}.
305
+ # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Block Block}.
320
306
  # @!attribute [rw] detected_languages
321
307
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>]
322
308
  # A list of detected languages together with confidence.
@@ -331,8 +317,7 @@ module Google
331
317
  # A collection of lines that a human would perceive as a paragraph.
332
318
  # @!attribute [rw] layout
333
319
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
334
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for
335
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Paragraph Paragraph}.
320
+ # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Paragraph Paragraph}.
336
321
  # @!attribute [rw] detected_languages
337
322
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>]
338
323
  # A list of detected languages together with confidence.
@@ -348,8 +333,7 @@ module Google
348
333
  # Does not cross column boundaries, can be horizontal, vertical, etc.
349
334
  # @!attribute [rw] layout
350
335
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
351
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for
352
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Line Line}.
336
+ # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Line Line}.
353
337
  # @!attribute [rw] detected_languages
354
338
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>]
355
339
  # A list of detected languages together with confidence.
@@ -364,12 +348,10 @@ module Google
364
348
  # A detected token.
365
349
  # @!attribute [rw] layout
366
350
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
367
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for
368
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token Token}.
351
+ # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token Token}.
369
352
  # @!attribute [rw] detected_break
370
353
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token::DetectedBreak]
371
- # Detected break at the end of a
372
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token Token}.
354
+ # Detected break at the end of a {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token Token}.
373
355
  # @!attribute [rw] detected_languages
374
356
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>]
375
357
  # A list of detected languages together with confidence.
@@ -380,8 +362,7 @@ module Google
380
362
  include ::Google::Protobuf::MessageExts
381
363
  extend ::Google::Protobuf::MessageExts::ClassMethods
382
364
 
383
- # Detected break at the end of a
384
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token Token}.
365
+ # Detected break at the end of a {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token Token}.
385
366
  # @!attribute [rw] type
386
367
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token::DetectedBreak::Type]
387
368
  # Detected break type.
@@ -409,8 +390,7 @@ module Google
409
390
  # A detected symbol.
410
391
  # @!attribute [rw] layout
411
392
  # @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}.
393
+ # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Symbol Symbol}.
414
394
  # @!attribute [rw] detected_languages
415
395
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>]
416
396
  # A list of detected languages together with confidence.
@@ -423,12 +403,10 @@ module Google
423
403
  # page.
424
404
  # @!attribute [rw] layout
425
405
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
426
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for
427
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::VisualElement VisualElement}.
406
+ # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1beta3::Document::Page::VisualElement VisualElement}.
428
407
  # @!attribute [rw] type
429
408
  # @return [::String]
430
- # Type of the
431
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::VisualElement VisualElement}.
409
+ # Type of the {::Google::Cloud::DocumentAI::V1beta3::Document::Page::VisualElement VisualElement}.
432
410
  # @!attribute [rw] detected_languages
433
411
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>]
434
412
  # A list of detected languages together with confidence.
@@ -440,8 +418,7 @@ module Google
440
418
  # A table representation similar to HTML table structure.
441
419
  # @!attribute [rw] layout
442
420
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
443
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for
444
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Table Table}.
421
+ # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Table Table}.
445
422
  # @!attribute [rw] header_rows
446
423
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::Table::TableRow>]
447
424
  # Header rows of the table.
@@ -467,8 +444,7 @@ module Google
467
444
  # A cell representation inside the table.
468
445
  # @!attribute [rw] layout
469
446
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
470
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for
471
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Table::TableCell TableCell}.
447
+ # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Table::TableCell TableCell}.
472
448
  # @!attribute [rw] row_span
473
449
  # @return [::Integer]
474
450
  # How many rows this cell spans.
@@ -487,14 +463,11 @@ module Google
487
463
  # A form field detected on the page.
488
464
  # @!attribute [rw] field_name
489
465
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
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.
466
+ # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for the {::Google::Cloud::DocumentAI::V1beta3::Document::Page::FormField FormField} name. e.g. `Address`, `Email`,
467
+ # `Grand total`, `Phone number`, etc.
493
468
  # @!attribute [rw] field_value
494
469
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
495
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for the
496
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::FormField FormField}
497
- # value.
470
+ # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for the {::Google::Cloud::DocumentAI::V1beta3::Document::Page::FormField FormField} value.
498
471
  # @!attribute [rw] name_detected_languages
499
472
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>]
500
473
  # A list of detected languages for name together with confidence.
@@ -508,6 +481,16 @@ module Google
508
481
  # - blank (this indicates the field_value is normal text)
509
482
  # - "unfilled_checkbox"
510
483
  # - "filled_checkbox"
484
+ # @!attribute [rw] corrected_key_text
485
+ # @return [::String]
486
+ # Created for Labeling UI to export key text.
487
+ # If corrections were made to the text identified by the
488
+ # `field_name.text_anchor`, this field will contain the correction.
489
+ # @!attribute [rw] corrected_value_text
490
+ # @return [::String]
491
+ # Created for Labeling UI to export value text.
492
+ # If corrections were made to the text identified by the
493
+ # `field_value.text_anchor`, this field will contain the correction.
511
494
  # @!attribute [rw] provenance
512
495
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Provenance]
513
496
  # The history of this annotation.
@@ -516,6 +499,18 @@ module Google
516
499
  extend ::Google::Protobuf::MessageExts::ClassMethods
517
500
  end
518
501
 
502
+ # A detected barcode.
503
+ # @!attribute [rw] layout
504
+ # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
505
+ # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedBarcode DetectedBarcode}.
506
+ # @!attribute [rw] barcode
507
+ # @return [::Google::Cloud::DocumentAI::V1beta3::Barcode]
508
+ # Detailed barcode information of the {::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedBarcode DetectedBarcode}.
509
+ class DetectedBarcode
510
+ include ::Google::Protobuf::MessageExts
511
+ extend ::Google::Protobuf::MessageExts::ClassMethods
512
+ end
513
+
519
514
  # Detected language for a structural component.
520
515
  # @!attribute [rw] language_code
521
516
  # @return [::String]
@@ -537,15 +532,14 @@ module Google
537
532
  # @!attribute [rw] text_anchor
538
533
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::TextAnchor]
539
534
  # Optional. Provenance of the entity.
540
- # Text anchor indexing into the
541
- # {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
535
+ # Text anchor indexing into the {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
542
536
  # @!attribute [rw] type
543
537
  # @return [::String]
544
538
  # Required. Entity type from a schema e.g. `Address`.
545
539
  # @!attribute [rw] mention_text
546
540
  # @return [::String]
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.
541
+ # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity
542
+ # is not present in the document, this field will be empty.
549
543
  # @!attribute [rw] mention_id
550
544
  # @return [::String]
551
545
  # Optional. Deprecated. Use `id` field instead.
@@ -554,29 +548,28 @@ module Google
554
548
  # Optional. Confidence of detected Schema entity. Range [0, 1].
555
549
  # @!attribute [rw] page_anchor
556
550
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::PageAnchor]
557
- # Optional. Represents the provenance of this entity wrt. the location on
558
- # the page where it was found.
551
+ # Optional. Represents the provenance of this entity wrt. the location on the
552
+ # page where it was found.
559
553
  # @!attribute [rw] id
560
554
  # @return [::String]
561
555
  # Optional. Canonical id. This will be a unique value in the entity list
562
556
  # for this document.
563
557
  # @!attribute [rw] normalized_value
564
558
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Entity::NormalizedValue]
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
559
+ # Optional. Normalized entity value. Absent if the extracted value could not be
560
+ # converted or the type (e.g. address) is not supported for certain
567
561
  # parsers. This field is also only populated for certain supported document
568
562
  # types.
569
563
  # @!attribute [rw] properties
570
564
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Entity>]
571
- # Optional. Entities can be nested to form a hierarchical data structure
572
- # representing the content in the document.
565
+ # Optional. Entities can be nested to form a hierarchical data structure representing
566
+ # the content in the document.
573
567
  # @!attribute [rw] provenance
574
568
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Provenance]
575
569
  # Optional. The history of this annotation.
576
570
  # @!attribute [rw] redacted
577
571
  # @return [::Boolean]
578
- # Optional. Whether the entity will be redacted for de-identification
579
- # purposes.
572
+ # Optional. Whether the entity will be redacted for de-identification purposes.
580
573
  class Entity
581
574
  include ::Google::Protobuf::MessageExts
582
575
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -602,6 +595,12 @@ module Google
602
595
  # @return [::Boolean]
603
596
  # Boolean value. Can be used for entities with binary values, or for
604
597
  # checkboxes.
598
+ # @!attribute [rw] integer_value
599
+ # @return [::Integer]
600
+ # Integer value.
601
+ # @!attribute [rw] float_value
602
+ # @return [::Float]
603
+ # Float value.
605
604
  # @!attribute [rw] text
606
605
  # @return [::String]
607
606
  # Optional. An optional field to store a normalized string.
@@ -620,8 +619,7 @@ module Google
620
619
  end
621
620
  end
622
621
 
623
- # Relationship between
624
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Entity Entities}.
622
+ # Relationship between {::Google::Cloud::DocumentAI::V1beta3::Document::Entity Entities}.
625
623
  # @!attribute [rw] subject_id
626
624
  # @return [::String]
627
625
  # Subject entity id.
@@ -636,12 +634,10 @@ module Google
636
634
  extend ::Google::Protobuf::MessageExts::ClassMethods
637
635
  end
638
636
 
639
- # Text reference indexing into the
640
- # {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
637
+ # Text reference indexing into the {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
641
638
  # @!attribute [rw] text_segments
642
639
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::TextAnchor::TextSegment>]
643
- # The text segments from the
644
- # {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
640
+ # The text segments from the {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
645
641
  # @!attribute [rw] content
646
642
  # @return [::String]
647
643
  # Contains the content of the text span so that users do
@@ -651,20 +647,15 @@ module Google
651
647
  include ::Google::Protobuf::MessageExts
652
648
  extend ::Google::Protobuf::MessageExts::ClassMethods
653
649
 
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}
650
+ # A text segment in the {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}. The indices may be out of bounds
651
+ # which indicate that the text extends into another document shard for
652
+ # large sharded documents. See {::Google::Cloud::DocumentAI::V1beta3::Document::ShardInfo#text_offset ShardInfo.text_offset}
659
653
  # @!attribute [rw] start_index
660
654
  # @return [::Integer]
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}.
655
+ # {::Google::Cloud::DocumentAI::V1beta3::Document::TextAnchor::TextSegment TextSegment} start UTF-8 char index in the {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
664
656
  # @!attribute [rw] end_index
665
657
  # @return [::Integer]
666
- # {::Google::Cloud::DocumentAI::V1beta3::Document::TextAnchor::TextSegment TextSegment}
667
- # half open end UTF-8 char index in the
658
+ # {::Google::Cloud::DocumentAI::V1beta3::Document::TextAnchor::TextSegment TextSegment} half open end UTF-8 char index in the
668
659
  # {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
669
660
  class TextSegment
670
661
  include ::Google::Protobuf::MessageExts
@@ -672,9 +663,8 @@ module Google
672
663
  end
673
664
  end
674
665
 
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
666
+ # Referencing the visual context of the entity in the {::Google::Cloud::DocumentAI::V1beta3::Document#pages Document.pages}.
667
+ # Page anchors can be cross-page, consist of multiple bounding polygons and
678
668
  # optionally reference specific layout element types.
679
669
  # @!attribute [rw] page_refs
680
670
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::PageAnchor::PageRef>]
@@ -686,29 +676,22 @@ module Google
686
676
  # Represents a weak reference to a page element within a document.
687
677
  # @!attribute [rw] page
688
678
  # @return [::Integer]
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
679
+ # Required. Index into the {::Google::Cloud::DocumentAI::V1beta3::Document#pages Document.pages} element, for example using
680
+ # [Document.pages][page_refs.page] to locate the related page element.
681
+ # This field is skipped when its value is the default 0. See
694
682
  # https://developers.google.com/protocol-buffers/docs/proto3#json.
695
683
  # @!attribute [rw] layout_type
696
684
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::PageAnchor::PageRef::LayoutType]
697
- # Optional. The type of the layout element that is being referenced if
698
- # any.
685
+ # Optional. The type of the layout element that is being referenced if any.
699
686
  # @!attribute [rw] layout_id
700
687
  # @return [::String]
701
- # Optional. Deprecated. Use
702
- # {::Google::Cloud::DocumentAI::V1beta3::Document::PageAnchor::PageRef#bounding_poly PageRef.bounding_poly}
703
- # instead.
688
+ # Optional. Deprecated. Use {::Google::Cloud::DocumentAI::V1beta3::Document::PageAnchor::PageRef#bounding_poly PageRef.bounding_poly} instead.
704
689
  # @!attribute [rw] bounding_poly
705
690
  # @return [::Google::Cloud::DocumentAI::V1beta3::BoundingPoly]
706
- # Optional. Identifies the bounding polygon of a layout element on the
707
- # page.
691
+ # Optional. Identifies the bounding polygon of a layout element on the page.
708
692
  # @!attribute [rw] confidence
709
693
  # @return [::Float]
710
- # Optional. Confidence of detected page element, if applicable. Range [0,
711
- # 1].
694
+ # Optional. Confidence of detected page element, if applicable. Range [0, 1].
712
695
  class PageRef
713
696
  include ::Google::Protobuf::MessageExts
714
697
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -718,39 +701,25 @@ module Google
718
701
  # Layout Unspecified.
719
702
  LAYOUT_TYPE_UNSPECIFIED = 0
720
703
 
721
- # References a
722
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page#blocks Page.blocks}
723
- # element.
704
+ # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#blocks Page.blocks} element.
724
705
  BLOCK = 1
725
706
 
726
- # References a
727
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page#paragraphs Page.paragraphs}
728
- # element.
707
+ # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#paragraphs Page.paragraphs} element.
729
708
  PARAGRAPH = 2
730
709
 
731
- # References a
732
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page#lines Page.lines}
733
- # element.
710
+ # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#lines Page.lines} element.
734
711
  LINE = 3
735
712
 
736
- # References a
737
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page#tokens Page.tokens}
738
- # element.
713
+ # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#tokens Page.tokens} element.
739
714
  TOKEN = 4
740
715
 
741
- # References a
742
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page#visual_elements Page.visual_elements}
743
- # element.
716
+ # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#visual_elements Page.visual_elements} element.
744
717
  VISUAL_ELEMENT = 5
745
718
 
746
- # Refrrences a
747
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page#tables Page.tables}
748
- # element.
719
+ # Refrrences a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#tables Page.tables} element.
749
720
  TABLE = 6
750
721
 
751
- # References a
752
- # {::Google::Cloud::DocumentAI::V1beta3::Document::Page#form_fields Page.form_fields}
753
- # element.
722
+ # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#form_fields Page.form_fields} element.
754
723
  FORM_FIELD = 7
755
724
  end
756
725
  end
@@ -836,6 +805,11 @@ module Google
836
805
  # The revisions that this revision is based on. This can include one or
837
806
  # more parent (when documents are merged.) This field represents the
838
807
  # index into the `revisions` field.
808
+ # @!attribute [rw] parent_ids
809
+ # @return [::Array<::String>]
810
+ # The revisions that this revision is based on. Must include all the ids
811
+ # that have anything to do with this revision - eg. there are
812
+ # `provenance.parent.revision` fields that index into this field.
839
813
  # @!attribute [rw] create_time
840
814
  # @return [::Google::Protobuf::Timestamp]
841
815
  # The time that the revision was created.
@@ -864,11 +838,10 @@ module Google
864
838
  # @!attribute [rw] text_anchor
865
839
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::TextAnchor]
866
840
  # Provenance of the correction.
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.
841
+ # Text anchor indexing into the {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}. There can only be a
842
+ # single `TextAnchor.text_segments` element. If the start and
843
+ # end index of the text segment are the same, the text change is inserted
844
+ # before that index.
872
845
  # @!attribute [rw] changed_text
873
846
  # @return [::String]
874
847
  # The text that replaces the text identified in the `text_anchor`.