google-apis-documentai_v1beta3 0.75.0 → 0.77.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -445,8 +445,8 @@ module Google
445
445
  class GoogleCloudDocumentaiUiv1beta3DocumentId
446
446
  include Google::Apis::Core::Hashable
447
447
 
448
- # Identifies a document uniquely within the scope of a dataset in user managed
449
- # Cloud Storage option.
448
+ # Identifies a document uniquely within the scope of a dataset in the user-
449
+ # managed Cloud Storage option.
450
450
  # Corresponds to the JSON property `gcsManagedDocId`
451
451
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentIdGcsManagedDocumentId]
452
452
  attr_accessor :gcs_managed_doc_id
@@ -474,8 +474,8 @@ module Google
474
474
  end
475
475
  end
476
476
 
477
- # Identifies a document uniquely within the scope of a dataset in user managed
478
- # Cloud Storage option.
477
+ # Identifies a document uniquely within the scope of a dataset in the user-
478
+ # managed Cloud Storage option.
479
479
  class GoogleCloudDocumentaiUiv1beta3DocumentIdGcsManagedDocumentId
480
480
  include Google::Apis::Core::Hashable
481
481
 
@@ -484,7 +484,7 @@ module Google
484
484
  # @return [String]
485
485
  attr_accessor :cw_doc_id
486
486
 
487
- # Required. The Cloud Storage uri where the actual document is stored.
487
+ # Required. The Cloud Storage URI where the actual document is stored.
488
488
  # Corresponds to the JSON property `gcsUri`
489
489
  # @return [String]
490
490
  attr_accessor :gcs_uri
@@ -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
@@ -2319,7 +2347,7 @@ module Google
2319
2347
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentPageImage]
2320
2348
  attr_accessor :image
2321
2349
 
2322
- # Image Quality Scores for the page image.
2350
+ # Image quality scores for the page image.
2323
2351
  # Corresponds to the JSON property `imageQualityScores`
2324
2352
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores]
2325
2353
  attr_accessor :image_quality_scores
@@ -2695,7 +2723,7 @@ module Google
2695
2723
  end
2696
2724
  end
2697
2725
 
2698
- # Image Quality Scores for the page image.
2726
+ # Image quality scores for the page image.
2699
2727
  class GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores
2700
2728
  include Google::Apis::Core::Hashable
2701
2729
 
@@ -2725,7 +2753,7 @@ module Google
2725
2753
  include Google::Apis::Core::Hashable
2726
2754
 
2727
2755
  # Confidence of detected defect. Range `[0, 1]` where `1` indicates strong
2728
- # confidence of that the defect exists.
2756
+ # confidence that the defect exists.
2729
2757
  # Corresponds to the JSON property `confidence`
2730
2758
  # @return [Float]
2731
2759
  attr_accessor :confidence
@@ -3093,7 +3121,7 @@ module Google
3093
3121
  # be trivially provided to the constructor of `java.awt.Color` in Java; it can
3094
3122
  # also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha`
3095
3123
  # method in iOS; and, with just a little work, it can be easily formatted into a
3096
- # CSS `rgba()` string in JavaScript. This reference page does not have
3124
+ # CSS `rgba()` string in JavaScript. This reference page doesn't have
3097
3125
  # information about the absolute color space that should be used to interpret
3098
3126
  # the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default,
3099
3127
  # applications should assume the sRGB color space. When color equality needs to
@@ -3210,7 +3238,7 @@ module Google
3210
3238
  # be trivially provided to the constructor of `java.awt.Color` in Java; it can
3211
3239
  # also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha`
3212
3240
  # method in iOS; and, with just a little work, it can be easily formatted into a
3213
- # CSS `rgba()` string in JavaScript. This reference page does not have
3241
+ # CSS `rgba()` string in JavaScript. This reference page doesn't have
3214
3242
  # information about the absolute color space that should be used to interpret
3215
3243
  # the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default,
3216
3244
  # applications should assume the sRGB color space. When color equality needs to
@@ -3517,7 +3545,7 @@ module Google
3517
3545
  # be trivially provided to the constructor of `java.awt.Color` in Java; it can
3518
3546
  # also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha`
3519
3547
  # method in iOS; and, with just a little work, it can be easily formatted into a
3520
- # CSS `rgba()` string in JavaScript. This reference page does not have
3548
+ # CSS `rgba()` string in JavaScript. This reference page doesn't have
3521
3549
  # information about the absolute color space that should be used to interpret
