google-cloud-document_ai-v1 0.20.0 → 0.21.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 (12) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/document_ai/v1/document_processor_service/client.rb +37 -60
  3. data/lib/google/cloud/document_ai/v1/document_processor_service/rest/client.rb +37 -60
  4. data/lib/google/cloud/document_ai/v1/version.rb +1 -1
  5. data/lib/google/cloud/documentai/v1/document_processor_service_pb.rb +2 -1
  6. data/lib/google/cloud/documentai/v1/document_processor_service_services_pb.rb +5 -9
  7. data/proto_docs/google/api/client.rb +4 -0
  8. data/proto_docs/google/cloud/documentai/v1/document.rb +72 -132
  9. data/proto_docs/google/cloud/documentai/v1/document_io.rb +1 -3
  10. data/proto_docs/google/cloud/documentai/v1/document_processor_service.rb +89 -122
  11. data/proto_docs/google/cloud/documentai/v1/processor.rb +1 -2
  12. metadata +2 -2
data/proto_docs/google/api/client.rb CHANGED
@@ -118,6 +118,10 @@ module Google
118
118
  # @return [::String]
119
119
  # Optional link to proto reference documentation. Example:
120
120
  # https://cloud.google.com/pubsub/lite/docs/reference/rpc
121
+ # @!attribute [rw] rest_reference_documentation_uri
122
+ # @return [::String]
123
+ # Optional link to REST reference documentation. Example:
124
+ # https://cloud.google.com/pubsub/lite/docs/reference/rest
121
125
  class Publishing
122
126
  include ::Google::Protobuf::MessageExts
123
127
  extend ::Google::Protobuf::MessageExts::ClassMethods
data/proto_docs/google/cloud/documentai/v1/document.rb CHANGED
@@ -52,19 +52,16 @@ module Google
52
52
  # Visual page layout for the {::Google::Cloud::DocumentAI::V1::Document Document}.
53
53
  # @!attribute [rw] entities
54
54
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Entity>]
55
- # A list of entities detected on
56
- # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. For document
57
- # shards, entities in this list may cross shard boundaries.
55
+ # A list of entities detected on {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. For document shards,
56
+ # entities in this list may cross shard boundaries.
58
57
  # @!attribute [rw] entity_relations
59
58
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::EntityRelation>]
60
- # Placeholder. Relationship among
61
- # {::Google::Cloud::DocumentAI::V1::Document#entities Document.entities}.
59
+ # Placeholder. Relationship among {::Google::Cloud::DocumentAI::V1::Document#entities Document.entities}.
62
60
  # @!attribute [rw] text_changes
63
61
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::TextChange>]
64
- # Placeholder. A list of text corrections made to
65
- # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. This is usually
66
- # used for annotating corrections to OCR mistakes. Text changes for a given
67
- # revision may not overlap with each other.
62
+ # Placeholder. A list of text corrections made to {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. This
63
+ # is usually used for annotating corrections to OCR mistakes. Text changes
64
+ # for a given revision may not overlap with each other.
68
65
  # @!attribute [rw] shard_info
69
66
  # @return [::Google::Cloud::DocumentAI::V1::Document::ShardInfo]
70
67
  # Information about the sharding if this document is sharded part of a larger
@@ -90,8 +87,7 @@ module Google
90
87
  # Total number of shards.
91
88
  # @!attribute [rw] text_offset
92
89
  # @return [::Integer]
93
- # The index of the first character in
94
- # {::Google::Cloud::DocumentAI::V1::Document#text Document.text} in the overall
90
+ # The index of the first character in {::Google::Cloud::DocumentAI::V1::Document#text Document.text} in the overall
95
91
  # document global text.
96
92
  class ShardInfo
97
93
  include ::Google::Protobuf::MessageExts
@@ -102,8 +98,7 @@ module Google
102
98
  # conventions as much as possible.
103
99
  # @!attribute [rw] text_anchor
104
100
  # @return [::Google::Cloud::DocumentAI::V1::Document::TextAnchor]
105
- # Text anchor indexing into the
106
- # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
101
+ # Text anchor indexing into the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
107
102
  # @!attribute [rw] color
108
103
  # @return [::Google::Type::Color]
109
104
  # Text color.
