google-apis-documentai_v1beta3 0.76.0 → 0.78.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: f2feb1428413253c80ba6c3b428a66cac71aa501ed16da7295b8cd64564e0f2d
4
+ data.tar.gz: 4c750aa253a764085e9395ce9f406d4e52758aeffcdaa5331dea05be6d9aabcf
5
5
  SHA512:
6
- metadata.gz: 8cb6bdf776cdf7854c315973679c1e09d2bd69cd0aeaabe925d84d59726a7795a95e9ce3fe05cfc906984f79a62311ce00a9d1e3b7b05f0edc7107082a8929a3
7
- data.tar.gz: 9b7b07f82d71fbd5ab489a77a824bcbb34d37fe7c020da242a593b4e4644c0ec3dba34d48d331c98cf3aa17f66f2027e598d1cd9cf7de36e9bb62c642093def2
6
+ metadata.gz: e7c59fb50cb84eb8540668ce57b434f1eb1b8d359a96a116957a943b04ba13fa9445d31fa09db785ec838a4d8e82b9750e9d57adc0f8ea255abc69f38b56993f
7
+ data.tar.gz: d623e16eef23c03962b9c00e1b63e6f8b4caf46ed1c9167b3bb15126fe28f7af3691540fada859252c2d2b33d237b2245439987210c141d69ece8da04700aa09
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-documentai_v1beta3
2
2
 
3
+ ### v0.78.0 (2023-07-23)
4
+
5
+ * Regenerated from discovery document revision 20230719
6
+
7
+ ### v0.77.0 (2023-07-16)
8
+
9
+ * Regenerated from discovery document revision 20230706
10
+
3
11
  ### v0.76.0 (2023-06-25)
4
12
 
5
13
  * 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
@@ -6197,6 +6370,11 @@ module Google
6197
6370
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GcsPrefix]
6198
6371
  attr_accessor :gcs_prefix
6199
6372
 
6373
+ # Specifies a set of raw documents.
6374
+ # Corresponds to the JSON property `rawDocuments`
6375
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3RawDocuments]
6376
+ attr_accessor :raw_documents
6377
+
6200
6378
  def initialize(**args)
6201
6379
  update!(**args)
6202
6380
  end
@@ -6205,6 +6383,7 @@ module Google
6205
6383
  def update!(**args)
6206
6384
  @gcs_documents = args[:gcs_documents] if args.key?(:gcs_documents)
6207
6385
  @gcs_prefix = args[:gcs_prefix] if args.key?(:gcs_prefix)
6386
+ @raw_documents = args[:raw_documents] if args.key?(:raw_documents)
6208
6387
  end
6209
6388
  end
6210
6389
 
@@ -7083,6 +7262,85 @@ module Google
7083
7262
  end
7084
7263
  end
7085
7264
 