3522
3550
  # the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default,
3523
3551
  # applications should assume the sRGB color space. When color equality needs to
@@ -3566,7 +3594,7 @@ module Google
3566
3594
  # be trivially provided to the constructor of `java.awt.Color` in Java; it can
3567
3595
  # also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha`
3568
3596
  # method in iOS; and, with just a little work, it can be easily formatted into a
3569
- # CSS `rgba()` string in JavaScript. This reference page does not have
3597
+ # CSS `rgba()` string in JavaScript. This reference page doesn't have
3570
3598
  # information about the absolute color space that should be used to interpret
3571
3599
  # the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default,
3572
3600
  # applications should assume the sRGB color space. When color equality needs to
@@ -3669,7 +3697,7 @@ module Google
3669
3697
  # @return [Float]
3670
3698
  attr_accessor :size
3671
3699
 
3672
- # Unit for the font size. Follows CSS naming (`in`, `px`, `pt`, etc.).
3700
+ # Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`).
3673
3701
  # Corresponds to the JSON property `unit`
3674
3702
  # @return [String]
3675
3703
  attr_accessor :unit
@@ -4468,7 +4496,7 @@ module Google
4468
4496
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentPageImage]
4469
4497
  attr_accessor :image
4470
4498
 
4471
- # Image Quality Scores for the page image.
4499
+ # Image quality scores for the page image.
4472
4500
  # Corresponds to the JSON property `imageQualityScores`
4473
4501
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores]
4474
4502
  attr_accessor :image_quality_scores
@@ -4844,7 +4872,7 @@ module Google
4844
4872
  end
4845
4873
  end
4846
4874
 
4847
- # Image Quality Scores for the page image.
4875
+ # Image quality scores for the page image.
4848
4876
  class GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores
4849
4877
  include Google::Apis::Core::Hashable
4850
4878
 
@@ -4874,7 +4902,7 @@ module Google
4874
4902
  include Google::Apis::Core::Hashable
4875
4903
 
4876
4904
  # Confidence of detected defect. Range `[0, 1]` where `1` indicates strong
4877
- # confidence of that the defect exists.
4905
+ # confidence that the defect exists.
4878
4906
  # Corresponds to the JSON property `confidence`
4879
4907
  # @return [Float]
4880
4908
  attr_accessor :confidence
@@ -5242,7 +5270,7 @@ module Google
5242
5270
  # be trivially provided to the constructor of `java.awt.Color` in Java; it can
5243
5271
  # also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha`
5244
5272
  # method in iOS; and, with just a little work, it can be easily formatted into a
5245
- # CSS `rgba()` string in JavaScript. This reference page does not have
5273
+ # CSS `rgba()` string in JavaScript. This reference page doesn't have
5246
5274
  # information about the absolute color space that should be used to interpret
5247
5275
  # the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default,
5248
5276
  # applications should assume the sRGB color space. When color equality needs to
@@ -5359,7 +5387,7 @@ module Google
5359
5387
  # be trivially provided to the constructor of `java.awt.Color` in Java; it can
5360
5388
  # also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha`
5361
5389
  # method in iOS; and, with just a little work, it can be easily formatted into a
5362
- # CSS `rgba()` string in JavaScript. This reference page does not have
5390
+ # CSS `rgba()` string in JavaScript. This reference page doesn't have
5363
5391
  # information about the absolute color space that should be used to interpret
5364
5392
  # the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default,
5365
5393
  # applications should assume the sRGB color space. When color equality needs to
@@ -5666,7 +5694,7 @@ module Google
5666
5694
  # be trivially provided to the constructor of `java.awt.Color` in Java; it can
5667
5695
  # also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha`
5668
5696
  # method in iOS; and, with just a little work, it can be easily formatted into a
5669
- # CSS `rgba()` string in JavaScript. This reference page does not have
5697
+ # CSS `rgba()` string in JavaScript. This reference page doesn't have
5670
5698
  # information about the absolute color space that should be used to interpret
5671
5699
  # the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default,
5672
5700
  # applications should assume the sRGB color space. When color equality needs to
@@ -5715,7 +5743,7 @@ module Google
5715
5743
  # be trivially provided to the constructor of `java.awt.Color` in Java; it can
5716
5744
  # also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha`
5717
5745
  # method in iOS; and, with just a little work, it can be easily formatted into a
