google-cloud-document_ai-v1 0.2.1 → 0.3.0

data/proto_docs/google/cloud/documentai/v1/document.rb

@@ -54,11 +54,13 @@ module Google
         #     Visual page layout for the {::Google::Cloud::DocumentAI::V1::Document Document}.
         # @!attribute [rw] entities
         #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Entity>]
-        #     A list of entities detected on {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. For document shards,
-        #     entities in this list may cross shard boundaries.
+        #     A list of entities detected on
+        #     {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. For document
+        #     shards, entities in this list may cross shard boundaries.
         # @!attribute [rw] entity_relations
         #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::EntityRelation>]
-        #     Relationship among {::Google::Cloud::DocumentAI::V1::Document#entities Document.entities}.
+        #     Relationship among
+        #     {::Google::Cloud::DocumentAI::V1::Document#entities Document.entities}.
         # @!attribute [rw] text_changes
         #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::TextChange>]
         #     A list of text corrections made to [Document.text].  This is usually
@@ -89,7 +91,8 @@ module Google
           #     Total number of shards.
           # @!attribute [rw] text_offset
           #   @return [::Integer]
-          #     The index of the first character in {::Google::Cloud::DocumentAI::V1::Document#text Document.text} in the overall
+          #     The index of the first character in
+          #     {::Google::Cloud::DocumentAI::V1::Document#text Document.text} in the overall
           #     document global text.
           class ShardInfo
             include ::Google::Protobuf::MessageExts
@@ -100,7 +103,8 @@ module Google
           # conventions as much as possible.
           # @!attribute [rw] text_anchor
           #   @return [::Google::Cloud::DocumentAI::V1::Document::TextAnchor]
-          #     Text anchor indexing into the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
+          #     Text anchor indexing into the
+          #     {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
           # @!attribute [rw] color
           #   @return [::Google::Type::Color]
           #     Text color.
@@ -143,9 +147,11 @@ module Google
           # A page in a {::Google::Cloud::DocumentAI::V1::Document Document}.
           # @!attribute [rw] page_number
           #   @return [::Integer]
-          #     1-based index for current {::Google::Cloud::DocumentAI::V1::Document::Page Page} in a parent {::Google::Cloud::DocumentAI::V1::Document Document}.
-          #     Useful when a page is taken out of a {::Google::Cloud::DocumentAI::V1::Document Document} for individual
-          #     processing.
+          #     1-based index for current
+          #     {::Google::Cloud::DocumentAI::V1::Document::Page Page} in a parent
+          #     {::Google::Cloud::DocumentAI::V1::Document Document}. Useful when a page is
+          #     taken out of a {::Google::Cloud::DocumentAI::V1::Document Document} for
+          #     individual processing.
           # @!attribute [rw] image
           #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Image]
           #     Rendered image for this page. This image is preprocessed to remove any
@@ -190,6 +196,9 @@ module Google
           # @!attribute [rw] form_fields
           #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::FormField>]
           #     A list of visually detected form fields on the page.
+          # @!attribute [rw] symbols
+          #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Symbol>]
+          #     A list of visually detected symbols on the page.
           # @!attribute [rw] provenance
           #   @return [::Google::Cloud::DocumentAI::V1::Document::Provenance]
           #     The history of this page.
@@ -255,18 +264,23 @@ module Google
             # Visual element describing a layout unit on a page.
             # @!attribute [rw] text_anchor
             #   @return [::Google::Cloud::DocumentAI::V1::Document::TextAnchor]
-            #     Text anchor indexing into the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
+            #     Text anchor indexing into the
+            #     {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
             # @!attribute [rw] confidence
             #   @return [::Float]
-            #     Confidence of the current {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} within context of the object this
-            #     layout is for. e.g. confidence can be for a single token, a table,
-            #     a visual element, etc. depending on context. Range [0, 1].
+            #     Confidence of the current
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} within
+            #     context of the object this layout is for. e.g. confidence can be for a
+            #     single token, a table, a visual element, etc. depending on context.
+            #     Range [0, 1].
             # @!attribute [rw] bounding_poly
             #   @return [::Google::Cloud::DocumentAI::V1::BoundingPoly]
-            #     The bounding polygon for the {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout}.
+            #     The bounding polygon for the
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout}.
             # @!attribute [rw] orientation
             #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout::Orientation]