7265
+ # Document Identifier.
7266
+ class GoogleCloudDocumentaiV1beta3DocumentId
7267
+ include Google::Apis::Core::Hashable
7268
+
7269
+ # Identifies a document uniquely within the scope of a dataset in the user-
7270
+ # managed Cloud Storage option.
7271
+ # Corresponds to the JSON property `gcsManagedDocId`
7272
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentIdGcsManagedDocumentId]
7273
+ attr_accessor :gcs_managed_doc_id
7274
+
7275
+ # The revision reference specifies which revision on the document to read.
7276
+ # Corresponds to the JSON property `revisionRef`
7277
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3RevisionRef]
7278
+ attr_accessor :revision_ref
7279
+
7280
+ # Identifies a document uniquely within the scope of a dataset in unmanaged
7281
+ # option.
7282
+ # Corresponds to the JSON property `unmanagedDocId`
7283
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId]
7284
+ attr_accessor :unmanaged_doc_id
7285
+
7286
+ def initialize(**args)
7287
+ update!(**args)
7288
+ end
7289
+
7290
+ # Update properties of this object
7291
+ def update!(**args)
7292
+ @gcs_managed_doc_id = args[:gcs_managed_doc_id] if args.key?(:gcs_managed_doc_id)
7293
+ @revision_ref = args[:revision_ref] if args.key?(:revision_ref)
7294
+ @unmanaged_doc_id = args[:unmanaged_doc_id] if args.key?(:unmanaged_doc_id)
7295
+ end
7296
+ end
7297
+
7298
+ # Identifies a document uniquely within the scope of a dataset in the user-
7299
+ # managed Cloud Storage option.
7300
+ class GoogleCloudDocumentaiV1beta3DocumentIdGcsManagedDocumentId
7301
+ include Google::Apis::Core::Hashable
7302
+
7303
+ # Id of the document (indexed) managed by Content Warehouse.
7304
+ # Corresponds to the JSON property `cwDocId`
7305
+ # @return [String]
7306
+ attr_accessor :cw_doc_id
7307
+
7308
+ # Required. The Cloud Storage URI where the actual document is stored.
7309
+ # Corresponds to the JSON property `gcsUri`
7310
+ # @return [String]
7311
+ attr_accessor :gcs_uri
7312
+
7313
+ def initialize(**args)
7314
+ update!(**args)
7315
+ end
7316
+
7317
+ # Update properties of this object
7318
+ def update!(**args)
7319
+ @cw_doc_id = args[:cw_doc_id] if args.key?(:cw_doc_id)
7320
+ @gcs_uri = args[:gcs_uri] if args.key?(:gcs_uri)
7321
+ end
7322
+ end
7323
+
7324
+ # Identifies a document uniquely within the scope of a dataset in unmanaged
7325
+ # option.
7326
+ class GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId
7327
+ include Google::Apis::Core::Hashable
7328
+
7329
+ # Required. The id of the document.
7330
+ # Corresponds to the JSON property `docId`
7331
+ # @return [String]
7332
+ attr_accessor :doc_id
7333
+
7334
+ def initialize(**args)
7335
+ update!(**args)
7336
+ end
7337
+
7338
+ # Update properties of this object
7339
+ def update!(**args)
7340
+ @doc_id = args[:doc_id] if args.key?(:doc_id)
7341
+ end
7342
+ end
7343
+
7086
7344
  # Config that controls the output of documents. All documents will be written as
7087
7345
  # a JSON file.
7088
7346
  class GoogleCloudDocumentaiV1beta3DocumentOutputConfig
@@ -9346,6 +9604,28 @@ module Google
9346
9604
  end
9347
9605
  end
9348
9606
 
9607
+ #
9608
+ class GoogleCloudDocumentaiV1beta3GetDocumentResponse
9609
+ include Google::Apis::Core::Hashable
9610
+
9611
+ # Document represents the canonical document resource in Document AI. It is an
9612
+ # interchange format that provides insights into documents and allows for
9613
+ # collaboration between users and Document AI to iterate and optimize for
9614
+ # quality.
9615
+ # Corresponds to the JSON property `document`
9616
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document]
9617
+ attr_accessor :document
9618
+
9619
+ def initialize(**args)
9620
+ update!(**args)
9621
+ end
9622
+
9623
+ # Update properties of this object
9624
+ def update!(**args)
9625
+ @document = args[:document] if args.key?(:document)
9626
+ end
9627
+ end
9628
+
9349
9629
  # The status of human review on a processed document.
9350
9630
  class GoogleCloudDocumentaiV1beta3HumanReviewStatus
9351
9631
  include Google::Apis::Core::Hashable
@@ -9380,6 +9660,193 @@ module Google
9380
9660
  end
9381
9661
  end
9382
9662
 