5718
- # CSS `rgba()` string in JavaScript. This reference page does not have
5746
+ # CSS `rgba()` string in JavaScript. This reference page doesn't have
5719
5747
  # information about the absolute color space that should be used to interpret
5720
5748
  # the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default,
5721
5749
  # applications should assume the sRGB color space. When color equality needs to
@@ -5818,7 +5846,7 @@ module Google
5818
5846
  # @return [Float]
5819
5847
  attr_accessor :size
5820
5848
 
5821
- # Unit for the font size. Follows CSS naming (`in`, `px`, `pt`, etc.).
5849
+ # Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`).
5822
5850
  # Corresponds to the JSON property `unit`
5823
5851
  # @return [String]
5824
5852
  attr_accessor :unit
@@ -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
@@ -6336,8 +6509,7 @@ module Google
6336
6509
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessOptions]
6337
6510
  attr_accessor :process_options
6338
6511
 
6339
- # Whether Human Review feature should be skipped for this request. Default to `
6340
- # false`.
6512
+ # Whether human review should be skipped for this request. Default to `false`.
6341
6513
  # Corresponds to the JSON property `skipHumanReview`
6342
6514
  # @return [Boolean]
6343
6515
  attr_accessor :skip_human_review
@@ -6492,12 +6664,12 @@ module Google
6492
6664
  class GoogleCloudDocumentaiV1beta3Dataset
6493
6665
  include Google::Apis::Core::Hashable
6494
6666
 
6495
- # Config specific to the Document Warehouse-based implementation.
6667
+ # Configuration specific to the Document AI Warehouse-based implementation.
6496
6668
  # Corresponds to the JSON property `documentWarehouseConfig`
6497
6669
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig]
6498
6670
  attr_accessor :document_warehouse_config
6499
6671
 
6500
- # Config specific to the GCS-based implementation.
6672
+ # Configuration specific to the Cloud Storage-based implementation.
6501
6673
  # Corresponds to the JSON property `gcsManagedConfig`
6502
6674
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DatasetGcsManagedConfig]
6503
6675
  attr_accessor :gcs_managed_config
@@ -6508,17 +6680,17 @@ module Google
6508
6680
  # @return [String]
6509
6681
  attr_accessor :name
6510
6682
 
6511
- # Config specific to spanner based indexing.
6683
+ # Configuration specific to spanner-based indexing.
6512
6684
  # Corresponds to the JSON property `spannerIndexingConfig`
6513
6685
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig]
6514
6686
  attr_accessor :spanner_indexing_config
6515
6687
 
6516
- # Required. State of the dataset. Will be ignored when updating dataset.
6688
+ # Required. State of the dataset. Ignored when updating dataset.
6517
6689
  # Corresponds to the JSON property `state`
6518
6690
  # @return [String]
6519
6691
  attr_accessor :state
6520
6692
 
6521
- # Config specific to unmanaged config
6693
+ # Configuration specific to an unmanaged dataset.
6522
6694
  # Corresponds to the JSON property `unmanagedDatasetConfig`
6523
6695
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig]
6524
6696
  attr_accessor :unmanaged_dataset_config
@@ -6538,16 +6710,17 @@ module Google
6538
6710
  end
6539
6711
  end
6540
6712
 
6541
- # Config specific to the Document Warehouse-based implementation.
6713
+ # Configuration specific to the Document AI Warehouse-based implementation.
6542
6714
  class GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig
6543
6715
  include Google::Apis::Core::Hashable
6544
6716
 
6545
- # Output only. The collection in Document Warehouse associated with the dataset.
6717
+ # Output only. The collection in Document AI Warehouse associated with the
6718
+ # dataset.
6546
6719
  # Corresponds to the JSON property `collection`
6547
6720
  # @return [String]
6548
6721
  attr_accessor :collection
6549
6722
 
6550
- # Output only. The schema in Document Warehouse associated with the dataset.
6723
+ # Output only. The schema in Document AI Warehouse associated with the dataset.
6551
6724
  # Corresponds to the JSON property `schema`
6552
6725
  # @return [String]
6553
6726
  attr_accessor :schema
@@ -6563,7 +6736,7 @@ module Google
6563
6736
  end
6564
6737
  end
6565
6738
 
6566
- # Config specific to the GCS-based implementation.
6739
+ # Configuration specific to the Cloud Storage-based implementation.
6567
6740
  class GoogleCloudDocumentaiV1beta3DatasetGcsManagedConfig
