google-apis-documentai_v1beta3 0.76.0 → 0.77.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7462b42eb6d9add6819fe9d149417ee783cbe27fdcd9ad6e798b53ff6e6795b3
4
- data.tar.gz: b70b46b072f2232fe2a80b90b010fa032e4ef2028241472c331cc4c28bf27b76
3
+ metadata.gz: 4a1900e9e5c8b3ba3751f7f27610b396ad66cefff21b9da5cfadfb2ffa1429f4
4
+ data.tar.gz: 8054771adaf8469a4f633d3d97c8f8dbc9b9c9e13190677893b6f5c2df59a5fe
5
5
  SHA512:
6
- metadata.gz: 8cb6bdf776cdf7854c315973679c1e09d2bd69cd0aeaabe925d84d59726a7795a95e9ce3fe05cfc906984f79a62311ce00a9d1e3b7b05f0edc7107082a8929a3
7
- data.tar.gz: 9b7b07f82d71fbd5ab489a77a824bcbb34d37fe7c020da242a593b4e4644c0ec3dba34d48d331c98cf3aa17f66f2027e598d1cd9cf7de36e9bb62c642093def2
6
+ metadata.gz: a0f2cf6ad57a51d3ebd5a9fde38543b42757e972ace6a7f636de57540a0c6ee1fac8284d1c9737db81a588f2b74c33714cc95dd57f78a3539ed8ecd3606a1384
7
+ data.tar.gz: 7e835b39efe4a1aab7e444330ddd3b44c7da7a835046f80664fccaa18f263ef663f6b4c3342bddc752e8f336f75c3248cf3dcd958382a378953f69d7a896eba5
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-documentai_v1beta3
2
2
 
3
+ ### v0.77.0 (2023-07-16)
4
+
5
+ * Regenerated from discovery document revision 20230706
6
+
3
7
  ### v0.76.0 (2023-06-25)
4
8
 
5
9
  * Regenerated from discovery document revision 20230619
@@ -813,6 +813,11 @@ module Google
813
813
  # @return [String]
814
814
  attr_accessor :input_gcs_source
815
815
 
816
+ # Document Identifier.
817
+ # Corresponds to the JSON property `outputDocumentId`
818
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentId]
819
+ attr_accessor :output_document_id
820
+
816
821
  # The output_gcs_destination of the processed document if it was successful,
817
822
  # otherwise empty.
818
823
  # Corresponds to the JSON property `outputGcsDestination`
@@ -836,6 +841,7 @@ module Google
836
841
  # Update properties of this object
837
842
  def update!(**args)
838
843
  @input_gcs_source = args[:input_gcs_source] if args.key?(:input_gcs_source)
844
+ @output_document_id = args[:output_document_id] if args.key?(:output_document_id)
839
845
  @output_gcs_destination = args[:output_gcs_destination] if args.key?(:output_gcs_destination)
840
846
  @status = args[:status] if args.key?(:status)
841
847
  end
@@ -1060,6 +1066,26 @@ module Google
1060
1066
  class GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse
1061
1067
  include Google::Apis::Core::Hashable
1062
1068
 
1069
+ # The `Status` type defines a logical error model that is suitable for different
1070
+ # programming environments, including REST APIs and RPC APIs. It is used by [
1071
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
1072
+ # data: error code, error message, and error details. You can find out more
1073
+ # about this error model and how to work with it in the [API Design Guide](https:
1074
+ # //cloud.google.com/apis/design/errors).
1075
+ # Corresponds to the JSON property `sampleTestStatus`
1076
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleRpcStatus]
1077
+ attr_accessor :sample_test_status
1078
+
1079
+ # The `Status` type defines a logical error model that is suitable for different
1080
+ # programming environments, including REST APIs and RPC APIs. It is used by [
1081
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
1082
+ # data: error code, error message, and error details. You can find out more
1083
+ # about this error model and how to work with it in the [API Design Guide](https:
1084
+ # //cloud.google.com/apis/design/errors).
1085
+ # Corresponds to the JSON property `sampleTrainingStatus`
1086
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleRpcStatus]
1087
+ attr_accessor :sample_training_status
1088
+
1063
1089
  # The result of the sampling process.
1064
1090
  # Corresponds to the JSON property `selectedDocuments`
1065
1091
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument>]
@@ -1071,6 +1097,8 @@ module Google
1071
1097
 
1072
1098
  # Update properties of this object
1073
1099
  def update!(**args)
1100
+ @sample_test_status = args[:sample_test_status] if args.key?(:sample_test_status)
1101
+ @sample_training_status = args[:sample_training_status] if args.key?(:sample_training_status)
1074
1102
  @selected_documents = args[:selected_documents] if args.key?(:selected_documents)
1075
1103
  end
1076
1104
  end
@@ -6183,6 +6211,151 @@ module Google
6183
6211
  end
6184
6212
  end
6185
6213
 