@@ -152,11 +147,9 @@ module Google
152
147
  # A page in a {::Google::Cloud::DocumentAI::V1::Document Document}.
153
148
  # @!attribute [rw] page_number
154
149
  # @return [::Integer]
155
- # 1-based index for current
156
- # {::Google::Cloud::DocumentAI::V1::Document::Page Page} in a parent
157
- # {::Google::Cloud::DocumentAI::V1::Document Document}. Useful when a page is
158
- # taken out of a {::Google::Cloud::DocumentAI::V1::Document Document} for
159
- # individual processing.
150
+ # 1-based index for current {::Google::Cloud::DocumentAI::V1::Document::Page Page} in a parent {::Google::Cloud::DocumentAI::V1::Document Document}.
151
+ # Useful when a page is taken out of a {::Google::Cloud::DocumentAI::V1::Document Document} for individual
152
+ # processing.
160
153
  # @!attribute [rw] image
161
154
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Image]
162
155
  # Rendered image for this page. This image is preprocessed to remove any
@@ -278,23 +271,18 @@ module Google
278
271
  # Visual element describing a layout unit on a page.
279
272
  # @!attribute [rw] text_anchor
280
273
  # @return [::Google::Cloud::DocumentAI::V1::Document::TextAnchor]
281
- # Text anchor indexing into the
282
- # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
274
+ # Text anchor indexing into the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
283
275
  # @!attribute [rw] confidence
284
276
  # @return [::Float]
285
- # Confidence of the current
286
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} within
287
- # context of the object this layout is for. e.g. confidence can be for a
288
- # single token, a table, a visual element, etc. depending on context.
289
- # Range `[0, 1]`.
277
+ # Confidence of the current {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} within context of the object this
278
+ # layout is for. e.g. confidence can be for a single token, a table,
279
+ # a visual element, etc. depending on context. Range `[0, 1]`.
290
280
  # @!attribute [rw] bounding_poly
291
281
  # @return [::Google::Cloud::DocumentAI::V1::BoundingPoly]
292
- # The bounding polygon for the
293
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout}.
282
+ # The bounding polygon for the {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout}.
294
283
  # @!attribute [rw] orientation
295
284
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout::Orientation]
296
- # Detected orientation for the
297
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout}.
285
+ # Detected orientation for the {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout}.
298
286
  class Layout
299
287
  include ::Google::Protobuf::MessageExts
300
288
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -325,8 +313,7 @@ module Google
325
313
  # common line-spacing and orientation.
326
314
  # @!attribute [rw] layout
327
315
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
328
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
329
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Block Block}.
316
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Block Block}.
330
317
  # @!attribute [rw] detected_languages
331
318
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
332
319
  # A list of detected languages together with confidence.
@@ -342,8 +329,7 @@ module Google
342
329
  # A collection of lines that a human would perceive as a paragraph.
343
330
  # @!attribute [rw] layout
344
331
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
345
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
346
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Paragraph Paragraph}.
332
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Paragraph Paragraph}.
347
333
  # @!attribute [rw] detected_languages
348
334
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
349
335
  # A list of detected languages together with confidence.
@@ -360,8 +346,7 @@ module Google
360
346
  # Does not cross column boundaries, can be horizontal, vertical, etc.
361
347
  # @!attribute [rw] layout
362
348
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
363
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
364
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Line Line}.
349
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Line Line}.
365
350
  # @!attribute [rw] detected_languages
366
351
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
367
352
  # A list of detected languages together with confidence.
@@ -377,12 +362,10 @@ module Google
377
362
  # A detected token.
378
363
  # @!attribute [rw] layout
379
364
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
380
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
381
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}.
365
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}.
382
366
  # @!attribute [rw] detected_break
383
367
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Token::DetectedBreak]
384
- # Detected break at the end of a
385
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}.
368
+ # Detected break at the end of a {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}.
386
369
  # @!attribute [rw] detected_languages
387
370
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
388
371
  # A list of detected languages together with confidence.
@@ -397,8 +380,7 @@ module Google
397
380
  include ::Google::Protobuf::MessageExts
398
381
  extend ::Google::Protobuf::MessageExts::ClassMethods
399
382
 
400
- # Detected break at the end of a
401
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}.
383
+ # Detected break at the end of a {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}.
402
384
  # @!attribute [rw] type