-            #     Detected orientation for the {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout}.
+            #     Detected orientation for the
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout}.
             class Layout
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -297,7 +311,8 @@ module Google
             # common line-spacing and orientation.
             # @!attribute [rw] layout
             #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
-            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Block Block}.
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Block Block}.
             # @!attribute [rw] detected_languages
             #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
             #     A list of detected languages together with confidence.
@@ -312,7 +327,8 @@ module Google
             # A collection of lines that a human would perceive as a paragraph.
             # @!attribute [rw] layout
             #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
-            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Paragraph Paragraph}.
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Paragraph Paragraph}.
             # @!attribute [rw] detected_languages
             #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
             #     A list of detected languages together with confidence.
@@ -328,7 +344,8 @@ module Google
             # Does not cross column boundaries, can be horizontal, vertical, etc.
             # @!attribute [rw] layout
             #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
-            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Line Line}.
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Line Line}.
             # @!attribute [rw] detected_languages
             #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
             #     A list of detected languages together with confidence.
@@ -343,10 +360,12 @@ module Google
             # A detected token.
             # @!attribute [rw] layout
             #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
-            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}.
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}.
             # @!attribute [rw] detected_break
             #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Token::DetectedBreak]
-            #     Detected break at the end of a {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}.
+            #     Detected break at the end of a
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}.
             # @!attribute [rw] detected_languages
             #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
             #     A list of detected languages together with confidence.
@@ -357,7 +376,8 @@ module Google
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
 
-              # Detected break at the end of a {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}.
+              # Detected break at the end of a
+              # {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}.
               # @!attribute [rw] type
               #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Token::DetectedBreak::Type]
               #     Detected break type.
@@ -382,14 +402,29 @@ module Google
               end
             end
 
+            # A detected symbol.
+            # @!attribute [rw] layout
+            #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Symbol Symbol}.
+            # @!attribute [rw] detected_languages
+            #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
+            #     A list of detected languages together with confidence.
+            class Symbol
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
             # Detected non-text visual elements e.g. checkbox, signature etc. on the
             # page.
             # @!attribute [rw] layout
             #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
-            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::VisualElement VisualElement}.
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::VisualElement VisualElement}.
             # @!attribute [rw] type
             #   @return [::String]
-            #     Type of the {::Google::Cloud::DocumentAI::V1::Document::Page::VisualElement VisualElement}.
+            #     Type of the
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::VisualElement VisualElement}.
             # @!attribute [rw] detected_languages
             #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
             #     A list of detected languages together with confidence.
@@ -401,7 +436,8 @@ module Google
             # A table representation similar to HTML table structure.
             # @!attribute [rw] layout
             #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
-            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Table Table}.
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Table Table}.
             # @!attribute [rw] header_rows
             #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Table::TableRow>]
             #     Header rows of the table.
@@ -427,7 +463,8 @@ module Google
               # A cell representation inside the table.
               # @!attribute [rw] layout
               #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
-              #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Table::TableCell TableCell}.
+              #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
+              #     {::Google::Cloud::DocumentAI::V1::Document::Page::Table::TableCell TableCell}.
               # @!attribute [rw] row_span
               #   @return [::Integer]
               #     How many rows this cell spans.
@@ -446,11 +483,13 @@ module Google
             # A form field detected on the page.
             # @!attribute [rw] field_name
             #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
-            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for the {::Google::Cloud::DocumentAI::V1::Document::Page::FormField FormField} name. e.g. `Address`, `Email`,
-            #     `Grand total`, `Phone number`, etc.
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for the
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::FormField FormField} name.
+            #     e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
             # @!attribute [rw] field_value
             #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
-            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for the {::Google::Cloud::DocumentAI::V1::Document::Page::FormField FormField} value.
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for the
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::FormField FormField} value.
             # @!attribute [rw] name_detected_languages
             #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
             #     A list of detected languages for name together with confidence.
@@ -477,7 +516,7 @@ module Google
             #   @return [::String]
             #     The BCP-47 language code, such as "en-US" or "sr-Latn". For more
             #     information, see
-            #     http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
+            #     https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
             # @!attribute [rw] confidence
             #   @return [::Float]
             #     Confidence of detected language. Range [0, 1].
@@ -487,18 +526,21 @@ module Google
             end
           end
 
-          # A phrase in the text that is a known entity type, such as a person, an
-          # organization, or location.
+          # An entity that could be a phrase in the text or a property that belongs to
+          # the document. It is a known entity type, such as a person, an organization,
+          # or location.
           # @!attribute [rw] text_anchor
           #   @return [::Google::Cloud::DocumentAI::V1::Document::TextAnchor]
           #     Optional. Provenance of the entity.