9663
+ # Metadata of the import document operation.
9664
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata
9665
+ include Google::Apis::Core::Hashable
9666
+
9667
+ # The common metadata for long running operations.
9668
+ # Corresponds to the JSON property `commonMetadata`
9669
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
9670
+ attr_accessor :common_metadata
9671
+
9672
+ # Validation statuses of the batch documents import config.
9673
+ # Corresponds to the JSON property `importConfigValidationResults`
9674
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult>]
9675
+ attr_accessor :import_config_validation_results
9676
+
9677
+ # The list of response details of each document.
9678
+ # Corresponds to the JSON property `individualImportStatuses`
9679
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus>]
9680
+ attr_accessor :individual_import_statuses
9681
+
9682
+ # Total number of the documents that are qualified for importing.
9683
+ # Corresponds to the JSON property `totalDocumentCount`
9684
+ # @return [Fixnum]
9685
+ attr_accessor :total_document_count
9686
+
9687
+ def initialize(**args)
9688
+ update!(**args)
9689
+ end
9690
+
9691
+ # Update properties of this object
9692
+ def update!(**args)
9693
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
9694
+ @import_config_validation_results = args[:import_config_validation_results] if args.key?(:import_config_validation_results)
9695
+ @individual_import_statuses = args[:individual_import_statuses] if args.key?(:individual_import_statuses)
9696
+ @total_document_count = args[:total_document_count] if args.key?(:total_document_count)
9697
+ end
9698
+ end
9699
+
9700
+ # The validation status of each import config. Status is set to errors if there
9701
+ # is no documents to import in the import_config, or OK if the operation will
9702
+ # try to proceed at least one document.
9703
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult
9704
+ include Google::Apis::Core::Hashable
9705
+
9706
+ # The source Cloud Storage URI specified in the import config.
9707
+ # Corresponds to the JSON property `inputGcsSource`
9708
+ # @return [String]
9709
+ attr_accessor :input_gcs_source
9710
+
9711
+ # The `Status` type defines a logical error model that is suitable for different
9712
+ # programming environments, including REST APIs and RPC APIs. It is used by [
9713
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
9714
+ # data: error code, error message, and error details. You can find out more
9715
+ # about this error model and how to work with it in the [API Design Guide](https:
9716
+ # //cloud.google.com/apis/design/errors).
9717
+ # Corresponds to the JSON property `status`
9718
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleRpcStatus]
9719
+ attr_accessor :status
9720
+
9721
+ def initialize(**args)
9722
+ update!(**args)
9723
+ end
9724
+
9725
+ # Update properties of this object
9726
+ def update!(**args)
9727
+ @input_gcs_source = args[:input_gcs_source] if args.key?(:input_gcs_source)
9728
+ @status = args[:status] if args.key?(:status)
9729
+ end
9730
+ end
9731
+
9732
+ # The status of each individual document in the import process.
9733
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus
9734
+ include Google::Apis::Core::Hashable
9735
+
9736
+ # The source Cloud Storage URI of the document.
9737
+ # Corresponds to the JSON property `inputGcsSource`
9738
+ # @return [String]
9739
+ attr_accessor :input_gcs_source
9740
+
9741
+ # Document Identifier.
9742
+ # Corresponds to the JSON property `outputDocumentId`
9743
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentId]
9744
+ attr_accessor :output_document_id
9745
+
9746
+ # The `Status` type defines a logical error model that is suitable for different
9747
+ # programming environments, including REST APIs and RPC APIs. It is used by [
9748
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
9749
+ # data: error code, error message, and error details. You can find out more
9750
+ # about this error model and how to work with it in the [API Design Guide](https:
9751
+ # //cloud.google.com/apis/design/errors).
9752
+ # Corresponds to the JSON property `status`
9753
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleRpcStatus]
9754
+ attr_accessor :status
9755
+
9756
+ def initialize(**args)
9757
+ update!(**args)
9758
+ end
9759
+
9760
+ # Update properties of this object
9761
+ def update!(**args)
9762
+ @input_gcs_source = args[:input_gcs_source] if args.key?(:input_gcs_source)
9763
+ @output_document_id = args[:output_document_id] if args.key?(:output_document_id)
9764
+ @status = args[:status] if args.key?(:status)
9765
+ end
9766
+ end
9767
+
9768
+ #
9769
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsRequest
9770
+ include Google::Apis::Core::Hashable
9771
+
9772
+ # Required. The Cloud Storage uri containing raw documents that must be imported.
9773
+ # Corresponds to the JSON property `batchDocumentsImportConfigs`
9774
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfig>]
9775
+ attr_accessor :batch_documents_import_configs
9776
+
9777
+ def initialize(**args)
9778
+ update!(**args)
9779
+ end
9780
+
9781
+ # Update properties of this object
9782
+ def update!(**args)
9783
+ @batch_documents_import_configs = args[:batch_documents_import_configs] if args.key?(:batch_documents_import_configs)
9784
+ end
9785
+ end
9786
+
9787
+ # Config for importing documents. Each batch can have its own dataset split type.
9788
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfig
9789
+ include Google::Apis::Core::Hashable
9790
+
9791
+ # The config for auto-split.
9792
+ # Corresponds to the JSON property `autoSplitConfig`
9793
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfigAutoSplitConfig]
9794
+ attr_accessor :auto_split_config
9795
+
9796
+ # The common config to specify a set of documents used as input.
9797
+ # Corresponds to the JSON property `batchInputConfig`
9798
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig]
9799
+ attr_accessor :batch_input_config
9800
+
9801
+ # Target dataset split where the documents must be stored.
9802
+ # Corresponds to the JSON property `datasetSplit`
9803
+ # @return [String]
9804
+ attr_accessor :dataset_split
9805
+
9806
+ def initialize(**args)
9807
+ update!(**args)
9808
+ end
9809
+
9810
+ # Update properties of this object
9811
+ def update!(**args)
9812
+ @auto_split_config = args[:auto_split_config] if args.key?(:auto_split_config)
9813
+ @batch_input_config = args[:batch_input_config] if args.key?(:batch_input_config)
9814
+ @dataset_split = args[:dataset_split] if args.key?(:dataset_split)
9815
+ end
9816
+ end
9817
+
9818
+ # The config for auto-split.
9819
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfigAutoSplitConfig
9820
+ include Google::Apis::Core::Hashable
9821
+
9822
+ # Ratio of training dataset split.
9823
+ # Corresponds to the JSON property `trainingSplitRatio`
9824
+ # @return [Float]
9825
+ attr_accessor :training_split_ratio
9826
+
9827
+ def initialize(**args)
9828
+ update!(**args)
9829
+ end
9830
+
9831
+ # Update properties of this object
9832
+ def update!(**args)
9833
+ @training_split_ratio = args[:training_split_ratio] if args.key?(:training_split_ratio)
9834
+ end
9835
+ end
9836
+
9837
+ # Response of the import document operation.
9838
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsResponse
9839
+ include Google::Apis::Core::Hashable
9840
+
9841
+ def initialize(**args)
9842
+ update!(**args)
9843
+ end
9844
+
9845
+ # Update properties of this object
9846
+ def update!(**args)
9847
+ end
9848
+ end
9849
+
9383
9850
  # The long-running operation metadata for the ImportProcessorVersion method.
