google-cloud-document_ai-v1beta3 0.24.0 → 0.25.0

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

@@ -106,6 +106,44 @@ module Google
           end
         end
 
+        # Document Identifier.
+        # @!attribute [rw] gcs_managed_doc_id
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::DocumentId::GCSManagedDocumentId]
+        #     A document id within user-managed Cloud Storage.
+        # @!attribute [rw] unmanaged_doc_id
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::DocumentId::UnmanagedDocumentId]
+        #     A document id within unmanaged dataset.
+        # @!attribute [rw] revision_ref
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::RevisionRef]
+        #     Points to a specific revision of the document if set.
+        class DocumentId
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Identifies a document uniquely within the scope of a dataset in the
+          # user-managed Cloud Storage option.
+          # @!attribute [rw] gcs_uri
+          #   @return [::String]
+          #     Required. The Cloud Storage URI where the actual document is stored.
+          # @!attribute [rw] cw_doc_id
+          #   @return [::String]
+          #     Id of the document (indexed) managed by Content Warehouse.
+          class GCSManagedDocumentId
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Identifies a document uniquely within the scope of a dataset in unmanaged
+          # option.
+          # @!attribute [rw] doc_id
+          #   @return [::String]
+          #     Required. The id of the document.
+          class UnmanagedDocumentId
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
         # Dataset Schema.
         # @!attribute [rw] name
         #   @return [::String]
@@ -119,6 +157,30 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # Dataset documents that the batch operation will be applied to.
+        # @!attribute [rw] individual_document_ids
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::BatchDatasetDocuments::IndividualDocumentIds]
+        #     Document identifiers.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     A filter matching the documents.
+        #     Follows the same format and restriction as
+        #     [google.cloud.documentai.master.ListDocumentsRequest.filter].
+        class BatchDatasetDocuments
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # List of individual DocumentIds.
+          # @!attribute [rw] document_ids
+          #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::DocumentId>]
+          #     Required. List of Document IDs indicating where the actual documents are
+          #     stored.
+          class IndividualDocumentIds
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
       end
     end
   end

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

@@ -1033,6 +1033,38 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
         end
+
+        # The revision reference specifies which revision on the document to read.
+        # @!attribute [rw] revision_case
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::RevisionRef::RevisionCase]
+        #     Reads the revision by the predefined case.
+        # @!attribute [rw] revision_id
+        #   @return [::String]
+        #     Reads the revision given by the id.
+        # @!attribute [rw] latest_processor_version
+        #   @return [::String]
+        #     Reads the revision generated by the processor version.
+        #     The format takes the full resource name of processor version.
+        #     `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
+        class RevisionRef
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Some predefined revision cases.
+          module RevisionCase
+            # Unspecified case, fallback to read the LATEST_HUMAN_REVIEW.
+            REVISION_CASE_UNSPECIFIED = 0
+
+            # The latest revision made by a human.
+            LATEST_HUMAN_REVIEW = 1
+
+            # The latest revision based on timestamp.
+            LATEST_TIMESTAMP = 2
+
+            # The first (OCR) revision.
+            BASE_OCR_REVISION = 3
+          end
+        end
       end
     end
   end

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

@@ -40,6 +40,9 @@ module Google
         # @!attribute [rw] raw_document
         #   @return [::Google::Cloud::DocumentAI::V1beta3::RawDocument]
         #     A raw document content (bytes).
+        # @!attribute [rw] gcs_document
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::GcsDocument]
+        #     A raw document on Google Cloud Storage.
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The resource name of the

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

@@ -41,6 +41,179 @@ module Google
           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]
@@ -67,6 +240,35 @@ module Google
           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

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

@@ -51,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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-document_ai-v1beta3
 version: !ruby/object:Gem::Version
-  version: 0.24.0
+  version: 0.25.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-20 00:00:00.000000000 Z
+date: 2023-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common