-          #     Text anchor indexing into the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
+          #     Text anchor indexing into the
+          #     {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
           # @!attribute [rw] type
           #   @return [::String]
           #     Entity type from a schema e.g. `Address`.
           # @!attribute [rw] mention_text
           #   @return [::String]
-          #     Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`.
+          #     Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If
+          #     the entity is not present in the document, this field will be empty.
           # @!attribute [rw] mention_id
           #   @return [::String]
           #     Optional. Deprecated.  Use `id` field instead.
@@ -507,28 +549,29 @@ module Google
           #     Optional. Confidence of detected Schema entity. Range [0, 1].
           # @!attribute [rw] page_anchor
           #   @return [::Google::Cloud::DocumentAI::V1::Document::PageAnchor]
-          #     Optional. Represents the provenance of this entity wrt. the location on the
-          #     page where it was found.
+          #     Optional. Represents the provenance of this entity wrt. the location on
+          #     the page where it was found.
           # @!attribute [rw] id
           #   @return [::String]
           #     Optional. Canonical id. This will be a unique value in the entity list
           #     for this document.
           # @!attribute [rw] normalized_value
           #   @return [::Google::Cloud::DocumentAI::V1::Document::Entity::NormalizedValue]
-          #     Optional. Normalized entity value. Absent if the extracted value could not be
-          #     converted or the type (e.g. address) is not supported for certain
+          #     Optional. Normalized entity value. Absent if the extracted value could
+          #     not be converted or the type (e.g. address) is not supported for certain
           #     parsers. This field is also only populated for certain supported document
           #     types.
           # @!attribute [rw] properties
           #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Entity>]
-          #     Optional. Entities can be nested to form a hierarchical data structure representing
-          #     the content in the document.
+          #     Optional. Entities can be nested to form a hierarchical data structure
+          #     representing the content in the document.
           # @!attribute [rw] provenance
           #   @return [::Google::Cloud::DocumentAI::V1::Document::Provenance]
           #     Optional. The history of this annotation.
           # @!attribute [rw] redacted
           #   @return [::Boolean]
-          #     Optional. Whether the entity will be redacted for de-identification purposes.
+          #     Optional. Whether the entity will be redacted for de-identification
+          #     purposes.
           class Entity
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -556,10 +599,13 @@ module Google
             #     checkboxes.
             # @!attribute [rw] text
             #   @return [::String]
-            #     Required. Normalized entity value stored as a string. This field is populated for
-            #     supported document type (e.g. Invoice). For some entity types, one of
-            #     respective 'structured_value' fields may also be populated.
+            #     Optional. An optional field to store a normalized string.
+            #     For some entity types, one of respective `structured_value` fields may
+            #     also be populated. Also not all the types of `structured_value` will be
+            #     normalized. For example, some processors may not generate float
+            #     or int normalized text by default.
             #
+            #     Below are sample formats mapped to structured values.
             #     - Money/Currency type (`money_value`) is in the ISO 4217 text format.
             #     - Date type (`date_value`) is in the ISO 8601 text format.
             #     - Datetime type (`datetime_value`) is in the ISO 8601 text format.
@@ -569,7 +615,8 @@ module Google
             end
           end
 
-          # Relationship between {::Google::Cloud::DocumentAI::V1::Document::Entity Entities}.
+          # Relationship between
+          # {::Google::Cloud::DocumentAI::V1::Document::Entity Entities}.
           # @!attribute [rw] subject_id
           #   @return [::String]
           #     Subject entity id.
@@ -584,27 +631,35 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
-          # Text reference indexing into the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
+          # Text reference indexing into the
+          # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
           # @!attribute [rw] text_segments
           #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::TextAnchor::TextSegment>]
-          #     The text segments from the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
+          #     The text segments from the
+          #     {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
           # @!attribute [rw] content
           #   @return [::String]
           #     Contains the content of the text span so that users do
-          #     not have to look it up in the text_segments.
+          #     not have to look it up in the text_segments.  It is always
+          #     populated for formFields.
           class TextAnchor
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
 