9384
9851
  class GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata
9385
9852
  include Google::Apis::Core::Hashable
@@ -9693,6 +10160,11 @@ module Google
9693
10160
  # @return [String]
9694
10161
  attr_accessor :field_mask
9695
10162
 
10163
+ # Specifies a document stored on Cloud Storage.
10164
+ # Corresponds to the JSON property `gcsDocument`
10165
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GcsDocument]
10166
+ attr_accessor :gcs_document
10167
+
9696
10168
  # Document represents the canonical document resource in Document AI. It is an
9697
10169
  # interchange format that provides insights into documents and allows for
9698
10170
  # collaboration between users and Document AI to iterate and optimize for
@@ -9725,6 +10197,7 @@ module Google
9725
10197
  def update!(**args)
9726
10198
  @document = args[:document] if args.key?(:document)
9727
10199
  @field_mask = args[:field_mask] if args.key?(:field_mask)
10200
+ @gcs_document = args[:gcs_document] if args.key?(:gcs_document)
9728
10201
  @inline_document = args[:inline_document] if args.key?(:inline_document)
9729
10202
  @process_options = args[:process_options] if args.key?(:process_options)
9730
10203
  @raw_document = args[:raw_document] if args.key?(:raw_document)
@@ -9940,7 +10413,7 @@ module Google
9940
10413
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentSchema]
9941
10414
  attr_accessor :document_schema
