google-cloud-document_ai-v1 0.2.4 → 0.5.0

data/proto_docs/google/api/launch_stage.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Api
+    # The launch stage as defined by [Google Cloud Platform
+    # Launch Stages](http://cloud.google.com/terms/launch-stages).
+    module LaunchStage
+      # Do not use this default value.
+      LAUNCH_STAGE_UNSPECIFIED = 0
+
+      # The feature is not yet implemented. Users can not use it.
+      UNIMPLEMENTED = 6
+
+      # Prelaunch features are hidden from users and are only visible internally.
+      PRELAUNCH = 7
+
+      # Early Access features are limited to a closed group of testers. To use
+      # these features, you must sign up in advance and sign a Trusted Tester
+      # agreement (which includes confidentiality provisions). These features may
+      # be unstable, changed in backward-incompatible ways, and are not
+      # guaranteed to be released.
+      EARLY_ACCESS = 1
+
+      # Alpha is a limited availability test for releases before they are cleared
+      # for widespread use. By Alpha, all significant design issues are resolved
+      # and we are in the process of verifying functionality. Alpha customers
+      # need to apply for access, agree to applicable terms, and have their
+      # projects allowlisted. Alpha releases don’t have to be feature complete,
+      # no SLAs are provided, and there are no technical support obligations, but
+      # they will be far enough along that customers can actually use them in
+      # test environments or for limited-use tests -- just like they would in
+      # normal production cases.
+      ALPHA = 2
+
+      # Beta is the point at which we are ready to open a release for any
+      # customer to use. There are no SLA or technical support obligations in a
+      # Beta release. Products will be complete from a feature perspective, but
+      # may have some open outstanding issues. Beta releases are suitable for
+      # limited production use cases.
+      BETA = 3
+
+      # GA features are open to all developers and are considered stable and
+      # fully qualified for production use.
+      GA = 4
+
+      # Deprecated features are scheduled to be shut down and removed. For more
+      # information, see the “Deprecation Policy” section of our [Terms of
+      # Service](https://cloud.google.com/terms/)
+      # and the [Google Cloud Platform Subject to the Deprecation
+      # Policy](https://cloud.google.com/terms/deprecation) documentation.
+      DEPRECATED = 5
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module DocumentAI
+      module V1
+        # Encodes the detailed information of a barcode.
+        # @!attribute [rw] format
+        #   @return [::String]
+        #     Format of a barcode.
+        #     The supported formats are:
+        #       CODE_128: Code 128 type.
+        #       CODE_39: Code 39 type.
+        #       CODE_93: Code 93 type.
+        #       CODABAR: Codabar type.
+        #       DATA_MATRIX: 2D Data Matrix type.
+        #       ITF: ITF type.
+        #       EAN_13: EAN-13 type.
+        #       EAN_8: EAN-8 type.
+        #       QR_CODE: 2D QR code type.
+        #       UPC_A: UPC-A type.
+        #       UPC_E: UPC-E type.
+        #       PDF417: PDF417 type.
+        #       AZTEC: 2D Aztec code type.
+        #       DATABAR: GS1 DataBar code type.
+        # @!attribute [rw] value_format
+        #   @return [::String]
+        #     Value format describes the format of the value that a barcode
+        #     encodes.
+        #     The supported formats are:
+        #       CONTACT_INFO: Contact information.
+        #       EMAIL: Email address.
+        #       ISBN: ISBN identifier.
+        #       PHONE: Phone number.
+        #       PRODUCT: Product.
+        #       SMS: SMS message.
+        #       TEXT: Text string.
+        #       URL: URL address.
+        #       WIFI: Wifi information.
+        #       GEO: Geo-localization.
+        #       CALENDAR_EVENT: Calendar event.
+        #       DRIVER_LICENSE: Driver's license.
+        # @!attribute [rw] raw_value
+        #   @return [::String]
+        #     Raw value encoded in the barcode.
+        #     For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'.
+        class Barcode
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -21,11 +21,10 @@ module Google
   module Cloud
     module DocumentAI
       module V1
-        # Document represents the canonical document resource in Document Understanding
-        # AI.
-        # It is an interchange format that provides insights into documents and allows
-        # for collaboration between users and Document Understanding AI to iterate and
-        # optimize for quality.
+        # Document represents the canonical document resource in Document AI. It is an
+        # interchange format that provides insights into documents and allows for
+        # collaboration between users and Document AI to iterate and optimize for
+        # quality.
         # @!attribute [rw] uri
         #   @return [::String]
         #     Optional. Currently supports Google Cloud Storage URI of the form