6214
+ # Dataset documents that the batch operation will be applied to.
6215
+ class GoogleCloudDocumentaiV1beta3BatchDatasetDocuments
6216
+ include Google::Apis::Core::Hashable
6217
+
6218
+ # A filter matching the documents. Follows the same format and restriction as [
6219
+ # google.cloud.documentai.master.ListDocumentsRequest.filter].
6220
+ # Corresponds to the JSON property `filter`
6221
+ # @return [String]
6222
+ attr_accessor :filter
6223
+
6224
+ # List of individual DocumentIds.
6225
+ # Corresponds to the JSON property `individualDocumentIds`
6226
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDatasetDocumentsIndividualDocumentIds]
6227
+ attr_accessor :individual_document_ids
6228
+
6229
+ def initialize(**args)
6230
+ update!(**args)
6231
+ end
6232
+
6233
+ # Update properties of this object
6234
+ def update!(**args)
6235
+ @filter = args[:filter] if args.key?(:filter)
6236
+ @individual_document_ids = args[:individual_document_ids] if args.key?(:individual_document_ids)
6237
+ end
6238
+ end
6239
+
6240
+ # List of individual DocumentIds.
6241
+ class GoogleCloudDocumentaiV1beta3BatchDatasetDocumentsIndividualDocumentIds
6242
+ include Google::Apis::Core::Hashable
6243
+
6244
+ # Required. List of Document IDs indicating where the actual documents are
6245
+ # stored.
6246
+ # Corresponds to the JSON property `documentIds`
6247
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentId>]
6248
+ attr_accessor :document_ids
6249
+
6250
+ def initialize(**args)
6251
+ update!(**args)
6252
+ end
6253
+
6254
+ # Update properties of this object
6255
+ def update!(**args)
6256
+ @document_ids = args[:document_ids] if args.key?(:document_ids)
6257
+ end
6258
+ end
6259
+
6260
+ #
6261
+ class GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata
6262
+ include Google::Apis::Core::Hashable
6263
+
6264
+ # The common metadata for long running operations.
6265
+ # Corresponds to the JSON property `commonMetadata`
6266
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
6267
+ attr_accessor :common_metadata
6268
+
6269
+ # Total number of documents that failed to be deleted in storage.
6270
+ # Corresponds to the JSON property `errorDocumentCount`
6271
+ # @return [Fixnum]
6272
+ attr_accessor :error_document_count
6273
+
6274
+ # The list of response details of each document.
6275
+ # Corresponds to the JSON property `individualBatchDeleteStatuses`
6276
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus>]
6277
+ attr_accessor :individual_batch_delete_statuses
6278
+
6279
+ # Total number of documents deleting from dataset.
6280
+ # Corresponds to the JSON property `totalDocumentCount`
6281
+ # @return [Fixnum]
6282
+ attr_accessor :total_document_count
6283
+
6284
+ def initialize(**args)
6285
+ update!(**args)
6286
+ end
6287
+
6288
+ # Update properties of this object
6289
+ def update!(**args)
6290
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
6291
+ @error_document_count = args[:error_document_count] if args.key?(:error_document_count)
6292
+ @individual_batch_delete_statuses = args[:individual_batch_delete_statuses] if args.key?(:individual_batch_delete_statuses)
6293
+ @total_document_count = args[:total_document_count] if args.key?(:total_document_count)
6294
+ end
6295
+ end
6296
+
6297
+ # The status of each individual document in the batch delete process.
6298
+ class GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus
6299
+ include Google::Apis::Core::Hashable
6300
+
6301
+ # Document Identifier.
6302
+ # Corresponds to the JSON property `documentId`
6303
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentId]
6304
+ attr_accessor :document_id
6305
+
6306
+ # The `Status` type defines a logical error model that is suitable for different
6307
+ # programming environments, including REST APIs and RPC APIs. It is used by [
6308
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
6309
+ # data: error code, error message, and error details. You can find out more
6310
+ # about this error model and how to work with it in the [API Design Guide](https:
6311
+ # //cloud.google.com/apis/design/errors).
6312
+ # Corresponds to the JSON property `status`
6313
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleRpcStatus]
6314
+ attr_accessor :status
6315
+
6316
+ def initialize(**args)
6317
+ update!(**args)
6318
+ end
6319
+
6320
+ # Update properties of this object
6321
+ def update!(**args)
6322
+ @document_id = args[:document_id] if args.key?(:document_id)
6323
+ @status = args[:status] if args.key?(:status)
6324
+ end
6325
+ end
6326
+
6327
+ #
6328
+ class GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsRequest
6329
+ include Google::Apis::Core::Hashable
6330
+
6331
+ # Dataset documents that the batch operation will be applied to.
6332
+ # Corresponds to the JSON property `datasetDocuments`
6333
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDatasetDocuments]
6334
+ attr_accessor :dataset_documents
6335
+
6336
+ def initialize(**args)
6337
+ update!(**args)
6338
+ end
6339
+
6340
+ # Update properties of this object
6341
+ def update!(**args)
6342
+ @dataset_documents = args[:dataset_documents] if args.key?(:dataset_documents)
6343
+ end
6344
+ end
6345
+
6346
+ # Response of the delete documents operation.
6347
+ class GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse
6348
+ include Google::Apis::Core::Hashable
6349
+
6350
+ def initialize(**args)
6351
+ update!(**args)
6352
+ end
6353
+
6354
+ # Update properties of this object
6355
+ def update!(**args)
6356
+ end
6357
+ end
6358
+
6186
6359
  # The common config to specify a set of documents used as input.
6187
6360
  class GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig
6188
6361
  include Google::Apis::Core::Hashable
@@ -7083,6 +7256,85 @@ module Google
7083
7256
  end
7084
7257
  end
7085
7258
 
7259
+ # Document Identifier.
7260
+ class GoogleCloudDocumentaiV1beta3DocumentId
7261
+ include Google::Apis::Core::Hashable
7262
+
7263
+ # Identifies a document uniquely within the scope of a dataset in the user-
7264
+ # managed Cloud Storage option.
7265
+ # Corresponds to the JSON property `gcsManagedDocId`
7266
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentIdGcsManagedDocumentId]
7267
+ attr_accessor :gcs_managed_doc_id
7268
+
7269
+ # The revision reference specifies which revision on the document to read.
7270
+ # Corresponds to the JSON property `revisionRef`
7271
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3RevisionRef]
7272
+ attr_accessor :revision_ref
7273
+
7274
+ # Identifies a document uniquely within the scope of a dataset in unmanaged
7275
+ # option.
7276
+ # Corresponds to the JSON property `unmanagedDocId`
7277
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId]
7278
+ attr_accessor :unmanaged_doc_id
7279
+
7280
+ def initialize(**args)
7281
+ update!(**args)
7282
+ end
7283
+
7284
+ # Update properties of this object
7285
+ def update!(**args)
7286
+ @gcs_managed_doc_id = args[:gcs_managed_doc_id] if args.key?(:gcs_managed_doc_id)
7287
+ @revision_ref = args[:revision_ref] if args.key?(:revision_ref)
7288
+ @unmanaged_doc_id = args[:unmanaged_doc_id] if args.key?(:unmanaged_doc_id)
7289
+ end
7290
+ end
7291
+
7292
+ # Identifies a document uniquely within the scope of a dataset in the user-
7293
+ # managed Cloud Storage option.
7294
+ class GoogleCloudDocumentaiV1beta3DocumentIdGcsManagedDocumentId
7295
+ include Google::Apis::Core::Hashable
7296
+
7297
+ # Id of the document (indexed) managed by Content Warehouse.
7298
+ # Corresponds to the JSON property `cwDocId`
7299
+ # @return [String]
7300
+ attr_accessor :cw_doc_id
7301
+
7302
+ # Required. The Cloud Storage URI where the actual document is stored.
7303
+ # Corresponds to the JSON property `gcsUri`
7304
+ # @return [String]
7305
+ attr_accessor :gcs_uri
7306
+
7307
+ def initialize(**args)
7308
+ update!(**args)
7309
+ end
7310
+
7311
+ # Update properties of this object
7312
+ def update!(**args)
7313
+ @cw_doc_id = args[:cw_doc_id] if args.key?(:cw_doc_id)
7314
+ @gcs_uri = args[:gcs_uri] if args.key?(:gcs_uri)
7315
+ end
7316
+ end
7317
+
7318
+ # Identifies a document uniquely within the scope of a dataset in unmanaged
7319
+ # option.
7320
+ class GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId
7321
+ include Google::Apis::Core::Hashable
7322
+
7323
+ # Required. The id of the document.
7324
+ # Corresponds to the JSON property `docId`
7325
+ # @return [String]
7326
+ attr_accessor :doc_id
7327
+
7328
+ def initialize(**args)
7329
+ update!(**args)
7330
+ end
7331
+
7332
+ # Update properties of this object
7333
+ def update!(**args)
7334
+ @doc_id = args[:doc_id] if args.key?(:doc_id)
7335
+ end
7336
+ end
7337
+
7086
7338
  # Config that controls the output of documents. All documents will be written as