9942
10415
 
9943
- # Denotes that this `ProcessorVersion` is managed by Google.
10416
+ # Output only. Denotes that this `ProcessorVersion` is managed by Google.
9944
10417
  # Corresponds to the JSON property `googleManaged`
9945
10418
  # @return [Boolean]
9946
10419
  attr_accessor :google_managed
@@ -10063,6 +10536,25 @@ module Google
10063
10536
  end
10064
10537
  end
10065
10538
 
10539
+ # Specifies a set of raw documents.
10540
+ class GoogleCloudDocumentaiV1beta3RawDocuments
10541
+ include Google::Apis::Core::Hashable
10542
+
10543
+ # Specifies raw document content and mime type.
10544
+ # Corresponds to the JSON property `documents`
10545
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3RawDocument>]
10546
+ attr_accessor :documents
10547
+
10548
+ def initialize(**args)
10549
+ update!(**args)
10550
+ end
10551
+
10552
+ # Update properties of this object
10553
+ def update!(**args)
10554
+ @documents = args[:documents] if args.key?(:documents)
10555
+ end
10556
+ end
10557
+
10066
10558
  # The long-running operation metadata for the ReviewDocument method.
10067
10559
  class GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata
10068
10560
  include Google::Apis::Core::Hashable
@@ -10195,6 +10687,39 @@ module Google
10195
10687
  end
10196
10688
  end
10197
10689
 
10690
+ # The revision reference specifies which revision on the document to read.
10691
+ class GoogleCloudDocumentaiV1beta3RevisionRef
10692
+ include Google::Apis::Core::Hashable
10693
+
10694
+ # Reads the revision generated by the processor version. The format takes the
10695
+ # full resource name of processor version. `projects/`project`/locations/`
10696
+ # location`/processors/`processor`/processorVersions/`processorVersion``
10697
+ # Corresponds to the JSON property `latestProcessorVersion`
10698
+ # @return [String]
10699
+ attr_accessor :latest_processor_version
10700
+
10701
+ # Reads the revision by the predefined case.
10702
+ # Corresponds to the JSON property `revisionCase`
10703
+ # @return [String]
10704
+ attr_accessor :revision_case
10705
+
10706
+ # Reads the revision given by the id.
10707
+ # Corresponds to the JSON property `revisionId`
10708
+ # @return [String]
10709
+ attr_accessor :revision_id
10710
+
10711
+ def initialize(**args)
10712
+ update!(**args)
10713
+ end
10714
+
10715
+ # Update properties of this object
10716
+ def update!(**args)
10717
+ @latest_processor_version = args[:latest_processor_version] if args.key?(:latest_processor_version)
10718
+ @revision_case = args[:revision_case] if args.key?(:revision_case)
10719
+ @revision_id = args[:revision_id] if args.key?(:revision_id)
10720
+ end
10721
+ end
10722
+
10198
10723
  # The long-running operation metadata for the SetDefaultProcessorVersion method.
10199
10724
  class GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata
10200
10725
  include Google::Apis::Core::Hashable
@@ -10480,6 +11005,25 @@ module Google
10480
11005
  end
10481
11006
  end
10482
11007
 
11008
+ #
11009
+ class GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata
11010
+ include Google::Apis::Core::Hashable
11011
+
11012
+ # The common metadata for long running operations.
11013
+ # Corresponds to the JSON property `commonMetadata`
11014
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
11015
+ attr_accessor :common_metadata
11016
+
11017
+ def initialize(**args)
11018
+ update!(**args)
11019
+ end
11020
+
11021
+ # Update properties of this object
11022
+ def update!(**args)
11023
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
11024
+ end
11025
+ end
11026
+
10483
11027
  # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are
10484
11028
  # in the same scale as the original image.
10485
11029
  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.78.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 = "20230719"
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
 
