google-cloud-document_ai-v1beta3 0.10.0 → 0.13.0

data/proto_docs/google/cloud/documentai/v1beta3/document_schema.rb

@@ -0,0 +1,154 @@
+# 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 V1beta3
+        # The schema defines the output of the processed document by a processor.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Display name to show to users.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Description of the schema.
+        # @!attribute [rw] entity_types
+        #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::DocumentSchema::EntityType>]
+        #     Entity types of the schema.
+        # @!attribute [rw] metadata
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::DocumentSchema::Metadata]
+        #     Metadata of the schema.
+        class DocumentSchema
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # EntityType is the wrapper of a label of the corresponding model with
+          # detailed attributes and limitations for entity-based processors. Multiple
+          # types can also compose a dependency tree to represent nested types.
+          # @!attribute [rw] enum_values
+          #   @return [::Google::Cloud::DocumentAI::V1beta3::DocumentSchema::EntityType::EnumValues]
+          #     If specified, lists all the possible values for this entity.  This
+          #     should not be more than a handful of values.  If the number of values
+          #     is >10 or could change frequently use the `EntityType.value_ontology`
+          #     field and specify a list of all possible values in a value ontology
+          #     file.
+          # @!attribute [rw] display_name
+          #   @return [::String]
+          #     User defined name for the type.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Name of the type. It must be unique within the schema file and
+          #     cannot be a 'Common Type'.  Besides that we use the following naming
+          #     conventions:
+          #     - *use snake_casing*
+          #     - name matching is case-insensitive
+          #     - Maximum 64 characters.
+          #     - Must start with a letter.
+          #     - Allowed characters: ASCII letters `[a-z0-9_-]`.  (For backward
+          #       compatibility internal infrastructure and tooling can handle any ascii
+          #       character)
+          #     - The '/' is sometimes used to denote a property of a type.  For example
+          #       line_item/amount.  This convention is deprecated, but will still be
+          #       honored for backward compatibility.
+          # @!attribute [rw] base_types
+          #   @return [::Array<::String>]
+          #     The entity type that this type is derived from.  For now, one and only
+          #     one should be set.
+          # @!attribute [rw] properties
+          #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::DocumentSchema::EntityType::Property>]
+          #     Describing the nested structure, or composition of an entity.
+          class EntityType
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Defines the a list of enum values.
+            # @!attribute [rw] values
+            #   @return [::Array<::String>]
+            #     The individual values that this enum values type can include.
+            class EnumValues
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Defines properties that can be part of the entity type.
+            # @!attribute [rw] name
+            #   @return [::String]
+            #     The name of the property.  Follows the same guidelines as the
+            #     EntityType name.
+            # @!attribute [rw] value_type
+            #   @return [::String]
+            #     A reference to the value type of the property.  This type is subject
+            #     to the same conventions as the `Entity.base_types` field.
+            # @!attribute [rw] occurrence_type
+            #   @return [::Google::Cloud::DocumentAI::V1beta3::DocumentSchema::EntityType::Property::OccurrenceType]
+            #     Occurrence type limits the number of instances an entity type appears
+            #     in the document.
+            class Property
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Types of occurrences of the entity type in the document.  Note: this
+              # represents the number of instances of an entity types, not number of
+              # mentions of a given entity instance.
+              module OccurrenceType
+                # Unspecified occurrence type.
+                OCCURRENCE_TYPE_UNSPECIFIED = 0
+
+                # There will be zero or one instance of this entity type.
+                OPTIONAL_ONCE = 1
+
+                # The entity type will appear zero or multiple times.
+                OPTIONAL_MULTIPLE = 2
+
+                # The entity type will only appear exactly once.
+                REQUIRED_ONCE = 3
+
+                # The entity type will appear once or more times.
+                REQUIRED_MULTIPLE = 4
+              end
+            end
+          end
+
+          # Metadata for global schema behavior.
+          # @!attribute [rw] document_splitter
+          #   @return [::Boolean]
+          #     If true, a `document` entity type can be applied to subdocument (
+          #     splitting). Otherwise, it can only be applied to the entire document
+          #     (classification).
+          # @!attribute [rw] document_allow_multiple_labels
+          #   @return [::Boolean]
+          #     If true, on a given page, there can be multiple `document` annotations
+          #     covering it.
+          # @!attribute [rw] prefixed_naming_on_properties
+          #   @return [::Boolean]
+          #     If set, all the nested entities must be prefixed with the parents.
+          # @!attribute [rw] skip_naming_validation
+          #   @return [::Boolean]
+          #     If set, we will skip the naming format validation in the schema. So the
+          #     string values in `DocumentSchema.EntityType.name` and
+          #     `DocumentSchema.EntityType.Property.name` will not be checked.
+          class Metadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/documentai/v1beta3/operation_metadata.rb