7087
7339
  # a JSON file.
7088
7340
  class GoogleCloudDocumentaiV1beta3DocumentOutputConfig
@@ -9346,6 +9598,28 @@ module Google
9346
9598
  end
9347
9599
  end
9348
9600
 
9601
+ #
9602
+ class GoogleCloudDocumentaiV1beta3GetDocumentResponse
9603
+ include Google::Apis::Core::Hashable
9604
+
9605
+ # Document represents the canonical document resource in Document AI. It is an
9606
+ # interchange format that provides insights into documents and allows for
9607
+ # collaboration between users and Document AI to iterate and optimize for
9608
+ # quality.
9609
+ # Corresponds to the JSON property `document`
9610
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document]
9611
+ attr_accessor :document
9612
+
9613
+ def initialize(**args)
9614
+ update!(**args)
9615
+ end
9616
+
9617
+ # Update properties of this object
9618
+ def update!(**args)
9619
+ @document = args[:document] if args.key?(:document)
9620
+ end
9621
+ end
9622
+
9349
9623
  # The status of human review on a processed document.
9350
9624
  class GoogleCloudDocumentaiV1beta3HumanReviewStatus
9351
9625
  include Google::Apis::Core::Hashable
@@ -9380,6 +9654,193 @@ module Google
9380
9654
  end
9381
9655
  end
9382
9656
 