-            # A text segment in the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. The indices may be out of bounds
-            # which indicate that the text extends into another document shard for
-            # large sharded documents. See {::Google::Cloud::DocumentAI::V1::Document::ShardInfo#text_offset ShardInfo.text_offset}
+            # A text segment in the
+            # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. The indices
+            # may be out of bounds which indicate that the text extends into another
+            # document shard for large sharded documents. See
+            # {::Google::Cloud::DocumentAI::V1::Document::ShardInfo#text_offset ShardInfo.text_offset}
             # @!attribute [rw] start_index
             #   @return [::Integer]
-            #     {::Google::Cloud::DocumentAI::V1::Document::TextAnchor::TextSegment TextSegment} start UTF-8 char index in the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
+            #     {::Google::Cloud::DocumentAI::V1::Document::TextAnchor::TextSegment TextSegment}
+            #     start UTF-8 char index in the
+            #     {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
             # @!attribute [rw] end_index
             #   @return [::Integer]
-            #     {::Google::Cloud::DocumentAI::V1::Document::TextAnchor::TextSegment TextSegment} half open end UTF-8 char index in the
+            #     {::Google::Cloud::DocumentAI::V1::Document::TextAnchor::TextSegment TextSegment}
+            #     half open end UTF-8 char index in the
             #     {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
             class TextSegment
               include ::Google::Protobuf::MessageExts
@@ -612,9 +667,10 @@ module Google
             end
           end
 
-          # Referencing the visual context of the entity in the {::Google::Cloud::DocumentAI::V1::Document#pages Document.pages}.
-          # Page anchors can be cross-page, consist of multiple bounding polygons and
-          # optionally reference specific layout element types.
+          # Referencing the visual context of the entity in the
+          # {::Google::Cloud::DocumentAI::V1::Document#pages Document.pages}. Page anchors
+          # can be cross-page, consist of multiple bounding polygons and optionally
+          # reference specific layout element types.
           # @!attribute [rw] page_refs
           #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef>]
           #     One or more references to visual page elements
@@ -625,22 +681,29 @@ module Google
             # Represents a weak reference to a page element within a document.
             # @!attribute [rw] page
             #   @return [::Integer]
-            #     Required. Index into the {::Google::Cloud::DocumentAI::V1::Document#pages Document.pages} element, for example using
-            #     [Document.pages][page_refs.page] to locate the related page element.
-            #     This field is skipped when its value is the default 0. See
+            #     Required. Index into the
+            #     {::Google::Cloud::DocumentAI::V1::Document#pages Document.pages} element,
+            #     for example using [Document.pages][page_refs.page] to locate the
+            #     related page element. This field is skipped when its value is the
+            #     default 0. See
             #     https://developers.google.com/protocol-buffers/docs/proto3#json.
             # @!attribute [rw] layout_type
             #   @return [::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef::LayoutType]
-            #     Optional. The type of the layout element that is being referenced if any.
+            #     Optional. The type of the layout element that is being referenced if
+            #     any.
             # @!attribute [rw] layout_id
             #   @return [::String]
-            #     Optional. Deprecated.  Use {::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef#bounding_poly PageRef.bounding_poly} instead.
+            #     Optional. Deprecated.  Use
+            #     {::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef#bounding_poly PageRef.bounding_poly}
+            #     instead.
             # @!attribute [rw] bounding_poly
             #   @return [::Google::Cloud::DocumentAI::V1::BoundingPoly]
-            #     Optional. Identifies the bounding polygon of a layout element on the page.
+            #     Optional. Identifies the bounding polygon of a layout element on the
+            #     page.
             # @!attribute [rw] confidence
             #   @return [::Float]
-            #     Optional. Confidence of detected page element, if applicable. Range [0, 1].
+            #     Optional. Confidence of detected page element, if applicable. Range [0,
+            #     1].
             class PageRef
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -650,25 +713,38 @@ module Google
                 # Layout Unspecified.
                 LAYOUT_TYPE_UNSPECIFIED = 0
 
-                # References a {::Google::Cloud::DocumentAI::V1::Document::Page#blocks Page.blocks} element.
+                # References a
+                # {::Google::Cloud::DocumentAI::V1::Document::Page#blocks Page.blocks}
+                # element.
                 BLOCK = 1
 
-                # References a {::Google::Cloud::DocumentAI::V1::Document::Page#paragraphs Page.paragraphs} element.
+                # References a
+                # {::Google::Cloud::DocumentAI::V1::Document::Page#paragraphs Page.paragraphs}
+                # element.
                 PARAGRAPH = 2
 