403
385
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Token::DetectedBreak::Type]
404
386
  # Detected break type.
@@ -428,9 +410,8 @@ module Google
428
410
  # Font size in points (`1` point is `¹⁄₇₂` inches).
429
411
  # @!attribute [rw] pixel_font_size
430
412
  # @return [::Float]
431
- # Font size in pixels, equal to _unrounded
432
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Token::StyleInfo#font_size font_size}_
433
- # * _resolution_ ÷ `72.0`.
413
+ # Font size in pixels, equal to _unrounded {::Google::Cloud::DocumentAI::V1::Document::Page::Token::StyleInfo#font_size font_size}_ *
414
+ # _resolution_ ÷ `72.0`.
434
415
  # @!attribute [rw] letter_spacing
435
416
  # @return [::Float]
436
417
  # Letter spacing in points.
@@ -439,9 +420,8 @@ module Google
439
420
  # Name or style of the font.
440
421
  # @!attribute [rw] bold
441
422
  # @return [::Boolean]
442
- # Whether the text is bold (equivalent to
443
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Token::StyleInfo#font_weight font_weight}
444
- # is at least `700`).
423
+ # Whether the text is bold (equivalent to {::Google::Cloud::DocumentAI::V1::Document::Page::Token::StyleInfo#font_weight font_weight} is at least
424
+ # `700`).
445
425
  # @!attribute [rw] italic
446
426
  # @return [::Boolean]
447
427
  # Whether the text is italic.
@@ -482,8 +462,7 @@ module Google
482
462
  # A detected symbol.
483
463
  # @!attribute [rw] layout
484
464
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
485
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
486
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Symbol Symbol}.
465
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Symbol Symbol}.
487
466
  # @!attribute [rw] detected_languages
488
467
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
489
468
  # A list of detected languages together with confidence.
@@ -496,12 +475,10 @@ module Google
496
475
  # page.
497
476
  # @!attribute [rw] layout
498
477
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
499
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
500
- # {::Google::Cloud::DocumentAI::V1::Document::Page::VisualElement VisualElement}.
478
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::VisualElement VisualElement}.
501
479
  # @!attribute [rw] type
502
480
  # @return [::String]
503
- # Type of the
504
- # {::Google::Cloud::DocumentAI::V1::Document::Page::VisualElement VisualElement}.
481
+ # Type of the {::Google::Cloud::DocumentAI::V1::Document::Page::VisualElement VisualElement}.
505
482
  # @!attribute [rw] detected_languages
506
483
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
507
484
  # A list of detected languages together with confidence.
@@ -513,8 +490,7 @@ module Google
513
490
  # A table representation similar to HTML table structure.
514
491
  # @!attribute [rw] layout
515
492
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
516
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
517
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Table Table}.
493
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Table Table}.
518
494
  # @!attribute [rw] header_rows
519
495
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Table::TableRow>]
520
496
  # Header rows of the table.
@@ -544,8 +520,7 @@ module Google
544
520
  # A cell representation inside the table.
545
521
  # @!attribute [rw] layout
546
522
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
547
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
548
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Table::TableCell TableCell}.
523
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Table::TableCell TableCell}.
549
524
  # @!attribute [rw] row_span
550
525
  # @return [::Integer]
551
526
  # How many rows this cell spans.
@@ -564,13 +539,11 @@ module Google
564
539
  # A form field detected on the page.
565
540
  # @!attribute [rw] field_name
566
541
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
567
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for the
568
- # {::Google::Cloud::DocumentAI::V1::Document::Page::FormField FormField} name.
569
- # e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
542
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for the {::Google::Cloud::DocumentAI::V1::Document::Page::FormField FormField} name. e.g. `Address`, `Email`,
543
+ # `Grand total`, `Phone number`, etc.
570
544
  # @!attribute [rw] field_value
571
545
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
572
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for the
573
- # {::Google::Cloud::DocumentAI::V1::Document::Page::FormField FormField} value.
546
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for the {::Google::Cloud::DocumentAI::V1::Document::Page::FormField FormField} value.
574
547
  # @!attribute [rw] name_detected_languages
575
548
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
576
549
  # A list of detected languages for name together with confidence.
@@ -606,12 +579,10 @@ module Google
606
579
  # A detected barcode.