9657
+ # Metadata of the import document operation.
9658
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata
9659
+ include Google::Apis::Core::Hashable
9660
+
9661
+ # The common metadata for long running operations.
9662
+ # Corresponds to the JSON property `commonMetadata`
9663
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
9664
+ attr_accessor :common_metadata
9665
+
9666
+ # Validation statuses of the batch documents import config.
9667
+ # Corresponds to the JSON property `importConfigValidationResults`
9668
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult>]
9669
+ attr_accessor :import_config_validation_results
9670
+
9671
+ # The list of response details of each document.
9672
+ # Corresponds to the JSON property `individualImportStatuses`
9673
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus>]
9674
+ attr_accessor :individual_import_statuses
9675
+
9676
+ # Total number of the documents that are qualified for importing.
9677
+ # Corresponds to the JSON property `totalDocumentCount`
9678
+ # @return [Fixnum]
9679
+ attr_accessor :total_document_count
9680
+
9681
+ def initialize(**args)
9682
+ update!(**args)
9683
+ end
9684
+
9685
+ # Update properties of this object
9686
+ def update!(**args)
9687
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
9688
+ @import_config_validation_results = args[:import_config_validation_results] if args.key?(:import_config_validation_results)
9689
+ @individual_import_statuses = args[:individual_import_statuses] if args.key?(:individual_import_statuses)
9690
+ @total_document_count = args[:total_document_count] if args.key?(:total_document_count)
9691
+ end
9692
+ end
9693
+
9694
+ # The validation status of each import config. Status is set to errors if there
9695
+ # is no documents to import in the import_config, or OK if the operation will
9696
+ # try to proceed at least one document.
9697
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult
9698
+ include Google::Apis::Core::Hashable
9699
+
9700
+ # The source Cloud Storage URI specified in the import config.
9701
+ # Corresponds to the JSON property `inputGcsSource`
9702
+ # @return [String]
9703
+ attr_accessor :input_gcs_source
9704
+
9705
+ # The `Status` type defines a logical error model that is suitable for different
9706
+ # programming environments, including REST APIs and RPC APIs. It is used by [
9707
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
9708
+ # data: error code, error message, and error details. You can find out more
9709
+ # about this error model and how to work with it in the [API Design Guide](https:
9710
+ # //cloud.google.com/apis/design/errors).
9711
+ # Corresponds to the JSON property `status`
9712
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleRpcStatus]
9713
+ attr_accessor :status
9714
+
9715
+ def initialize(**args)
9716
+ update!(**args)
9717
+ end
9718
+
9719
+ # Update properties of this object
9720
+ def update!(**args)
9721
+ @input_gcs_source = args[:input_gcs_source] if args.key?(:input_gcs_source)
9722
+ @status = args[:status] if args.key?(:status)
9723
+ end
9724
+ end
9725
+
9726
+ # The status of each individual document in the import process.
9727
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus
9728
+ include Google::Apis::Core::Hashable
9729
+
9730
+ # The source Cloud Storage URI of the document.
9731
+ # Corresponds to the JSON property `inputGcsSource`
9732
+ # @return [String]
9733
+ attr_accessor :input_gcs_source
9734
+
9735
+ # Document Identifier.
9736
+ # Corresponds to the JSON property `outputDocumentId`
9737
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentId]
9738
+ attr_accessor :output_document_id
9739
+
9740
+ # The `Status` type defines a logical error model that is suitable for different
9741
+ # programming environments, including REST APIs and RPC APIs. It is used by [
9742
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
9743
+ # data: error code, error message, and error details. You can find out more
9744
+ # about this error model and how to work with it in the [API Design Guide](https:
9745
+ # //cloud.google.com/apis/design/errors).
9746
+ # Corresponds to the JSON property `status`
9747
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleRpcStatus]
9748
+ attr_accessor :status
9749
+
9750
+ def initialize(**args)
9751
+ update!(**args)
9752
+ end
9753
+
9754
+ # Update properties of this object
9755
+ def update!(**args)
9756
+ @input_gcs_source = args[:input_gcs_source] if args.key?(:input_gcs_source)
9757
+ @output_document_id = args[:output_document_id] if args.key?(:output_document_id)
9758
+ @status = args[:status] if args.key?(:status)
9759
+ end
9760
+ end
9761
+
9762
+ #
9763
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsRequest
9764
+ include Google::Apis::Core::Hashable
9765
+
9766
+ # Required. The Cloud Storage uri containing raw documents that must be imported.
9767
+ # Corresponds to the JSON property `batchDocumentsImportConfigs`
9768
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfig>]
9769
+ attr_accessor :batch_documents_import_configs
9770
+
9771
+ def initialize(**args)
9772
+ update!(**args)
9773
+ end
9774
+
9775
+ # Update properties of this object
9776
+ def update!(**args)
9777
+ @batch_documents_import_configs = args[:batch_documents_import_configs] if args.key?(:batch_documents_import_configs)
9778
+ end
9779
+ end
9780
+
9781
+ # Config for importing documents. Each batch can have its own dataset split type.
9782
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfig
9783
+ include Google::Apis::Core::Hashable
9784
+
9785
+ # The config for auto-split.
9786
+ # Corresponds to the JSON property `autoSplitConfig`
9787
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfigAutoSplitConfig]
9788
+ attr_accessor :auto_split_config
9789
+
9790
+ # The common config to specify a set of documents used as input.
9791
+ # Corresponds to the JSON property `batchInputConfig`
9792
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig]
9793
+ attr_accessor :batch_input_config
9794
+
9795
+ # Target dataset split where the documents must be stored.
9796
+ # Corresponds to the JSON property `datasetSplit`
9797
+ # @return [String]
9798
+ attr_accessor :dataset_split
9799
+
9800
+ def initialize(**args)
9801
+ update!(**args)
9802
+ end
9803
+
9804
+ # Update properties of this object
9805
+ def update!(**args)
9806
+ @auto_split_config = args[:auto_split_config] if args.key?(:auto_split_config)
9807
+ @batch_input_config = args[:batch_input_config] if args.key?(:batch_input_config)
9808
+ @dataset_split = args[:dataset_split] if args.key?(:dataset_split)
9809
+ end
9810
+ end
9811
+
9812
+ # The config for auto-split.
9813
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfigAutoSplitConfig
9814
+ include Google::Apis::Core::Hashable
9815
+
9816
+ # Ratio of training dataset split.
9817
+ # Corresponds to the JSON property `trainingSplitRatio`
9818
+ # @return [Float]
9819
+ attr_accessor :training_split_ratio
9820
+
9821
+ def initialize(**args)
9822
+ update!(**args)
9823
+ end
9824
+
9825
+ # Update properties of this object
9826
+ def update!(**args)
9827
+ @training_split_ratio = args[:training_split_ratio] if args.key?(:training_split_ratio)
9828
+ end
9829
+ end
9830
+
9831
+ # Response of the import document operation.
9832
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsResponse
9833
+ include Google::Apis::Core::Hashable
9834
+
9835
+ def initialize(**args)
9836
+ update!(**args)
9837
+ end
9838
+
9839
+ # Update properties of this object
9840
+ def update!(**args)
9841
+ end
9842
+ end
9843
+
9383
9844
  # The long-running operation metadata for the ImportProcessorVersion method.
9384
9845
  class GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata
9385
9846
  include Google::Apis::Core::Hashable
@@ -9693,6 +10154,11 @@ module Google
9693
10154
  # @return [String]
9694
10155
  attr_accessor :field_mask
9695
10156
 
10157
+ # Specifies a document stored on Cloud Storage.
10158
+ # Corresponds to the JSON property `gcsDocument`
10159
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GcsDocument]
10160
+ attr_accessor :gcs_document
10161
+
9696
10162
  # Document represents the canonical document resource in Document AI. It is an
9697
10163
  # interchange format that provides insights into documents and allows for
9698
10164
  # collaboration between users and Document AI to iterate and optimize for
@@ -9725,6 +10191,7 @@ module Google
9725
10191
  def update!(**args)
9726
10192
  @document = args[:document] if args.key?(:document)
9727
10193
  @field_mask = args[:field_mask] if args.key?(:field_mask)
10194
+ @gcs_document = args[:gcs_document] if args.key?(:gcs_document)
9728
10195
  @inline_document = args[:inline_document] if args.key?(:inline_document)
9729
10196
  @process_options = args[:process_options] if args.key?(:process_options)
9730
10197
  @raw_document = args[:raw_document] if args.key?(:raw_document)
@@ -10195,6 +10662,39 @@ module Google
10195
10662
  end
10196
10663
  end
10197
10664
 