@@ -1720,6 +1822,12 @@ module Google
1720
1822
  include Google::Apis::Core::JsonObjectSupport
1721
1823
  end
1722
1824
 
1825
+ class GoogleCloudDocumentaiV1beta3RawDocuments
1826
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1827
+
1828
+ include Google::Apis::Core::JsonObjectSupport
1829
+ end
1830
+
1723
1831
  class GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata
1724
1832
  class Representation < Google::Apis::Core::JsonRepresentation; end
1725
1833
 
@@ -1738,6 +1846,12 @@ module Google
1738
1846
  include Google::Apis::Core::JsonObjectSupport
1739
1847
  end
1740
1848
 
1849
+ class GoogleCloudDocumentaiV1beta3RevisionRef
1850
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1851
+
1852
+ include Google::Apis::Core::JsonObjectSupport
1853
+ end
1854
+
1741
1855
  class GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata
1742
1856
  class Representation < Google::Apis::Core::JsonRepresentation; end
1743
1857
 
@@ -1810,6 +1924,12 @@ module Google
1810
1924
  include Google::Apis::Core::JsonObjectSupport
1811
1925
  end
1812
1926
 
1927
+ class GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata
1928
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1929
+
1930
+ include Google::Apis::Core::JsonObjectSupport
1931
+ end
1932
+
1813
1933
  class GoogleCloudDocumentaiV1beta3Vertex
1814
1934
  class Representation < Google::Apis::Core::JsonRepresentation; end
1815
1935
 
@@ -2175,6 +2295,8 @@ module Google
2175
2295
  # @private
2176
2296
  class Representation < Google::Apis::Core::JsonRepresentation
2177
2297
  property :input_gcs_source, as: 'inputGcsSource'
2298
+ property :output_document_id, as: 'outputDocumentId', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentId, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentId::Representation
2299
+
2178
2300
  property :output_gcs_destination, as: 'outputGcsDestination'
2179
2301
  property :status, as: 'status', class: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus::Representation
2180
2302
 
@@ -2260,6 +2382,10 @@ module Google
2260
2382
  class GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse
2261
2383
  # @private
2262
2384
  class Representation < Google::Apis::Core::JsonRepresentation
2385
+ property :sample_test_status, as: 'sampleTestStatus', class: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus::Representation
2386
+
2387
+ property :sample_training_status, as: 'sampleTrainingStatus', class: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus::Representation
2388
+
2263
2389
  collection :selected_documents, as: 'selectedDocuments', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument::Representation
2264
2390
 
2265
2391
  end
@@ -3712,6 +3838,59 @@ module Google
3712
3838
  end
3713
3839
  end
3714
3840
 
3841
+ class GoogleCloudDocumentaiV1beta3BatchDatasetDocuments
3842
+ # @private
3843
+ class Representation < Google::Apis::Core::JsonRepresentation
3844
+ property :filter, as: 'filter'
3845
+ property :individual_document_ids, as: 'individualDocumentIds', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDatasetDocumentsIndividualDocumentIds, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDatasetDocumentsIndividualDocumentIds::Representation
3846
+
3847
+ end
3848
+ end
3849
+
3850
+ class GoogleCloudDocumentaiV1beta3BatchDatasetDocumentsIndividualDocumentIds
3851
+ # @private
3852
+ class Representation < Google::Apis::Core::JsonRepresentation
3853
+ collection :document_ids, as: 'documentIds', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentId, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentId::Representation
3854
+
3855
+ end
3856
+ end
3857
+
3858
+ class GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata
3859
+ # @private
3860
+ class Representation < Google::Apis::Core::JsonRepresentation
3861
+ property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata::Representation
3862
+
3863
+ property :error_document_count, as: 'errorDocumentCount'
3864
+ collection :individual_batch_delete_statuses, as: 'individualBatchDeleteStatuses', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus::Representation
3865
+
3866
+ property :total_document_count, as: 'totalDocumentCount'
3867
+ end
3868
+ end
3869
+
3870
+ class GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus
3871
+ # @private
3872
+ class Representation < Google::Apis::Core::JsonRepresentation
3873
+ property :document_id, as: 'documentId', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentId, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentId::Representation
3874
+
3875
+ property :status, as: 'status', class: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus::Representation
3876
+
3877
+ end
3878
+ end
3879
+
3880
+ class GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsRequest
3881
+ # @private
3882
+ class Representation < Google::Apis::Core::JsonRepresentation
3883
+ property :dataset_documents, as: 'datasetDocuments', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDatasetDocuments, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDatasetDocuments::Representation
3884
+
3885
+ end
3886
+ end
3887
+
3888
+ class GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse
3889
+ # @private
3890
+ class Representation < Google::Apis::Core::JsonRepresentation
3891
+ end
3892
+ end
3893
+
3715
3894
  class GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig
3716
3895
  # @private
3717
3896
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3719,6 +3898,8 @@ module Google
3719
3898
 
3720
3899
  property :gcs_prefix, as: 'gcsPrefix', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GcsPrefix, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GcsPrefix::Representation
3721
3900
 
3901
+ property :raw_documents, as: 'rawDocuments', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3RawDocuments, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3RawDocuments::Representation
3902
+
3722
3903
  end
3723
3904
  end
3724
3905
 
@@ -3990,6 +4171,33 @@ module Google
3990
4171
  end
3991
4172
  end
3992
4173
 
4174
+ class GoogleCloudDocumentaiV1beta3DocumentId
4175
+ # @private
4176
+ class Representation < Google::Apis::Core::JsonRepresentation
4177
+ property :gcs_managed_doc_id, as: 'gcsManagedDocId', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentIdGcsManagedDocumentId, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentIdGcsManagedDocumentId::Representation
4178
+
4179
+ property :revision_ref, as: 'revisionRef', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3RevisionRef, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3RevisionRef::Representation
4180
+
4181
+ property :unmanaged_doc_id, as: 'unmanagedDocId', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId::Representation
4182
+
4183
+ end
4184
+ end
4185
+
4186
+ class GoogleCloudDocumentaiV1beta3DocumentIdGcsManagedDocumentId
4187
+ # @private
4188
+ class Representation < Google::Apis::Core::JsonRepresentation
4189
+ property :cw_doc_id, as: 'cwDocId'
4190
+ property :gcs_uri, as: 'gcsUri'
4191
+ end
4192
+ end
4193
+
4194
+ class GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId
4195
+ # @private
4196
+ class Representation < Google::Apis::Core::JsonRepresentation
4197
+ property :doc_id, as: 'docId'
4198
+ end
4199
+ end
4200
+
3993
4201
  class GoogleCloudDocumentaiV1beta3DocumentOutputConfig
3994
4202
  # @private
3995
4203
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -4629,6 +4837,14 @@ module Google
4629
4837
  end
4630
4838
  end
4631
4839
 
4840
+ class GoogleCloudDocumentaiV1beta3GetDocumentResponse
4841
+ # @private
4842
+ class Representation < Google::Apis::Core::JsonRepresentation
4843
+ property :document, as: 'document', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document::Representation
4844
+
4845
+ end
4846
+ end
4847
+
4632
4848
  class GoogleCloudDocumentaiV1beta3HumanReviewStatus
4633
4849
  # @private
4634
4850
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -4638,6 +4854,71 @@ module Google
4638
4854
  end
4639
4855
  end
4640
4856
 