6568
6741
  include Google::Apis::Core::Hashable
6569
6742
 
@@ -6608,7 +6781,7 @@ module Google
6608
6781
  end
6609
6782
  end
6610
6783
 
6611
- # Config specific to spanner based indexing.
6784
+ # Configuration specific to spanner-based indexing.
6612
6785
  class GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig
6613
6786
  include Google::Apis::Core::Hashable
6614
6787
 
@@ -6621,7 +6794,7 @@ module Google
6621
6794
  end
6622
6795
  end
6623
6796
 
6624
- # Config specific to unmanaged config
6797
+ # Configuration specific to an unmanaged dataset.
6625
6798
  class GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig
6626
6799
  include Google::Apis::Core::Hashable
6627
6800
 
@@ -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
@@ -7197,7 +7449,7 @@ module Google
7197
7449
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageImage]
7198
7450
  attr_accessor :image
7199
7451
 
7200
- # Image Quality Scores for the page image.
7452
+ # Image quality scores for the page image.
7201
7453
  # Corresponds to the JSON property `imageQualityScores`
7202
7454
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScores]
7203
7455
  attr_accessor :image_quality_scores
@@ -7573,7 +7825,7 @@ module Google
7573
7825
  end
7574
7826
  end
7575
7827
 
7576
- # Image Quality Scores for the page image.
7828
+ # Image quality scores for the page image.
7577
7829
  class GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScores
7578
7830
  include Google::Apis::Core::Hashable
7579
7831
 
@@ -7603,7 +7855,7 @@ module Google
7603
7855
  include Google::Apis::Core::Hashable
7604
7856
 
7605
7857
  # Confidence of detected defect. Range `[0, 1]` where `1` indicates strong
7606
- # confidence of that the defect exists.
7858
+ # confidence that the defect exists.
7607
7859
  # Corresponds to the JSON property `confidence`
7608
7860
  # @return [Float]
7609
7861
  attr_accessor :confidence
@@ -7971,7 +8223,7 @@ module Google
7971
8223
  # be trivially provided to the constructor of `java.awt.Color` in Java; it can
7972
8224
  # also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha`
7973
8225
  # method in iOS; and, with just a little work, it can be easily formatted into a
7974
- # CSS `rgba()` string in JavaScript. This reference page does not have
8226
+ # CSS `rgba()` string in JavaScript. This reference page doesn't have
7975
8227
  # information about the absolute color space that should be used to interpret
7976
8228
  # the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default,
7977
8229
  # applications should assume the sRGB color space. When color equality needs to
@@ -8088,7 +8340,7 @@ module Google
8088
8340
  # be trivially provided to the constructor of `java.awt.Color` in Java; it can
8089
8341
  # also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha`
8090
8342
  # method in iOS; and, with just a little work, it can be easily formatted into a
8091
- # CSS `rgba()` string in JavaScript. This reference page does not have
8343
+ # CSS `rgba()` string in JavaScript. This reference page doesn't have
8092
8344
  # information about the absolute color space that should be used to interpret
8093
8345
  # the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default,
8094
8346
  # applications should assume the sRGB color space. When color equality needs to
@@ -8416,11 +8668,11 @@ module Google
8416
8668
  attr_accessor :enum_values
8417
8669
 
8418
8670
  # Name of the type. It must be unique within the schema file and cannot be a "
8419
- # Common Type". The following naming conventions are used: - Use `snake_casing` -
8420
- # Name matching is case-sensitive - Maximum 64 characters. - Must start with a
8421
- # letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward
8671
+ # Common Type". The following naming conventions are used: - Use `snake_casing`.
8672
+ # - Name matching is case-sensitive. - Maximum 64 characters. - Must start with
8673
+ # a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward
8422
8674
  # compatibility internal infrastructure and tooling can handle any ascii
8423
- # character) - The `/` is sometimes used to denote a property of a type. For
8675
+ # character.) - The `/` is sometimes used to denote a property of a type. For
8424
8676
  # example `line_item/amount`. This convention is deprecated, but will still be
8425
8677
  # honored for backward compatibility.
8426
8678
  # Corresponds to the JSON property `name`
@@ -8594,7 +8846,7 @@ module Google
8594
8846
  # be trivially provided to the constructor of `java.awt.Color` in Java; it can
8595
8847
  # also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha`
8596
8848
  # method in iOS; and, with just a little work, it can be easily formatted into a