10665
+ # The revision reference specifies which revision on the document to read.
10666
+ class GoogleCloudDocumentaiV1beta3RevisionRef
10667
+ include Google::Apis::Core::Hashable
10668
+
10669
+ # Reads the revision generated by the processor version. The format takes the
10670
+ # full resource name of processor version. `projects/`project`/locations/`
10671
+ # location`/processors/`processor`/processorVersions/`processorVersion``
10672
+ # Corresponds to the JSON property `latestProcessorVersion`
10673
+ # @return [String]
10674
+ attr_accessor :latest_processor_version
10675
+
10676
+ # Reads the revision by the predefined case.
10677
+ # Corresponds to the JSON property `revisionCase`
10678
+ # @return [String]
10679
+ attr_accessor :revision_case
10680
+
10681
+ # Reads the revision given by the id.
10682
+ # Corresponds to the JSON property `revisionId`
10683
+ # @return [String]
10684
+ attr_accessor :revision_id
10685
+
10686
+ def initialize(**args)
10687
+ update!(**args)
10688
+ end
10689
+
10690
+ # Update properties of this object
10691
+ def update!(**args)
10692
+ @latest_processor_version = args[:latest_processor_version] if args.key?(:latest_processor_version)
10693
+ @revision_case = args[:revision_case] if args.key?(:revision_case)
10694
+ @revision_id = args[:revision_id] if args.key?(:revision_id)
10695
+ end
10696
+ end
10697
+
10198
10698
  # The long-running operation metadata for the SetDefaultProcessorVersion method.
10199
10699
  class GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata
10200
10700
  include Google::Apis::Core::Hashable
@@ -10480,6 +10980,25 @@ module Google
10480
10980
  end
10481
10981
  end
10482
10982
 
10983
+ #
10984
+ class GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata
10985
+ include Google::Apis::Core::Hashable
10986
+
10987
+ # The common metadata for long running operations.
10988
+ # Corresponds to the JSON property `commonMetadata`
10989
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
10990
+ attr_accessor :common_metadata
10991
+
10992
+ def initialize(**args)
10993
+ update!(**args)
10994
+ end
10995
+
10996
+ # Update properties of this object
10997
+ def update!(**args)
10998
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
10999
+ end
11000
+ end
11001
+
10483
11002
  # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are
10484
11003
  # in the same scale as the original image.
10485
11004
  class GoogleCloudDocumentaiV1beta3Vertex
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DocumentaiV1beta3
18
18
  # Version of the google-apis-documentai_v1beta3 gem
19
- GEM_VERSION = "0.76.0"
19
+ GEM_VERSION = "0.77.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.12.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20230619"
25
+ REVISION = "20230706"
26
26
  end
27
27
  end
28
28
  end
@@ -1084,6 +1084,42 @@ module Google
1084
1084
  include Google::Apis::Core::JsonObjectSupport
1085
1085
  end
1086
1086
 
1087
+ class GoogleCloudDocumentaiV1beta3BatchDatasetDocuments
1088
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1089
+
1090
+ include Google::Apis::Core::JsonObjectSupport
1091
+ end
1092
+
1093
+ class GoogleCloudDocumentaiV1beta3BatchDatasetDocumentsIndividualDocumentIds
1094
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1095
+
1096
+ include Google::Apis::Core::JsonObjectSupport
1097
+ end
1098
+
1099
+ class GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata
1100
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1101
+
1102
+ include Google::Apis::Core::JsonObjectSupport
1103
+ end
1104
+
1105
+ class GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus
1106
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1107
+
1108
+ include Google::Apis::Core::JsonObjectSupport
1109
+ end
1110
+
1111
+ class GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsRequest
1112
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1113
+
1114
+ include Google::Apis::Core::JsonObjectSupport
1115
+ end
1116
+
1117
+ class GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse
1118
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1119
+
1120
+ include Google::Apis::Core::JsonObjectSupport
1121
+ end
1122
+
1087
1123
  class GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig
1088
1124
  class Representation < Google::Apis::Core::JsonRepresentation; end
1089
1125
 
@@ -1246,6 +1282,24 @@ module Google
1246
1282
  include Google::Apis::Core::JsonObjectSupport
1247
1283
  end
1248
1284
 
1285
+ class GoogleCloudDocumentaiV1beta3DocumentId
1286
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1287
+
1288
+ include Google::Apis::Core::JsonObjectSupport
1289
+ end
1290
+
1291
+ class GoogleCloudDocumentaiV1beta3DocumentIdGcsManagedDocumentId
1292
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1293
+
1294
+ include Google::Apis::Core::JsonObjectSupport
1295
+ end
1296
+
1297
+ class GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId
1298
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1299
+
1300
+ include Google::Apis::Core::JsonObjectSupport
1301
+ end
1302
+
1249
1303
  class GoogleCloudDocumentaiV1beta3DocumentOutputConfig
1250
1304
  class Representation < Google::Apis::Core::JsonRepresentation; end
1251
1305
 
@@ -1594,12 +1648,60 @@ module Google
1594
1648
  include Google::Apis::Core::JsonObjectSupport
1595
1649
  end
1596
1650
 
1651
+ class GoogleCloudDocumentaiV1beta3GetDocumentResponse
1652
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1653
+
1654
+ include Google::Apis::Core::JsonObjectSupport
1655
+ end
1656
+
1597
1657
  class GoogleCloudDocumentaiV1beta3HumanReviewStatus
1598
1658
  class Representation < Google::Apis::Core::JsonRepresentation; end
1599
1659
 
1600
1660
  include Google::Apis::Core::JsonObjectSupport
1601
1661
  end
1602
1662
 
1663
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata
1664
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1665
+
1666
+ include Google::Apis::Core::JsonObjectSupport
1667
+ end
1668
+
1669
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult
1670
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1671
+
1672
+ include Google::Apis::Core::JsonObjectSupport
1673
+ end
1674
+
1675
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus
1676
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1677
+
1678
+ include Google::Apis::Core::JsonObjectSupport
1679
+ end
1680
+
1681
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsRequest
1682
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1683
+
1684
+ include Google::Apis::Core::JsonObjectSupport
1685
+ end
1686
+
1687
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfig
1688
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1689
+
1690
+ include Google::Apis::Core::JsonObjectSupport
1691
+ end
1692
+
1693
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfigAutoSplitConfig
1694
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1695
+
1696
+ include Google::Apis::Core::JsonObjectSupport
1697
+ end
1698
+
1699
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsResponse
1700
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1701
+
1702
+ include Google::Apis::Core::JsonObjectSupport
1703
+ end
1704
+
1603
1705
  class GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata
1604
1706
  class Representation < Google::Apis::Core::JsonRepresentation; end
1605
1707
 
@@ -1738,6 +1840,12 @@ module Google
1738
1840
  include Google::Apis::Core::JsonObjectSupport
1739
1841
  end