607
580
  # @!attribute [rw] layout
608
581
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
609
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
610
- # {::Google::Cloud::DocumentAI::V1::Document::Page::DetectedBarcode DetectedBarcode}.
582
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::DetectedBarcode DetectedBarcode}.
611
583
  # @!attribute [rw] barcode
612
584
  # @return [::Google::Cloud::DocumentAI::V1::Barcode]
613
- # Detailed barcode information of the
614
- # {::Google::Cloud::DocumentAI::V1::Document::Page::DetectedBarcode DetectedBarcode}.
585
+ # Detailed barcode information of the {::Google::Cloud::DocumentAI::V1::Document::Page::DetectedBarcode DetectedBarcode}.
615
586
  class DetectedBarcode
616
587
  include ::Google::Protobuf::MessageExts
617
588
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -672,8 +643,7 @@ module Google
672
643
  # @!attribute [rw] text_anchor
673
644
  # @return [::Google::Cloud::DocumentAI::V1::Document::TextAnchor]
674
645
  # Optional. Provenance of the entity.
675
- # Text anchor indexing into the
676
- # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
646
+ # Text anchor indexing into the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
677
647
  # @!attribute [rw] type
678
648
  # @return [::String]
679
649
  # Required. Entity type from a schema e.g. `Address`.
@@ -688,29 +658,28 @@ module Google
688
658
  # Optional. Confidence of detected Schema entity. Range `[0, 1]`.
689
659
  # @!attribute [rw] page_anchor
690
660
  # @return [::Google::Cloud::DocumentAI::V1::Document::PageAnchor]
691
- # Optional. Represents the provenance of this entity wrt. the location on
692
- # the page where it was found.
661
+ # Optional. Represents the provenance of this entity wrt. the location on the
662
+ # page where it was found.
693
663
  # @!attribute [rw] id
694
664
  # @return [::String]
695
665
  # Optional. Canonical id. This will be a unique value in the entity list
696
666
  # for this document.
697
667
  # @!attribute [rw] normalized_value
698
668
  # @return [::Google::Cloud::DocumentAI::V1::Document::Entity::NormalizedValue]
699
- # Optional. Normalized entity value. Absent if the extracted value could
700
- # not be converted or the type (e.g. address) is not supported for certain
669
+ # Optional. Normalized entity value. Absent if the extracted value could not be
670
+ # converted or the type (e.g. address) is not supported for certain
701
671
  # parsers. This field is also only populated for certain supported document
702
672
  # types.
703
673
  # @!attribute [rw] properties
704
674
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Entity>]
705
- # Optional. Entities can be nested to form a hierarchical data structure
706
- # representing the content in the document.
675
+ # Optional. Entities can be nested to form a hierarchical data structure representing
676
+ # the content in the document.
707
677
  # @!attribute [rw] provenance
708
678
  # @return [::Google::Cloud::DocumentAI::V1::Document::Provenance]
709
679
  # Optional. The history of this annotation.
710
680
  # @!attribute [rw] redacted
711
681
  # @return [::Boolean]
712
- # Optional. Whether the entity will be redacted for de-identification
713
- # purposes.
682
+ # Optional. Whether the entity will be redacted for de-identification purposes.
714
683
  class Entity
715
684
  include ::Google::Protobuf::MessageExts
716
685
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -761,8 +730,7 @@ module Google
761
730
  end
762
731
  end
763
732
 
764
- # Relationship between
765
- # {::Google::Cloud::DocumentAI::V1::Document::Entity Entities}.
733
+ # Relationship between {::Google::Cloud::DocumentAI::V1::Document::Entity Entities}.
766
734
  # @!attribute [rw] subject_id
767
735
  # @return [::String]
768
736
  # Subject entity id.
@@ -777,12 +745,10 @@ module Google
777
745
  extend ::Google::Protobuf::MessageExts::ClassMethods
778
746
  end
779
747
 
780
- # Text reference indexing into the
781
- # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
748
+ # Text reference indexing into the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
782
749
  # @!attribute [rw] text_segments
783
750
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::TextAnchor::TextSegment>]
784
- # The text segments from the
785
- # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
751
+ # The text segments from the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
786
752
  # @!attribute [rw] content
787
753
  # @return [::String]
