google-cloud-document_ai-v1beta3 0.23.0 → 0.25.0

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

@@ -21,6 +21,24 @@ module Google
   module Cloud
     module DocumentAI
       module V1beta3
+        # Metadata about a property.
+        # @!attribute [rw] inactive
+        #   @return [::Boolean]
+        #     Whether the property should be considered as "inactive".
+        class PropertyMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata about an entity type.
+        # @!attribute [rw] inactive
+        #   @return [::Boolean]
+        #     Whether the entity type should be considered inactive.
+        class EntityTypeMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # The schema defines the output of the processed document by a processor.
         # @!attribute [rw] display_name
         #   @return [::String]
@@ -54,16 +72,15 @@ module Google
           # @!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:
+          #     cannot be a "Common Type".  The following naming conventions are used:
           #
-          #     - *use `snake_casing`*
-          #     - name matching is case-sensitive
+          #     - Use `snake_casing`.
+          #     - Name matching is case-sensitive.
           #     - 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)
+          #       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.
@@ -73,7 +90,10 @@ module Google
           #     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.
+          #     Description the nested structure, or composition of an entity.
+          # @!attribute [rw] entity_type_metadata
+          #   @return [::Google::Cloud::DocumentAI::V1beta3::EntityTypeMetadata]
+          #     Metadata for the entity type.
           class EntityType
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -100,24 +120,35 @@ module Google
             #   @return [::Google::Cloud::DocumentAI::V1beta3::DocumentSchema::EntityType::Property::OccurrenceType]
             #     Occurrence type limits the number of instances an entity type appears
             #     in the document.
+            # @!attribute [rw] property_metadata
+            #   @return [::Google::Cloud::DocumentAI::V1beta3::PropertyMetadata]
+            #     Any additional metadata about the property can be added here.
             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.
+              # Types of occurrences of the entity type in the document.  This
+              # represents the number of instances of instances of an entity, not
+              # number of mentions of an entity.  For example, a bank statement may
+              # only have one `account_number`, but this account number may be
+              # mentioned in several places on the document.  In this case the
+              # 'account_number' would be considered a `REQUIRED_ONCE` entity type. If,
+              # on the other hand, we expect a bank statement to contain the status of
+              # multiple different accounts for the customers, the occurrence type will
+              # be set to `REQUIRED_MULTIPLE`.
               module OccurrenceType
                 # Unspecified occurrence type.
                 OCCURRENCE_TYPE_UNSPECIFIED = 0
 
-                # There will be zero or one instance of this entity type.
+                # There will be zero or one instance of this entity type.  The same
+                # entity instance may be mentioned multiple times.
                 OPTIONAL_ONCE = 1
 
                 # The entity type will appear zero or multiple times.
                 OPTIONAL_MULTIPLE = 2
 
-                # The entity type will only appear exactly once.
+                # The entity type will only appear exactly once.  The same
+                # entity instance may be mentioned multiple times.
                 REQUIRED_ONCE = 3
 
                 # The entity type will appear once or more times.
@@ -129,8 +160,8 @@ module Google
           # 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
+          #     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]

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