8597
- # CSS `rgba()` string in JavaScript. This reference page does not have
8849
+ # CSS `rgba()` string in JavaScript. This reference page doesn't have
8598
8850
  # information about the absolute color space that should be used to interpret
8599
8851
  # the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default,
8600
8852
  # applications should assume the sRGB color space. When color equality needs to
@@ -8643,7 +8895,7 @@ module Google
8643
8895
  # be trivially provided to the constructor of `java.awt.Color` in Java; it can
8644
8896
  # also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha`
8645
8897
  # method in iOS; and, with just a little work, it can be easily formatted into a
8646
- # CSS `rgba()` string in JavaScript. This reference page does not have
8898
+ # CSS `rgba()` string in JavaScript. This reference page doesn't have
8647
8899
  # information about the absolute color space that should be used to interpret
8648
8900
  # the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default,
8649
8901
  # applications should assume the sRGB color space. When color equality needs to
@@ -8746,7 +8998,7 @@ module Google
8746
8998
  # @return [Float]
8747
8999
  attr_accessor :size
8748
9000
 
8749
- # Unit for the font size. Follows CSS naming (`in`, `px`, `pt`, etc.).
9001
+ # Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`).
8750
9002
  # Corresponds to the JSON property `unit`
8751
9003
  # @return [String]
8752
9004
  attr_accessor :unit
@@ -8896,7 +9148,7 @@ module Google
8896
9148
  class GoogleCloudDocumentaiV1beta3EntityTypeMetadata
8897
9149
  include Google::Apis::Core::Hashable
8898
9150
 
8899
- # Whether the entity type should be considered as "inactive".
9151
+ # Whether the entity type should be considered inactive.
8900
9152
  # Corresponds to the JSON property `inactive`
8901
9153
  # @return [Boolean]
8902
9154
  attr_accessor :inactive
@@ -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
@@ -9711,8 +10177,7 @@ module Google
9711
10177
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3RawDocument]
9712
10178
  attr_accessor :raw_document
9713
10179
 
9714
- # Whether Human Review feature should be skipped for this request. Default to
9715
- # false.
10180
+ # Whether human review should be skipped for this request. Default to `false`.
9716
10181
  # Corresponds to the JSON property `skipHumanReview`
9717
10182
  # @return [Boolean]
9718
10183
  attr_accessor :skip_human_review
@@ -9726,6 +10191,7 @@ module Google
9726
10191
  def update!(**args)
9727
10192
  @document = args[:document] if args.key?(:document)
9728
10193
  @field_mask = args[:field_mask] if args.key?(:field_mask)
10194
+ @gcs_document = args[:gcs_document] if args.key?(:gcs_document)
9729
10195
  @inline_document = args[:inline_document] if args.key?(:inline_document)
9730
10196
  @process_options = args[:process_options] if args.key?(:process_options)
9731
10197
  @raw_document = args[:raw_document] if args.key?(:raw_document)
@@ -9790,7 +10256,7 @@ module Google
9790
10256
  attr_accessor :display_name
9791
10257
 
9792
10258
  # The [KMS key](https://cloud.google.com/security-key-management) used for
9793
- # encryption/decryption in CMEK scenarios.
10259
+ # encryption and decryption in CMEK scenarios.
9794
10260
  # Corresponds to the JSON property `kmsKeyName`
9795
10261
  # @return [String]
9796
10262
  attr_accessor :kms_key_name
@@ -9898,8 +10364,8 @@ module Google
9898
10364
  class GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo
9899
10365
  include Google::Apis::Core::Hashable
9900
10366
 
9901
- # The location id, refer to [regional and multi-regional support](/document-ai/
9902
- # docs/regions) for supported locations.
10367
+ # The location ID. For supported locations, refer to [regional and multi-
10368
+ # regional support](/document-ai/docs/regions).
9903
10369
  # Corresponds to the JSON property `locationId`
9904
10370
  # @return [String]
9905
10371
  attr_accessor :location_id
@@ -9915,10 +10381,9 @@ module Google
9915
10381
  end
9916
10382
 
9917
10383
  # A processor version is an implementation of a processor. Each processor can
9918
- # have multiple versions, pre-trained by Google internally or uptrained by the
9919
- # customer. At a time, a processor can only have one default version version. So
9920
- # the processor's behavior (when processing documents) is defined by a default
9921
- # version
10384
+ # have multiple versions, pretrained by Google internally or uptrained by the
10385
+ # customer. A processor can only have one default version at a time. Its
10386
+ # document-processing behavior is defined by that version.
9922
10387
  class GoogleCloudDocumentaiV1beta3ProcessorVersion