@@ -48,7 +47,7 @@ module Google
         #     Optional. UTF-8 encoded text in reading order from the document.
         # @!attribute [rw] text_styles
         #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Style>]
-        #     Styles for the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
+        #     Placeholder.  Styles for the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
         # @!attribute [rw] pages
         #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page>]
         #     Visual page layout for the {::Google::Cloud::DocumentAI::V1::Document Document}.
@@ -58,12 +57,12 @@ module Google
         #     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}.
+        #     Placeholder.  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
-        #     used for annotating corrections to OCR mistakes.  Text changes for a given
-        #     revision may not overlap with each other.
+        #     Placeholder.  A list of text corrections made to [Document.text].  This is
+        #     usually used for annotating corrections to OCR mistakes.  Text changes for
+        #     a given revision may not overlap with each other.
         # @!attribute [rw] shard_info
         #   @return [::Google::Cloud::DocumentAI::V1::Document::ShardInfo]
         #     Information about the sharding if this document is sharded part of a larger
@@ -73,7 +72,7 @@ module Google
         #     Any error that occurred while processing this document.
         # @!attribute [rw] revisions
         #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Revision>]
-        #     Revision history of this document.
+        #     Placeholder. Revision history of this document.
         class Document
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -190,6 +189,12 @@ 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] detected_barcodes
+          #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedBarcode>]
+          #     A list of detected barcodes.
           # @!attribute [rw] provenance
           #   @return [::Google::Cloud::DocumentAI::V1::Document::Provenance]
           #     The history of this page.
@@ -382,6 +387,18 @@ 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
@@ -464,6 +481,16 @@ module Google
             #     - blank (this indicates the field_value is normal text)
             #     - "unfilled_checkbox"
             #     - "filled_checkbox"
+            # @!attribute [rw] corrected_key_text
+            #   @return [::String]
+            #     Created for Labeling UI to export key text.
+            #     If corrections were made to the text identified by the
+            #     `field_name.text_anchor`, this field will contain the correction.
+            # @!attribute [rw] corrected_value_text
+            #   @return [::String]
+            #     Created for Labeling UI to export value text.
+            #     If corrections were made to the text identified by the
+            #     `field_value.text_anchor`, this field will contain the correction.
             # @!attribute [rw] provenance
             #   @return [::Google::Cloud::DocumentAI::V1::Document::Provenance]
             #     The history of this annotation.
@@ -472,12 +499,24 @@ module Google
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
 
+            # A detected barcode.
+            # @!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::DetectedBarcode DetectedBarcode}.
+            # @!attribute [rw] barcode
+            #   @return [::Google::Cloud::DocumentAI::V1::Barcode]
+            #     Detailed barcode information of the {::Google::Cloud::DocumentAI::V1::Document::Page::DetectedBarcode DetectedBarcode}.
+            class DetectedBarcode
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
             # Detected language for a structural component.
             # @!attribute [rw] language_code
             #   @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,20 @@ 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}.
           # @!attribute [rw] type
           #   @return [::String]
-          #     Entity type from a schema e.g. `Address`.
+          #     Required. 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.
@@ -554,12 +595,21 @@ module Google
             #   @return [::Boolean]
             #     Boolean value. Can be used for entities with binary values, or for
             #     checkboxes.
+            # @!attribute [rw] integer_value
+            #   @return [::Integer]
+            #     Integer value.
+            # @!attribute [rw] float_value
+            #   @return [::Float]
+            #     Float value.
             # @!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.
@@ -591,7 +641,8 @@ module Google
           # @!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
@@ -693,16 +744,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 +763,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
@@ -754,6 +805,11 @@ module Google
           #     The revisions that this revision is based on.  This can include one or
           #     more parent (when documents are merged.)  This field represents the
           #     index into the `revisions` field.
+          # @!attribute [rw] parent_ids
+          #   @return [::Array<::String>]
+          #     The revisions that this revision is based on. Must include all the ids
+          #     that have anything to do with this revision - eg. there are
+          #     `provenance.parent.revision` fields that index into this field.
           # @!attribute [rw] create_time
           #   @return [::Google::Protobuf::Timestamp]
           #     The time that the revision was created.