1740
1842
 
1843
+ class GoogleCloudDocumentaiV1beta3RevisionRef
1844
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1845
+
1846
+ include Google::Apis::Core::JsonObjectSupport
1847
+ end
1848
+
1741
1849
  class GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata
1742
1850
  class Representation < Google::Apis::Core::JsonRepresentation; end
1743
1851
 
@@ -1810,6 +1918,12 @@ module Google
1810
1918
  include Google::Apis::Core::JsonObjectSupport
1811
1919
  end
1812
1920
 
1921
+ class GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata
1922
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1923
+
1924
+ include Google::Apis::Core::JsonObjectSupport
1925
+ end
1926
+
1813
1927
  class GoogleCloudDocumentaiV1beta3Vertex
1814
1928
  class Representation < Google::Apis::Core::JsonRepresentation; end
1815
1929
 
@@ -2175,6 +2289,8 @@ module Google
2175
2289
  # @private
2176
2290
  class Representation < Google::Apis::Core::JsonRepresentation
2177
2291
  property :input_gcs_source, as: 'inputGcsSource'
2292
+ property :output_document_id, as: 'outputDocumentId', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentId, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentId::Representation
2293
+
2178
2294
  property :output_gcs_destination, as: 'outputGcsDestination'
2179
2295
  property :status, as: 'status', class: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus::Representation
2180
2296
 
@@ -2260,6 +2376,10 @@ module Google
2260
2376
  class GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse
2261
2377
  # @private
2262
2378
  class Representation < Google::Apis::Core::JsonRepresentation
2379
+ property :sample_test_status, as: 'sampleTestStatus', class: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus::Representation
2380
+
2381
+ property :sample_training_status, as: 'sampleTrainingStatus', class: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus::Representation
2382
+
2263
2383
  collection :selected_documents, as: 'selectedDocuments', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument::Representation
2264
2384
 
2265
2385
  end
@@ -3712,6 +3832,59 @@ module Google
3712
3832
  end
3713
3833
  end
3714
3834
 
3835
+ class GoogleCloudDocumentaiV1beta3BatchDatasetDocuments
3836
+ # @private
3837
+ class Representation < Google::Apis::Core::JsonRepresentation
3838
+ property :filter, as: 'filter'
3839
+ property :individual_document_ids, as: 'individualDocumentIds', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDatasetDocumentsIndividualDocumentIds, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDatasetDocumentsIndividualDocumentIds::Representation
3840
+
3841
+ end
3842
+ end
3843
+
3844
+ class GoogleCloudDocumentaiV1beta3BatchDatasetDocumentsIndividualDocumentIds
3845
+ # @private
3846
+ class Representation < Google::Apis::Core::JsonRepresentation
3847
+ collection :document_ids, as: 'documentIds', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentId, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentId::Representation
3848
+
3849
+ end
3850
+ end
3851
+
3852
+ class GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata
3853
+ # @private
3854
+ class Representation < Google::Apis::Core::JsonRepresentation
3855
+ property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata::Representation
3856
+
3857
+ property :error_document_count, as: 'errorDocumentCount'
3858
+ collection :individual_batch_delete_statuses, as: 'individualBatchDeleteStatuses', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus::Representation
3859
+
3860
+ property :total_document_count, as: 'totalDocumentCount'
3861
+ end
3862
+ end
3863
+
3864
+ class GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus
3865
+ # @private
3866
+ class Representation < Google::Apis::Core::JsonRepresentation
3867
+ property :document_id, as: 'documentId', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentId, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentId::Representation
3868
+
3869
+ property :status, as: 'status', class: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus::Representation
3870
+
3871
+ end
3872
+ end
3873
+
3874
+ class GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsRequest
3875
+ # @private
3876
+ class Representation < Google::Apis::Core::JsonRepresentation
3877
+ property :dataset_documents, as: 'datasetDocuments', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDatasetDocuments, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDatasetDocuments::Representation
3878
+
3879
+ end
3880
+ end
3881
+
3882
+ class GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse
3883
+ # @private
3884
+ class Representation < Google::Apis::Core::JsonRepresentation
3885
+ end
3886
+ end
3887
+
3715
3888
  class GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig
3716
3889
  # @private
3717
3890
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3990,6 +4163,33 @@ module Google
3990
4163
  end
3991
4164
  end
3992
4165
 
4166
+ class GoogleCloudDocumentaiV1beta3DocumentId
4167
+ # @private
4168
+ class Representation < Google::Apis::Core::JsonRepresentation
4169
+ property :gcs_managed_doc_id, as: 'gcsManagedDocId', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentIdGcsManagedDocumentId, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentIdGcsManagedDocumentId::Representation
4170
+
4171
+ property :revision_ref, as: 'revisionRef', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3RevisionRef, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3RevisionRef::Representation
4172
+
4173
+ property :unmanaged_doc_id, as: 'unmanagedDocId', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId::Representation
4174
+
4175
+ end
4176
+ end
4177
+
4178
+ class GoogleCloudDocumentaiV1beta3DocumentIdGcsManagedDocumentId
4179
+ # @private
4180
+ class Representation < Google::Apis::Core::JsonRepresentation
4181
+ property :cw_doc_id, as: 'cwDocId'
4182
+ property :gcs_uri, as: 'gcsUri'
4183
+ end
4184
+ end
4185
+
4186
+ class GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId
4187
+ # @private
4188
+ class Representation < Google::Apis::Core::JsonRepresentation
4189
+ property :doc_id, as: 'docId'
4190
+ end
4191
+ end
4192
+
3993
4193
  class GoogleCloudDocumentaiV1beta3DocumentOutputConfig
3994
4194
  # @private
3995
4195
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -4629,6 +4829,14 @@ module Google
4629
4829
  end
4630
4830
  end
4631
4831
 
4832
+ class GoogleCloudDocumentaiV1beta3GetDocumentResponse
4833
+ # @private
4834
+ class Representation < Google::Apis::Core::JsonRepresentation
4835
+ property :document, as: 'document', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document::Representation
4836
+
4837
+ end
4838
+ end
4839
+
4632
4840
  class GoogleCloudDocumentaiV1beta3HumanReviewStatus