9923
10388
  include Google::Apis::Core::Hashable
9924
10389
 
@@ -10197,6 +10662,39 @@ module Google
10197
10662
  end
10198
10663
  end
10199
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
+
10200
10698
  # The long-running operation metadata for the SetDefaultProcessorVersion method.
10201
10699
  class GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata
10202
10700
  include Google::Apis::Core::Hashable
@@ -10335,6 +10833,12 @@ module Google
10335
10833
  # @return [String]
10336
10834
  attr_accessor :base_processor_version
10337
10835
 
10836
+ # Options to control the training of the Custom Document Extraction (CDE)
10837
+ # Processor.
10838
+ # Corresponds to the JSON property `customDocumentExtractionOptions`
10839
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestCustomDocumentExtractionOptions]
10840
+ attr_accessor :custom_document_extraction_options
10841
+
10338
10842
  # The schema defines the output of the processed document by a processor.
10339
10843
  # Corresponds to the JSON property `documentSchema`
10340
10844
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentSchema]
@@ -10346,10 +10850,9 @@ module Google
10346
10850
  attr_accessor :input_data
10347
10851
 
10348
10852
  # A processor version is an implementation of a processor. Each processor can
10349
- # have multiple versions, pre-trained by Google internally or uptrained by the
10350
- # customer. At a time, a processor can only have one default version version. So
10351
- # the processor's behavior (when processing documents) is defined by a default
10352
- # version
10853
+ # have multiple versions, pretrained by Google internally or uptrained by the
10854
+ # customer. A processor can only have one default version at a time. Its
10855
+ # document-processing behavior is defined by that version.
10353
10856
  # Corresponds to the JSON property `processorVersion`
10354
10857
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessorVersion]
10355
10858
  attr_accessor :processor_version
@@ -10361,12 +10864,33 @@ module Google
10361
10864
  # Update properties of this object
10362
10865
  def update!(**args)
10363
10866
  @base_processor_version = args[:base_processor_version] if args.key?(:base_processor_version)
10867
+ @custom_document_extraction_options = args[:custom_document_extraction_options] if args.key?(:custom_document_extraction_options)
10364
10868
  @document_schema = args[:document_schema] if args.key?(:document_schema)
10365
10869
  @input_data = args[:input_data] if args.key?(:input_data)
10366
10870
  @processor_version = args[:processor_version] if args.key?(:processor_version)
10367
10871
  end
10368
10872
  end
10369
10873
 
10874
+ # Options to control the training of the Custom Document Extraction (CDE)
10875
+ # Processor.
10876
+ class GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestCustomDocumentExtractionOptions
10877
+ include Google::Apis::Core::Hashable
10878
+
10879
+ # Training method to use for CDE training.
10880
+ # Corresponds to the JSON property `trainingMethod`
10881
+ # @return [String]
10882
+ attr_accessor :training_method
10883
+
10884
+ def initialize(**args)
10885
+ update!(**args)
10886
+ end
10887
+
10888
+ # Update properties of this object
10889
+ def update!(**args)
10890
+ @training_method = args[:training_method] if args.key?(:training_method)
10891
+ end
10892
+ end
10893
+
10370
10894
  # The input data used to train a new ProcessorVersion.
10371
10895
  class GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestInputData
10372
10896
  include Google::Apis::Core::Hashable
@@ -10456,6 +10980,25 @@ module Google
10456
10980
  end
10457
10981
  end
10458
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
+
10459
11002
  # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are
10460
11003
  # in the same scale as the original image.
10461
11004
  class GoogleCloudDocumentaiV1beta3Vertex
@@ -10702,7 +11245,7 @@ module Google
10702
11245
  # be trivially provided to the constructor of `java.awt.Color` in Java; it can
10703
11246
  # also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha`
10704
11247
  # method in iOS; and, with just a little work, it can be easily formatted into a
10705
- # CSS `rgba()` string in JavaScript. This reference page does not have
11248
+ # CSS `rgba()` string in JavaScript. This reference page doesn't have
10706
11249
  # information about the absolute color space that should be used to interpret
10707
11250
  # the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default,
10708
11251
  # applications should assume the sRGB color space. When color equality needs to