@@ -0,0 +1,275 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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
+        # @!attribute [rw] dataset
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::Dataset]
+        #     Required. The `name` field of the `Dataset` is used to identify the
+        #     resource to be updated.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     The update mask applies to the resource.
+        class UpdateDatasetRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # @!attribute [rw] common_metadata
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
+        #     The basic metadata of the long running operation.
+        class UpdateDatasetOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # @!attribute [rw] dataset
+        #   @return [::String]
+        #     Required. The dataset resource name.
+        #     Format:
+        #     projects/\\{project}/locations/\\{location}/processors/\\{processor}/dataset
+        # @!attribute [rw] batch_documents_import_configs
+        #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::ImportDocumentsRequest::BatchDocumentsImportConfig>]
+        #     Required. The Cloud Storage uri containing raw documents that must be
+        #     imported.
+        class ImportDocumentsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Config for importing documents.
+          # Each batch can have its own dataset split type.
+          # @!attribute [rw] dataset_split
+          #   @return [::Google::Cloud::DocumentAI::V1beta3::DatasetSplitType]
+          #     Target dataset split where the documents must be stored.
+          # @!attribute [rw] auto_split_config
+          #   @return [::Google::Cloud::DocumentAI::V1beta3::ImportDocumentsRequest::BatchDocumentsImportConfig::AutoSplitConfig]
+          #     If set, documents will be automatically split into training and test
+          #     split category with the specified ratio.
+          # @!attribute [rw] batch_input_config
+          #   @return [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig]
+          #     The common config to specify a set of documents used as input.
+          class BatchDocumentsImportConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The config for auto-split.
+            # @!attribute [rw] training_split_ratio
+            #   @return [::Float]
+            #     Ratio of training dataset split.
+            class AutoSplitConfig
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+        end
+
+        # Response of the import document operation.
+        class ImportDocumentsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata of the import document operation.
+        # @!attribute [rw] common_metadata
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
+        #     The basic metadata of the long running operation.
+        # @!attribute [rw] individual_import_statuses
+        #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::ImportDocumentsMetadata::IndividualImportStatus>]
+        #     The list of response details of each document.
+        # @!attribute [rw] import_config_validation_results
+        #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::ImportDocumentsMetadata::ImportConfigValidationResult>]
+        #     Validation statuses of the batch documents import config.
+        # @!attribute [rw] total_document_count
+        #   @return [::Integer]
+        #     Total number of the documents that are qualified for importing.
+        class ImportDocumentsMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The status of each individual document in the import process.
+          # @!attribute [rw] input_gcs_source
+          #   @return [::String]
+          #     The source Cloud Storage URI of the document.
+          # @!attribute [rw] status
+          #   @return [::Google::Rpc::Status]
+          #     The status of the importing of the document.
+          # @!attribute [rw] output_document_id
+          #   @return [::Google::Cloud::DocumentAI::V1beta3::DocumentId]
+          #     The document id of imported document if it was successful, otherwise
+          #     empty.
+          class IndividualImportStatus
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The validation status of each import config. Status is set to errors if
+          # there is no documents to import in the import_config, or OK if the
+          # operation will try to proceed at least one document.
+          # @!attribute [rw] input_gcs_source
+          #   @return [::String]
+          #     The source Cloud Storage URI specified in the import config.
+          # @!attribute [rw] status
+          #   @return [::Google::Rpc::Status]
+          #     The validation status of import config.
+          class ImportConfigValidationResult
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # @!attribute [rw] dataset
+        #   @return [::String]
+        #     Required. The resource name of the dataset that the document belongs to .
+        #     Format:
+        #     projects/\\{project}/locations/\\{location}/processors/\\{processor}/dataset
+        # @!attribute [rw] document_id
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::DocumentId]
+        #     Required. Document identifier.
+        # @!attribute [rw] read_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     If set, only fields listed here will be returned. Otherwise, all fields
+        #     will be returned by default.
+        # @!attribute [rw] page_range
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::DocumentPageRange]
+        #     List of pages for which the fields specified in the `read_mask` must
+        #     be served.
+        class GetDocumentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # @!attribute [rw] document
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::Document]
+        class GetDocumentResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # @!attribute [rw] dataset
+        #   @return [::String]
+        #     Required. The dataset resource name.
+        #     Format:
+        #     projects/\\{project}/locations/\\{location}/processors/\\{processor}/dataset
+        # @!attribute [rw] dataset_documents
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::BatchDatasetDocuments]
+        #     Required. Dataset documents input. If given `filter`, all documents
+        #     satisfying the filter will be deleted. If given documentIds, a maximum of
+        #     50 documents can be deleted in a batch. The request will be rejected if
+        #     more than 50 document_ids are provided.
+        class BatchDeleteDocumentsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response of the delete documents operation.
+        class BatchDeleteDocumentsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # @!attribute [rw] common_metadata
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
+        #     The basic metadata of the long running operation.
+        # @!attribute [rw] individual_batch_delete_statuses
+        #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::BatchDeleteDocumentsMetadata::IndividualBatchDeleteStatus>]
+        #     The list of response details of each document.
+        # @!attribute [rw] total_document_count
+        #   @return [::Integer]
+        #     Total number of documents deleting from dataset.
+        # @!attribute [rw] error_document_count
+        #   @return [::Integer]
+        #     Total number of documents that failed to be deleted in storage.
+        class BatchDeleteDocumentsMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The status of each individual document in the batch delete process.
+          # @!attribute [rw] document_id
+          #   @return [::Google::Cloud::DocumentAI::V1beta3::DocumentId]
+          #     The document id of the document.
+          # @!attribute [rw] status
+          #   @return [::Google::Rpc::Status]
+          #     The status of deleting the document in storage.
+          class IndividualBatchDeleteStatus
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Request for `GetDatasetSchema`.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The dataset schema resource name.
+        #     Format:
+        #     projects/\\{project}/locations/\\{location}/processors/\\{processor}/dataset/datasetSchema
+        # @!attribute [rw] visible_fields_only
+        #   @return [::Boolean]
+        #     If set, only returns the visible fields of the schema.
+        class GetDatasetSchemaRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for `UpdateDatasetSchema`.
+        # @!attribute [rw] dataset_schema
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::DatasetSchema]
+        #     Required. The name field of the `DatasetSchema` is used to identify the
+        #     resource to be updated.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     The update mask applies to the resource.
+        class UpdateDatasetSchemaRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Range of pages present in a document.
+        # @!attribute [rw] start
+        #   @return [::Integer]
+        #     First page number (one-based index) to be returned.
+        # @!attribute [rw] end
+        #   @return [::Integer]
+        #     Last page number (one-based index) to be returned.
+        class DocumentPageRange
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Documents belonging to a dataset will be split into different groups
+        # referred to as splits: train, test.
+        module DatasetSplitType
+          # Default value if the enum is not set.
+          # go/protodosdonts#do-include-an-unspecified-value-in-an-enum
+          DATASET_SPLIT_TYPE_UNSPECIFIED = 0
+
+          # Identifies the train documents.
+          DATASET_SPLIT_TRAIN = 1
+
+          # Identifies the test documents.
+          DATASET_SPLIT_TEST = 2
+
+          # Identifies the unassigned documents.
+          DATASET_SPLIT_UNASSIGNED = 3
+        end
+      end
+    end
+  end
+end

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