4633
4841
  # @private
4634
4842
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -4638,6 +4846,71 @@ module Google
4638
4846
  end
4639
4847
  end
4640
4848
 
4849
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata
4850
+ # @private
4851
+ class Representation < Google::Apis::Core::JsonRepresentation
4852
+ property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata::Representation
4853
+
4854
+ collection :import_config_validation_results, as: 'importConfigValidationResults', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult::Representation
4855
+
4856
+ collection :individual_import_statuses, as: 'individualImportStatuses', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus::Representation
4857
+
4858
+ property :total_document_count, as: 'totalDocumentCount'
4859
+ end
4860
+ end
4861
+
4862
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult
4863
+ # @private
4864
+ class Representation < Google::Apis::Core::JsonRepresentation
4865
+ property :input_gcs_source, as: 'inputGcsSource'
4866
+ property :status, as: 'status', class: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus::Representation
4867
+
4868
+ end
4869
+ end
4870
+
4871
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus
4872
+ # @private
4873
+ class Representation < Google::Apis::Core::JsonRepresentation
4874
+ property :input_gcs_source, as: 'inputGcsSource'
4875
+ property :output_document_id, as: 'outputDocumentId', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentId, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentId::Representation
4876
+
4877
+ property :status, as: 'status', class: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus::Representation
4878
+
4879
+ end
4880
+ end
4881
+
4882
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsRequest
4883
+ # @private
4884
+ class Representation < Google::Apis::Core::JsonRepresentation
4885
+ collection :batch_documents_import_configs, as: 'batchDocumentsImportConfigs', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfig, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfig::Representation
4886
+
4887
+ end
4888
+ end
4889
+
4890
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfig
4891
+ # @private
4892
+ class Representation < Google::Apis::Core::JsonRepresentation
4893
+ property :auto_split_config, as: 'autoSplitConfig', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfigAutoSplitConfig, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfigAutoSplitConfig::Representation
4894
+
4895
+ property :batch_input_config, as: 'batchInputConfig', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig::Representation
4896
+
4897
+ property :dataset_split, as: 'datasetSplit'
4898
+ end
4899
+ end
4900
+
4901
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfigAutoSplitConfig
4902
+ # @private
4903
+ class Representation < Google::Apis::Core::JsonRepresentation
4904
+ property :training_split_ratio, as: 'trainingSplitRatio'
4905
+ end
4906
+ end
4907
+
4908
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsResponse
4909
+ # @private
4910
+ class Representation < Google::Apis::Core::JsonRepresentation
4911
+ end
4912
+ end
4913
+
4641
4914
  class GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata
4642
4915
  # @private
4643
4916
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -4738,6 +5011,8 @@ module Google
4738
5011
  property :document, as: 'document', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document::Representation
4739
5012
 
4740
5013
  property :field_mask, as: 'fieldMask'
5014
+ property :gcs_document, as: 'gcsDocument', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GcsDocument, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GcsDocument::Representation
5015
+
4741
5016
  property :inline_document, as: 'inlineDocument', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document::Representation
4742
5017
 
4743
5018
  property :process_options, as: 'processOptions', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessOptions, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessOptions::Representation
@@ -4872,6 +5147,15 @@ module Google
4872
5147
  end
4873
5148
  end
4874
5149
 
5150
+ class GoogleCloudDocumentaiV1beta3RevisionRef
5151
+ # @private
5152
+ class Representation < Google::Apis::Core::JsonRepresentation
5153
+ property :latest_processor_version, as: 'latestProcessorVersion'
5154
+ property :revision_case, as: 'revisionCase'
5155
+ property :revision_id, as: 'revisionId'
5156
+ end
5157
+ end
5158
+
4875
5159
  class GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata
4876
5160
  # @private
4877
5161
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -4976,6 +5260,14 @@ module Google
4976
5260
  end
4977
5261
  end
4978
5262
 
5263
+ class GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata
5264
+ # @private
5265
+ class Representation < Google::Apis::Core::JsonRepresentation
5266
+ property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata::Representation
5267
+
5268
+ end
5269
+ end
5270
+
4979
5271
  class GoogleCloudDocumentaiV1beta3Vertex
4980
5272
  # @private
4981
5273
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -680,6 +680,40 @@ module Google
680
680
  execute_or_queue_command(command, &block)
681
681
  end
682
682
 