@@ -28,6 +28,9 @@ module Google
         # @!attribute [rw] state_message
         #   @return [::String]
         #     A message providing more details about the current state of processing.
+        # @!attribute [rw] resource
+        #   @return [::String]
+        #     A related resource to this operation.
         # @!attribute [rw] create_time
         #   @return [::Google::Protobuf::Timestamp]
         #     The creation time of the operation.

data/proto_docs/google/cloud/documentai/v1beta3/processor.rb

@@ -21,15 +21,92 @@ module Google
   module Cloud
     module DocumentAI
       module V1beta3
-        # The first-class citizen for DocumentAI. Each processor defines how to extract
-        # structural information from a document.
+        # A processor version is an implementation of a processor. Each processor
+        # can have multiple versions, pre-trained by Google internally or up-trained
+        # by the customer. At a time, a processor can only have one default version
+        # version. So the processor's behavior (when processing documents) is defined
+        # by a default version
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     The resource name of the processor version.
+        #     Format:
+        #     `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     The display name of the processor version.
+        # @!attribute [rw] state
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion::State]
+        #     The state of the processor version.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The time the processor version was created.
+        # @!attribute [rw] kms_key_name
+        #   @return [::String]
+        #     The KMS key name used for encryption.
+        # @!attribute [rw] kms_key_version_name
+        #   @return [::String]
+        #     The KMS key version with which data is encrypted.
+        # @!attribute [rw] google_managed
+        #   @return [::Boolean]
+        #     Denotes that this ProcessorVersion is managed by google.
+        # @!attribute [rw] deprecation_info
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion::DeprecationInfo]
+        #     If set, information about the eventual deprecation of this version.
+        class ProcessorVersion
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Information about the upcoming deprecation of this processor version.
+          # @!attribute [rw] deprecation_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The time at which this processor version will be deprecated.
+          # @!attribute [rw] replacement_processor_version
+          #   @return [::String]
+          #     If set, the processor version that will be used as a replacement.
+          class DeprecationInfo
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The possible states of the processor version.
+          module State
+            # The processor version is in an unspecified state.
+            STATE_UNSPECIFIED = 0
+
+            # The processor version is deployed and can be used for processing.
+            DEPLOYED = 1
+
+            # The processor version is being deployed.
+            DEPLOYING = 2
+
+            # The processor version is not deployed and cannot be used for processing.
+            UNDEPLOYED = 3
+
+            # The processor version is being undeployed.
+            UNDEPLOYING = 4
+
+            # The processor version is being created.
+            CREATING = 5
+
+            # The processor version is being deleted.
+            DELETING = 6
+
+            # The processor version failed and is in an indeterminate state.
+            FAILED = 7
+          end
+        end
+
+        # The first-class citizen for Document AI. Each processor defines how to
+        # extract structural information from a document.
         # @!attribute [r] name
         #   @return [::String]
         #     Output only. Immutable. The resource name of the processor.
-        #     Format: projects/\\{project}/locations/\\{location}/processors/\\{processor}
+        #     Format: `projects/{project}/locations/{location}/processors/{processor}`
         # @!attribute [rw] type
         #   @return [::String]
-        #     The processor type.
+        #     The processor type, e.g., OCR_PROCESSOR, INVOICE_PROCESSOR, etc.
+        #     To get a list of processors types, see
+        #     {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#fetch_processor_types FetchProcessorTypes}.
         # @!attribute [rw] display_name
         #   @return [::String]
         #     The display name of the processor.
@@ -58,7 +135,9 @@ module Google
             # The processor is in an unspecified state.
             STATE_UNSPECIFIED = 0
 
-            # The processor is enabled.
+            # The processor is enabled, i.e., has an enabled version which can
+            # currently serve processing requests and all the feature dependencies have
+            # been successfully initialized.
             ENABLED = 1
 
             # The processor is disabled.
@@ -70,10 +149,16 @@ module Google
             # The processor is being disabled, will become DISABLED if successful.
             DISABLING = 4
 
-            # The processor is being created.
+            # The processor is being created, will become either ENABLED (for
+            # successful creation) or FAILED (for failed ones).
+            # Once a processor is in this state, it can then be used for document
+            # processing, but the feature dependencies of the processor might not be
+            # fully created yet.
             CREATING = 5
 
-            # The processor failed during creation.
+            # The processor failed during creation or initialization of feature
+            # dependencies. The user should delete the processor and recreate one as
+            # all the functionalities of the processor are disabled.
             FAILED = 6
 
             # The processor is being deleted, will be removed if successful.

data/proto_docs/google/cloud/documentai/v1beta3/processor_type.rb

@@ -26,20 +26,23 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     The resource name of the processor type.
+        #     Format: projects/\\{project}/processorTypes/\\{processor_type}
         # @!attribute [rw] type
         #   @return [::String]