-                # References a {::Google::Cloud::DocumentAI::V1::Document::Page#lines Page.lines} element.
+                # References a
+                # {::Google::Cloud::DocumentAI::V1::Document::Page#lines Page.lines} element.
                 LINE = 3
 
-                # References a {::Google::Cloud::DocumentAI::V1::Document::Page#tokens Page.tokens} element.
+                # References a
+                # {::Google::Cloud::DocumentAI::V1::Document::Page#tokens Page.tokens}
+                # element.
                 TOKEN = 4
 
-                # References a {::Google::Cloud::DocumentAI::V1::Document::Page#visual_elements Page.visual_elements} element.
+                # References a
+                # {::Google::Cloud::DocumentAI::V1::Document::Page#visual_elements Page.visual_elements}
+                # element.
                 VISUAL_ELEMENT = 5
 
-                # Refrrences a {::Google::Cloud::DocumentAI::V1::Document::Page#tables Page.tables} element.
+                # Refrrences a
+                # {::Google::Cloud::DocumentAI::V1::Document::Page#tables Page.tables}
+                # element.
                 TABLE = 6
 
-                # References a {::Google::Cloud::DocumentAI::V1::Document::Page#form_fields Page.form_fields} element.
+                # References a
+                # {::Google::Cloud::DocumentAI::V1::Document::Page#form_fields Page.form_fields}
+                # element.
                 FORM_FIELD = 7
               end
             end
@@ -693,16 +769,15 @@ module Google
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
 
-            # Structure for referencing parent provenances.  When an element replaces
-            # one of more other elements parent references identify the elements that
-            # are replaced.
+            # The parent element the current element is based on. Used for
+            # referencing/aligning, removal and replacement operations.
             # @!attribute [rw] revision
             #   @return [::Integer]
-            #     The index of the [Document.revisions] identifying the parent revision.
+            #     The index of the index into current revision's parent_ids list.
             # @!attribute [rw] index
             #   @return [::Integer]
-            #     The index of the parent revisions corresponding collection of items
-            #     (eg. list of entities, properties within entities, etc.)
+            #     The index of the parent item in the corresponding item list (eg. list
+            #     of entities, properties within entities, etc.) in the parent revision.
             # @!attribute [rw] id
             #   @return [::Integer]
             #     The id of the parent provenance.
@@ -713,19 +788,20 @@ module Google
 
             # If a processor or agent does an explicit operation on existing elements.
             module OperationType
-              # Operation type unspecified.
+              # Operation type unspecified. If no operation is specified a provenance
+              # entry is simply used to match against a `parent`.
               OPERATION_TYPE_UNSPECIFIED = 0
 
-              # Add an element.  Implicit if no `parents` are set for the provenance.
+              # Add an element.
               ADD = 1
 
-              # The element is removed.  No `parents` should be set.
+              # Remove an element identified by `parent`.
               REMOVE = 2
 
-              # Explicitly replaces the element(s) identified by `parents`.
+              # Replace an element identified by `parent`.
               REPLACE = 3
 
-              # Element is requested for human review.
+              # Request human review for the element identified by `parent`.
               EVAL_REQUESTED = 4
 
               # Element is reviewed and approved at human review, confidence will be
@@ -782,8 +858,9 @@ module Google
           # @!attribute [rw] text_anchor
           #   @return [::Google::Cloud::DocumentAI::V1::Document::TextAnchor]
           #     Provenance of the correction.
-          #     Text anchor indexing into the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.  There can only be a
-          #     single `TextAnchor.text_segments` element.  If the start and
+          #     Text anchor indexing into the
+          #     {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.  There can
+          #     only be a single `TextAnchor.text_segments` element.  If the start and
           #     end index of the text segment are the same, the text change is inserted
           #     before that index.
           # @!attribute [rw] changed_text

data/proto_docs/google/cloud/documentai/v1/document_processor_service.rb

@@ -227,6 +227,9 @@ module Google
         # @!attribute [rw] common_metadata
         #   @return [::Google::Cloud::DocumentAI::V1::CommonOperationMetadata]
         #     The basic metadata of the long running operation.
+        # @!attribute [rw] question_id
+        #   @return [::String]
+        #     The question ID.
         class ReviewDocumentOperationMetadata
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-document_ai-v1
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-12 00:00:00.000000000 Z
+date: 2022-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -224,7 +224,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: API Client library for the Document AI V1 API