788
754
  # Contains the content of the text span so that users do
@@ -792,20 +758,15 @@ module Google
792
758
  include ::Google::Protobuf::MessageExts
793
759
  extend ::Google::Protobuf::MessageExts::ClassMethods
794
760
 
795
- # A text segment in the
796
- # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. The indices
797
- # may be out of bounds which indicate that the text extends into another
798
- # document shard for large sharded documents. See
799
- # {::Google::Cloud::DocumentAI::V1::Document::ShardInfo#text_offset ShardInfo.text_offset}
761
+ # A text segment in the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. The indices may be out of bounds
762
+ # which indicate that the text extends into another document shard for
763
+ # large sharded documents. See {::Google::Cloud::DocumentAI::V1::Document::ShardInfo#text_offset ShardInfo.text_offset}
800
764
  # @!attribute [rw] start_index
801
765
  # @return [::Integer]
802
- # {::Google::Cloud::DocumentAI::V1::Document::TextAnchor::TextSegment TextSegment}
803
- # start UTF-8 char index in the
804
- # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
766
+ # {::Google::Cloud::DocumentAI::V1::Document::TextAnchor::TextSegment TextSegment} start UTF-8 char index in the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
805
767
  # @!attribute [rw] end_index
806
768
  # @return [::Integer]
807
- # {::Google::Cloud::DocumentAI::V1::Document::TextAnchor::TextSegment TextSegment}
808
- # half open end UTF-8 char index in the
769
+ # {::Google::Cloud::DocumentAI::V1::Document::TextAnchor::TextSegment TextSegment} half open end UTF-8 char index in the
809
770
  # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
810
771
  class TextSegment
811
772
  include ::Google::Protobuf::MessageExts
@@ -813,10 +774,9 @@ module Google
813
774
  end
814
775
  end
815
776
 
816
- # Referencing the visual context of the entity in the
817
- # {::Google::Cloud::DocumentAI::V1::Document#pages Document.pages}. Page anchors
818
- # can be cross-page, consist of multiple bounding polygons and optionally
819
- # reference specific layout element types.
777
+ # Referencing the visual context of the entity in the {::Google::Cloud::DocumentAI::V1::Document#pages Document.pages}.
778
+ # Page anchors can be cross-page, consist of multiple bounding polygons and
779
+ # optionally reference specific layout element types.
820
780
  # @!attribute [rw] page_refs
821
781
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef>]
822
782
  # One or more references to visual page elements
@@ -827,31 +787,25 @@ module Google
827
787
  # Represents a weak reference to a page element within a document.
828
788
  # @!attribute [rw] page
829
789
  # @return [::Integer]
830
- # Required. Index into the
831
- # {::Google::Cloud::DocumentAI::V1::Document#pages Document.pages} element,
832
- # for example using
790
+ # Required. Index into the {::Google::Cloud::DocumentAI::V1::Document#pages Document.pages} element, for example using
833
791
  # `[Document.pages][page_refs.page]` to locate the related page element.
834
792
  # This field is skipped when its value is the default `0`. See
835
793
  # https://developers.google.com/protocol-buffers/docs/proto3#json.
836
794
  # @!attribute [rw] layout_type
837
795
  # @return [::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef::LayoutType]
838
- # Optional. The type of the layout element that is being referenced if
839
- # any.
796
+ # Optional. The type of the layout element that is being referenced if any.
840
797
  # @!attribute [rw] layout_id
841
798
  # @deprecated This field is deprecated and may be removed in the next major version update.
842
799
  # @return [::String]
843
- # Optional. Deprecated. Use
844
- # {::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef#bounding_poly PageRef.bounding_poly}
845
- # instead.
800
+ # Optional. Deprecated. Use {::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef#bounding_poly PageRef.bounding_poly} instead.
846
801
  # @!attribute [rw] bounding_poly
847
802
  # @return [::Google::Cloud::DocumentAI::V1::BoundingPoly]
848
- # Optional. Identifies the bounding polygon of a layout element on the
849
- # page. If `layout_type` is set, the bounding polygon must be exactly the
850
- # same to the layout element it's referring to.
803
+ # Optional. Identifies the bounding polygon of a layout element on the page.
804
+ # If `layout_type` is set, the bounding polygon must be exactly the same
805
+ # to the layout element it's referring to.
851
806
  # @!attribute [rw] confidence