-        #     The type of the processor.
+        #     The type of the processor, e.g., "invoice_parsing".
         # @!attribute [rw] category
         #   @return [::String]
-        #     The processor category.
+        #     The processor category, used by UI to group processor types.
         # @!attribute [rw] available_locations
         #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::ProcessorType::LocationInfo>]
         #     The locations in which this processor is available.
         # @!attribute [rw] allow_creation
         #   @return [::Boolean]
-        #     Whether the processor type allows creation. If yes, user can create a
-        #     processor of this processor type. Otherwise, user needs to require for
-        #     whitelisting.
+        #     Whether the processor type allows creation. If true, users can create a
+        #     processor of this processor type. Otherwise, users need to request access.
+        # @!attribute [rw] launch_stage
+        #   @return [::Google::Api::LaunchStage]
+        #     Launch stage of the processor type
         class ProcessorType
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -47,7 +50,7 @@ module Google
           # The location information about where the processor is available.
           # @!attribute [rw] location_id
           #   @return [::String]
-          #     The location id.
+          #     The location id, currently must be one of [us, eu].
           class LocationInfo
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/protobuf/any.rb

@@ -44,7 +44,7 @@ module Google
     #       foo = any.unpack(Foo.class);
     #     }
     #
-    #  Example 3: Pack and unpack a message in Python.
+    # Example 3: Pack and unpack a message in Python.
     #
     #     foo = Foo(...)
     #     any = Any()
@@ -54,7 +54,7 @@ module Google
     #       any.Unpack(foo)
     #       ...
     #
-    #  Example 4: Pack and unpack a message in Go
+    # Example 4: Pack and unpack a message in Go
     #
     #      foo := &pb.Foo{...}
     #      any, err := anypb.New(foo)
@@ -75,7 +75,7 @@ module Google
     #
     #
     # JSON
-    # ====
+    #
     # The JSON representation of an `Any` value uses the regular
     # representation of the deserialized, embedded message, with an
     # additional field `@type` which contains the type URL. Example:

data/proto_docs/google/protobuf/empty.rb

@@ -26,8 +26,6 @@ module Google
     #     service Foo {
     #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
     #     }
-    #
-    # The JSON representation for `Empty` is empty JSON object `{}`.
     class Empty
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-document_ai-v1beta3
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-09 00:00:00.000000000 Z
+date: 2022-08-17 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.7'
+        version: '0.10'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.10'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -44,34 +44,54 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-location
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
 - !ruby/object:Gem::Dependency
   name: google-style
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.25.1
+        version: 1.26.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.25.1
+        version: 1.26.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.16'
 - !ruby/object:Gem::Dependency
   name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
@@ -106,14 +126,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -178,20 +198,25 @@ files:
 - lib/google/cloud/document_ai/v1beta3/document_processor_service/operations.rb
 - lib/google/cloud/document_ai/v1beta3/document_processor_service/paths.rb
 - lib/google/cloud/document_ai/v1beta3/version.rb
+- lib/google/cloud/documentai/v1beta3/barcode_pb.rb
 - lib/google/cloud/documentai/v1beta3/document_io_pb.rb
 - lib/google/cloud/documentai/v1beta3/document_pb.rb
 - lib/google/cloud/documentai/v1beta3/document_processor_service_pb.rb
 - lib/google/cloud/documentai/v1beta3/document_processor_service_services_pb.rb
+- lib/google/cloud/documentai/v1beta3/document_schema_pb.rb
 - lib/google/cloud/documentai/v1beta3/geometry_pb.rb
 - lib/google/cloud/documentai/v1beta3/operation_metadata_pb.rb
 - lib/google/cloud/documentai/v1beta3/processor_pb.rb
 - lib/google/cloud/documentai/v1beta3/processor_type_pb.rb
 - proto_docs/README.md
 - proto_docs/google/api/field_behavior.rb
+- proto_docs/google/api/launch_stage.rb
 - proto_docs/google/api/resource.rb
+- proto_docs/google/cloud/documentai/v1beta3/barcode.rb
 - proto_docs/google/cloud/documentai/v1beta3/document.rb
 - proto_docs/google/cloud/documentai/v1beta3/document_io.rb
 - proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb
+- proto_docs/google/cloud/documentai/v1beta3/document_schema.rb
 - proto_docs/google/cloud/documentai/v1beta3/geometry.rb
 - proto_docs/google/cloud/documentai/v1beta3/operation_metadata.rb
 - proto_docs/google/cloud/documentai/v1beta3/processor.rb
@@ -221,14 +246,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
+rubygems_version: 3.3.14
 signing_key: 
 specification_version: 4
 summary: API Client library for the Document AI V1beta3 API