683
+ # Deletes a set of documents.
684
+ # @param [String] dataset
685
+ # Required. The dataset resource name. Format: projects/`project`/locations/`
686
+ # location`/processors/`processor`/dataset
687
+ # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsRequest] google_cloud_documentai_v1beta3_batch_delete_documents_request_object
688
+ # @param [String] fields
689
+ # Selector specifying which fields to include in a partial response.
690
+ # @param [String] quota_user
691
+ # Available to use for quota purposes for server-side applications. Can be any
692
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
693
+ # @param [Google::Apis::RequestOptions] options
694
+ # Request-specific options
695
+ #
696
+ # @yield [result, err] Result & error if block supplied
697
+ # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation] parsed result object
698
+ # @yieldparam err [StandardError] error object if request failed
699
+ #
700
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation]
701
+ #
702
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
703
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
704
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
705
+ def batch_project_location_processor_dataset_delete_documents(dataset, google_cloud_documentai_v1beta3_batch_delete_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
706
+ command = make_simple_command(:post, 'v1beta3/{+dataset}:batchDeleteDocuments', options)
707
+ command.request_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsRequest::Representation
708
+ command.request_object = google_cloud_documentai_v1beta3_batch_delete_documents_request_object
709
+ command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation::Representation
710
+ command.response_class = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation
711
+ command.params['dataset'] = dataset unless dataset.nil?
712
+ command.query['fields'] = fields unless fields.nil?
713
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
714
+ execute_or_queue_command(command, &block)
715
+ end
716
+
683
717
  # Gets the `DatasetSchema` of a `Dataset`.
684
718
  # @param [String] name
685
719
  # Required. The dataset schema resource name. Format: projects/`project`/
@@ -714,6 +748,101 @@ module Google
714
748
  execute_or_queue_command(command, &block)
715
749
  end
716
750
 
751
+ # Returns relevant fields present in the requested document.
752
+ # @param [String] dataset
753
+ # Required. The resource name of the dataset that the document belongs to .
754
+ # Format: projects/`project`/locations/`location`/processors/`processor`/dataset
755
+ # @param [String] document_id_gcs_managed_doc_id_cw_doc_id
756
+ # Id of the document (indexed) managed by Content Warehouse.
757
+ # @param [String] document_id_gcs_managed_doc_id_gcs_uri
758
+ # Required. The Cloud Storage URI where the actual document is stored.
759
+ # @param [String] document_id_revision_ref_latest_processor_version
760
+ # Reads the revision generated by the processor version. The format takes the
761
+ # full resource name of processor version. `projects/`project`/locations/`
762
+ # location`/processors/`processor`/processorVersions/`processorVersion``
763
+ # @param [String] document_id_revision_ref_revision_case
764
+ # Reads the revision by the predefined case.
765
+ # @param [String] document_id_revision_ref_revision_id
766
+ # Reads the revision given by the id.
767
+ # @param [String] document_id_unmanaged_doc_id_doc_id
768
+ # Required. The id of the document.
769
+ # @param [Fixnum] page_range_end
770
+ # Last page number (one-based index) to be returned.
771
+ # @param [Fixnum] page_range_start
772
+ # First page number (one-based index) to be returned.
773
+ # @param [String] read_mask
774
+ # If set, only fields listed here will be returned. Otherwise, all fields will
775
+ # be returned by default.
776
+ # @param [String] fields
777
+ # Selector specifying which fields to include in a partial response.
778
+ # @param [String] quota_user
779
+ # Available to use for quota purposes for server-side applications. Can be any
780
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
781
+ # @param [Google::Apis::RequestOptions] options
782
+ # Request-specific options
783
+ #
784
+ # @yield [result, err] Result & error if block supplied
785
+ # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GetDocumentResponse] parsed result object
786
+ # @yieldparam err [StandardError] error object if request failed
787
+ #
788
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GetDocumentResponse]
789
+ #
790
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
791
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
792
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
793
+ def get_project_location_processor_dataset_document(dataset, document_id_gcs_managed_doc_id_cw_doc_id: nil, document_id_gcs_managed_doc_id_gcs_uri: nil, document_id_revision_ref_latest_processor_version: nil, document_id_revision_ref_revision_case: nil, document_id_revision_ref_revision_id: nil, document_id_unmanaged_doc_id_doc_id: nil, page_range_end: nil, page_range_start: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
794
+ command = make_simple_command(:get, 'v1beta3/{+dataset}:getDocument', options)
795
+ command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GetDocumentResponse::Representation
796
+ command.response_class = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GetDocumentResponse
797
+ command.params['dataset'] = dataset unless dataset.nil?
798
+ command.query['documentId.gcsManagedDocId.cwDocId'] = document_id_gcs_managed_doc_id_cw_doc_id unless document_id_gcs_managed_doc_id_cw_doc_id.nil?
799
+ command.query['documentId.gcsManagedDocId.gcsUri'] = document_id_gcs_managed_doc_id_gcs_uri unless document_id_gcs_managed_doc_id_gcs_uri.nil?
800
+ command.query['documentId.revisionRef.latestProcessorVersion'] = document_id_revision_ref_latest_processor_version unless document_id_revision_ref_latest_processor_version.nil?
801
+ command.query['documentId.revisionRef.revisionCase'] = document_id_revision_ref_revision_case unless document_id_revision_ref_revision_case.nil?
802
+ command.query['documentId.revisionRef.revisionId'] = document_id_revision_ref_revision_id unless document_id_revision_ref_revision_id.nil?
803
+ command.query['documentId.unmanagedDocId.docId'] = document_id_unmanaged_doc_id_doc_id unless document_id_unmanaged_doc_id_doc_id.nil?
804
+ command.query['pageRange.end'] = page_range_end unless page_range_end.nil?
805
+ command.query['pageRange.start'] = page_range_start unless page_range_start.nil?
806
+ command.query['readMask'] = read_mask unless read_mask.nil?
807
+ command.query['fields'] = fields unless fields.nil?
808
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
809
+ execute_or_queue_command(command, &block)
810
+ end
811
+
812
+ # Import documents into a dataset.
813
+ # @param [String] dataset
814
+ # Required. The dataset resource name. Format: projects/`project`/locations/`
815
+ # location`/processors/`processor`/dataset
816
+ # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ImportDocumentsRequest] google_cloud_documentai_v1beta3_import_documents_request_object
817
+ # @param [String] fields
818
+ # Selector specifying which fields to include in a partial response.
819
+ # @param [String] quota_user
820
+ # Available to use for quota purposes for server-side applications. Can be any
821
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
822
+ # @param [Google::Apis::RequestOptions] options
823
+ # Request-specific options
824
+ #
825
+ # @yield [result, err] Result & error if block supplied
826
+ # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation] parsed result object
827
+ # @yieldparam err [StandardError] error object if request failed
828
+ #
829
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation]
830
+ #
831
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
832
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
833
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
834
+ def import_project_location_processor_dataset_documents(dataset, google_cloud_documentai_v1beta3_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
835
+ command = make_simple_command(:post, 'v1beta3/{+dataset}:importDocuments', options)
836
+ command.request_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ImportDocumentsRequest::Representation
837
+ command.request_object = google_cloud_documentai_v1beta3_import_documents_request_object
838
+ command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation::Representation
839
+ command.response_class = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation
840
+ command.params['dataset'] = dataset unless dataset.nil?
841
+ command.query['fields'] = fields unless fields.nil?
842
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
843
+ execute_or_queue_command(command, &block)
844
+ end
845
+
717
846
  # Updates a `DatasetSchema`.
718
847
  # @param [String] name
719
848
  # Dataset schema resource name. Format: `projects/`project`/locations/`location`/
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-documentai_v1beta3
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.76.0
4
+ version: 0.77.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-06-25 00:00:00.000000000 Z
11
+ date: 2023-07-16 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-documentai_v1beta3/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1beta3/v0.76.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1beta3/v0.77.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-documentai_v1beta3
63
63
  post_install_message:
64
64
  rdoc_options: []