852
807
  # @return [::Float]
853
- # Optional. Confidence of detected page element, if applicable. Range
854
- # `[0, 1]`.
808
+ # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
855
809
  class PageRef
856
810
  include ::Google::Protobuf::MessageExts
857
811
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -861,38 +815,25 @@ module Google
861
815
  # Layout Unspecified.
862
816
  LAYOUT_TYPE_UNSPECIFIED = 0
863
817
 
864
- # References a
865
- # {::Google::Cloud::DocumentAI::V1::Document::Page#blocks Page.blocks}
866
- # element.
818
+ # References a {::Google::Cloud::DocumentAI::V1::Document::Page#blocks Page.blocks} element.
867
819
  BLOCK = 1
868
820
 
869
- # References a
870
- # {::Google::Cloud::DocumentAI::V1::Document::Page#paragraphs Page.paragraphs}
871
- # element.
821
+ # References a {::Google::Cloud::DocumentAI::V1::Document::Page#paragraphs Page.paragraphs} element.
872
822
  PARAGRAPH = 2
873
823
 
874
- # References a
875
- # {::Google::Cloud::DocumentAI::V1::Document::Page#lines Page.lines} element.
824
+ # References a {::Google::Cloud::DocumentAI::V1::Document::Page#lines Page.lines} element.
876
825
  LINE = 3
877
826
 
878
- # References a
879
- # {::Google::Cloud::DocumentAI::V1::Document::Page#tokens Page.tokens}
880
- # element.
827
+ # References a {::Google::Cloud::DocumentAI::V1::Document::Page#tokens Page.tokens} element.
881
828
  TOKEN = 4
882
829
 
883
- # References a
884
- # {::Google::Cloud::DocumentAI::V1::Document::Page#visual_elements Page.visual_elements}
885
- # element.
830
+ # References a {::Google::Cloud::DocumentAI::V1::Document::Page#visual_elements Page.visual_elements} element.
886
831
  VISUAL_ELEMENT = 5
887
832
 
888
- # Refrrences a
889
- # {::Google::Cloud::DocumentAI::V1::Document::Page#tables Page.tables}
890
- # element.
833
+ # Refrrences a {::Google::Cloud::DocumentAI::V1::Document::Page#tables Page.tables} element.
891
834
  TABLE = 6
892
835
 
893
- # References a
894
- # {::Google::Cloud::DocumentAI::V1::Document::Page#form_fields Page.form_fields}
895
- # element.
836
+ # References a {::Google::Cloud::DocumentAI::V1::Document::Page#form_fields Page.form_fields} element.
896
837
  FORM_FIELD = 7
897
838
  end
898
839
  end
@@ -1024,9 +965,8 @@ module Google
1024
965
  # @!attribute [rw] text_anchor
1025
966
  # @return [::Google::Cloud::DocumentAI::V1::Document::TextAnchor]
1026
967
  # Provenance of the correction.
1027
- # Text anchor indexing into the
1028
- # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. There can
1029
- # only be a single `TextAnchor.text_segments` element. If the start and
968
+ # Text anchor indexing into the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. There can only be a
969
+ # single `TextAnchor.text_segments` element. If the start and
1030
970
  # end index of the text segment are the same, the text change is inserted
1031
971
  # before that index.
1032
972
  # @!attribute [rw] changed_text
data/proto_docs/google/cloud/documentai/v1/document_io.rb CHANGED
@@ -151,9 +151,7 @@ module Google
151
151
  # @deprecated This field is deprecated and may be removed in the next major version update.
152
152
  # @return [::Boolean]
153
153
  # Turn on font identification model and return font style information.
154
- # Deprecated, use
155
- # {::Google::Cloud::DocumentAI::V1::OcrConfig::PremiumFeatures#compute_style_info PremiumFeatures.compute_style_info}
156
- # instead.
154
+ # Deprecated, use {::Google::Cloud::DocumentAI::V1::OcrConfig::PremiumFeatures#compute_style_info PremiumFeatures.compute_style_info} instead.
157
155
  # @!attribute [rw] disable_character_boxes_detection
158
156
  # @return [::Boolean]
159
157
  # Turn off character box detector in OCR engine. Character box detection is