@@ -22,10 +22,9 @@ module Google
     module DocumentAI
       module V1beta3
         # 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
+        # can have multiple versions, pretrained by Google internally or uptrained
+        # by the customer. A processor can only have one default version at a time.
+        # Its document-processing behavior is defined by that version.
         # @!attribute [rw] name
         #   @return [::String]
         #     The resource name of the processor version.
@@ -52,9 +51,9 @@ module Google
         # @!attribute [rw] kms_key_version_name
         #   @return [::String]
         #     The KMS key version with which data is encrypted.
-        # @!attribute [rw] google_managed
+        # @!attribute [r] google_managed
         #   @return [::Boolean]
-        #     Denotes that this ProcessorVersion is managed by google.
+        #     Output only. 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.
@@ -99,6 +98,9 @@ module Google
 
             # The processor version failed and is in an indeterminate state.
             FAILED = 7
+
+            # The processor version is being imported.
+            IMPORTING = 8
           end
         end
 
@@ -110,8 +112,8 @@ module Google
         #     Format: `projects/{project}/locations/{location}/processors/{processor}`
         # @!attribute [rw] type
         #   @return [::String]
-        #     The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc.
-        #     To get a list of processors types, see
+        #     The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
+        #     To get a list of processor types, see
         #     {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#fetch_processor_types FetchProcessorTypes}.
         # @!attribute [rw] display_name
         #   @return [::String]
@@ -131,8 +133,8 @@ module Google
         #     The time the processor was created.
         # @!attribute [rw] kms_key_name
         #   @return [::String]
-        #     The KMS key used for encryption/decryption in CMEK scenarios.
-        #     See https://cloud.google.com/security-key-management.
+        #     The [KMS key](https://cloud.google.com/security-key-management) used for
+        #     encryption and decryption in CMEK scenarios.
         class Processor
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -29,7 +29,7 @@ module Google
         #     Format: `projects/{project}/processorTypes/{processor_type}`
         # @!attribute [rw] type
         #   @return [::String]
-        #     The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc.
+        #     The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
         # @!attribute [rw] category
         #   @return [::String]
         #     The processor category, used by UI to group processor types.
@@ -53,7 +53,8 @@ module Google
           # The location information about where the processor is available.
           # @!attribute [rw] location_id
           #   @return [::String]
-          #     The location id, currently must be one of [us, eu].
+          #     The location ID. For supported locations, refer to [regional and
+          #     multi-regional support](/document-ai/docs/regions).
           class LocationInfo
             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.23.0
+  version: 0.25.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-06 00:00:00.000000000 Z
+date: 2023-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -202,14 +202,26 @@ files:
 - lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/client.rb
 - lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/operations.rb
 - lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/service_stub.rb
+- lib/google/cloud/document_ai/v1beta3/document_service.rb
+- lib/google/cloud/document_ai/v1beta3/document_service/client.rb
+- lib/google/cloud/document_ai/v1beta3/document_service/credentials.rb
+- lib/google/cloud/document_ai/v1beta3/document_service/operations.rb
+- lib/google/cloud/document_ai/v1beta3/document_service/paths.rb
+- lib/google/cloud/document_ai/v1beta3/document_service/rest.rb
+- lib/google/cloud/document_ai/v1beta3/document_service/rest/client.rb
+- lib/google/cloud/document_ai/v1beta3/document_service/rest/operations.rb
+- lib/google/cloud/document_ai/v1beta3/document_service/rest/service_stub.rb
 - lib/google/cloud/document_ai/v1beta3/rest.rb
 - lib/google/cloud/document_ai/v1beta3/version.rb
 - lib/google/cloud/documentai/v1beta3/barcode_pb.rb
+- lib/google/cloud/documentai/v1beta3/dataset_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/document_service_pb.rb
+- lib/google/cloud/documentai/v1beta3/document_service_services_pb.rb
 - lib/google/cloud/documentai/v1beta3/evaluation_pb.rb
 - lib/google/cloud/documentai/v1beta3/geometry_pb.rb
 - lib/google/cloud/documentai/v1beta3/operation_metadata_pb.rb
@@ -221,10 +233,12 @@ files:
 - 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/dataset.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/document_service.rb
 - proto_docs/google/cloud/documentai/v1beta3/evaluation.rb
 - proto_docs/google/cloud/documentai/v1beta3/geometry.rb
 - proto_docs/google/cloud/documentai/v1beta3/operation_metadata.rb