4857
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata
4858
+ # @private
4859
+ class Representation < Google::Apis::Core::JsonRepresentation
4860
+ property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata::Representation
4861
+
4862
+ collection :import_config_validation_results, as: 'importConfigValidationResults', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult::Representation
4863
+
4864
+ collection :individual_import_statuses, as: 'individualImportStatuses', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus::Representation
4865
+
4866
+ property :total_document_count, as: 'totalDocumentCount'
4867
+ end
4868
+ end
4869
+
4870
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult
4871
+ # @private
4872
+ class Representation < Google::Apis::Core::JsonRepresentation
4873
+ property :input_gcs_source, as: 'inputGcsSource'
4874
+ property :status, as: 'status', class: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus::Representation
4875
+
4876
+ end
4877
+ end
4878
+
4879
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus
4880
+ # @private
4881
+ class Representation < Google::Apis::Core::JsonRepresentation
4882
+ property :input_gcs_source, as: 'inputGcsSource'
4883
+ property :output_document_id, as: 'outputDocumentId', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentId, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentId::Representation
4884
+
4885
+ property :status, as: 'status', class: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus::Representation
4886
+
4887
+ end
4888
+ end
4889
+
4890
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsRequest
4891
+ # @private
4892
+ class Representation < Google::Apis::Core::JsonRepresentation
4893
+ collection :batch_documents_import_configs, as: 'batchDocumentsImportConfigs', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfig, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfig::Representation
4894
+
4895
+ end
4896
+ end
4897
+
4898
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfig
4899
+ # @private
4900
+ class Representation < Google::Apis::Core::JsonRepresentation
4901
+ property :auto_split_config, as: 'autoSplitConfig', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfigAutoSplitConfig, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfigAutoSplitConfig::Representation
4902
+
4903
+ property :batch_input_config, as: 'batchInputConfig', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig::Representation
4904
+
4905
+ property :dataset_split, as: 'datasetSplit'
4906
+ end
4907
+ end
4908
+
4909
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfigAutoSplitConfig
4910
+ # @private
4911
+ class Representation < Google::Apis::Core::JsonRepresentation
4912
+ property :training_split_ratio, as: 'trainingSplitRatio'
4913
+ end
4914
+ end
4915
+
4916
+ class GoogleCloudDocumentaiV1beta3ImportDocumentsResponse
4917
+ # @private
4918
+ class Representation < Google::Apis::Core::JsonRepresentation
4919
+ end
4920
+ end
4921
+
4641
4922
  class GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata
4642
4923
  # @private
4643
4924
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -4738,6 +5019,8 @@ module Google
4738
5019
  property :document, as: 'document', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document::Representation
4739
5020
 
4740
5021
  property :field_mask, as: 'fieldMask'
5022
+ property :gcs_document, as: 'gcsDocument', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GcsDocument, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GcsDocument::Representation
5023
+
4741
5024
  property :inline_document, as: 'inlineDocument', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document::Representation
4742
5025
 
4743
5026
  property :process_options, as: 'processOptions', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessOptions, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessOptions::Representation
@@ -4836,6 +5119,14 @@ module Google
4836
5119
  end
4837
5120
  end
4838
5121
 
5122
+ class GoogleCloudDocumentaiV1beta3RawDocuments
5123
+ # @private
5124
+ class Representation < Google::Apis::Core::JsonRepresentation
5125
+ collection :documents, as: 'documents', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3RawDocument, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3RawDocument::Representation
5126
+
5127
+ end
5128
+ end
5129
+
4839
5130
  class GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata
4840
5131
  # @private
4841
5132
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -4872,6 +5163,15 @@ module Google
4872
5163
  end
4873
5164
  end
4874
5165
 
5166
+ class GoogleCloudDocumentaiV1beta3RevisionRef
5167
+ # @private
5168
+ class Representation < Google::Apis::Core::JsonRepresentation
5169
+ property :latest_processor_version, as: 'latestProcessorVersion'
5170
+ property :revision_case, as: 'revisionCase'
5171
+ property :revision_id, as: 'revisionId'
5172
+ end
5173
+ end
5174
+
4875
5175
  class GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata
4876
5176
  # @private
4877
5177
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -4976,6 +5276,14 @@ module Google
4976
5276
  end
4977
5277
  end
4978
5278
 
5279
+ class GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata
5280
+ # @private
5281
+ class Representation < Google::Apis::Core::JsonRepresentation
5282
+ property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata::Representation
5283
+
5284
+ end
5285
+ end
5286
+
4979
5287
  class GoogleCloudDocumentaiV1beta3Vertex
4980
5288
  # @private
4981
5289
  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.78.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-23 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.78.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: []