google-apis-documentai_v1beta3 0.9.0 → 0.14.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: f47eb993a9e4dccd9f637947d7f6207c9f3d866b503c6f7f0181b9e4f5ce0b1c
4
- data.tar.gz: '08c64bb4c92ceb007df09cd5f9bcf042a4ad915fe0a4cece3f01f666eb75e5d4'
3
+ metadata.gz: 9bf0a43f84c8fd4d869f0eb66c151ebf438e719231c6fb7976c298a1a7572f92
4
+ data.tar.gz: 4678a1a572bd3febcde1beec673998030cf648b4b6d09c32c6470ada92242f08
5
5
  SHA512:
6
- metadata.gz: 37533a944fa8050789d9bcaffb605c88bd3845afebd285e66964b5022eaeec5aa1d118c54494cdf2621a1512dd8cef98418be2d13ba79da4826aac583c76f9ef
7
- data.tar.gz: 3f0483bf770e0ef4019e6bd79f9fec2027e82159cb6f8c7dacc3686fad6df329a92ba1977d5e699cb354ac1f73d7e20d3f2f5589d8e3c257f41ae1f8652b67a4
6
+ metadata.gz: e6ae55ff767f0bc416205da32a373633da170dc4114ae795c085e75f2ab40d4712c12818f3dd01ace6ed0a81ba9764200ec2d500c4f755a9dd62908a4aa6fac6
7
+ data.tar.gz: 93bc58d62b5a1bade51eb98f7d4198b5bb29df809b52d55d9e95629347b6659fd654f64823553ed139da9fc9169990bb3396774d24a64828992fed6cc1d0463a
data/CHANGELOG.md CHANGED
@@ -1,5 +1,26 @@
1
1
  # Release history for google-apis-documentai_v1beta3
2
2
 
3
+ ### v0.14.0 (2021-06-09)
4
+
5
+ * Regenerated from discovery document revision 20210607
6
+
7
+ ### v0.13.0 (2021-06-03)
8
+
9
+ * Regenerated from discovery document revision 20210527
10
+ * Regenerated using generator version 0.3.0
11
+
12
+ ### v0.12.0 (2021-05-25)
13
+
14
+ * Regenerated from discovery document revision 20210520
15
+
16
+ ### v0.11.0 (2021-05-19)
17
+
18
+ * Unspecified changes
19
+
20
+ ### v0.10.0 (2021-05-12)
21
+
22
+ * Regenerated from discovery document revision 20210507
23
+
3
24
  ### v0.9.0 (2021-03-31)
4
25
 
5
26
  * Regenerated from discovery document revision 20210329
@@ -341,12 +341,22 @@ module Google
341
341
  class GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation
342
342
  include Google::Apis::Core::Hashable
343
343
 
344
+ # The total number of dataset errors.
345
+ # Corresponds to the JSON property `datasetErrorCount`
346
+ # @return [Fixnum]
347
+ attr_accessor :dataset_error_count
348
+
344
349
  # Error information for the dataset as a whole. A maximum of 10 dataset errors
345
350
  # will be returned. A single dataset error is terminal for training.
346
351
  # Corresponds to the JSON property `datasetErrors`
347
352
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleRpcStatus>]
348
353
  attr_accessor :dataset_errors
349
354
 
355
+ # The total number of document errors.
356
+ # Corresponds to the JSON property `documentErrorCount`
357
+ # @return [Fixnum]
358
+ attr_accessor :document_error_count
359
+
350
360
  # Error information pertaining to specific documents. A maximum of 10 document
351
361
  # errors will be returned. Any document with errors will not be used throughout
352
362
  # training.
@@ -360,7 +370,9 @@ module Google
360
370
 
361
371
  # Update properties of this object
362
372
  def update!(**args)
373
+ @dataset_error_count = args[:dataset_error_count] if args.key?(:dataset_error_count)
363
374
  @dataset_errors = args[:dataset_errors] if args.key?(:dataset_errors)
375
+ @document_error_count = args[:document_error_count] if args.key?(:document_error_count)
364
376
  @document_errors = args[:document_errors] if args.key?(:document_errors)
365
377
  end
366
378
  end
@@ -1072,6 +1084,12 @@ module Google
1072
1084
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentPageParagraph>]
1073
1085
  attr_accessor :paragraphs
1074
1086
 
1087
+ # Structure to identify provenance relationships between annotations in
1088
+ # different revisions.
1089
+ # Corresponds to the JSON property `provenance`
1090
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentProvenance]
1091
+ attr_accessor :provenance
1092
+
1075
1093
  # A list of visually detected tables on the page.
1076
1094
  # Corresponds to the JSON property `tables`
1077
1095
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentPageTable>]
@@ -1109,6 +1127,7 @@ module Google
1109
1127
  @lines = args[:lines] if args.key?(:lines)
1110
1128
  @page_number = args[:page_number] if args.key?(:page_number)
1111
1129
  @paragraphs = args[:paragraphs] if args.key?(:paragraphs)
1130
+ @provenance = args[:provenance] if args.key?(:provenance)
1112
1131
  @tables = args[:tables] if args.key?(:tables)
1113
1132
  @tokens = args[:tokens] if args.key?(:tokens)
1114
1133
  @transforms = args[:transforms] if args.key?(:transforms)
@@ -1146,6 +1165,11 @@ module Google
1146
1165
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1BoundingPoly]
1147
1166
  attr_accessor :bounding_poly
1148
1167
 
1168
+ # Optional. Confidence of detected page element, if applicable. Range [0, 1].
1169
+ # Corresponds to the JSON property `confidence`
1170
+ # @return [Float]
1171
+ attr_accessor :confidence
1172
+
1149
1173
  # Optional. Deprecated. Use PageRef.bounding_poly instead.
1150
1174
  # Corresponds to the JSON property `layoutId`
1151
1175
  # @return [String]
@@ -1157,7 +1181,9 @@ module Google
1157
1181
  attr_accessor :layout_type
1158
1182
 
1159
1183
  # Required. Index into the Document.pages element, for example using Document.
1160
- # pages to locate the related page element.
1184
+ # pages to locate the related page element. This field is skipped when its value
1185
+ # is the default 0. See https://developers.google.com/protocol-buffers/docs/
1186
+ # proto3#json.
1161
1187
  # Corresponds to the JSON property `page`
1162
1188
  # @return [Fixnum]
1163
1189
  attr_accessor :page
@@ -1169,6 +1195,7 @@ module Google
1169
1195
  # Update properties of this object
1170
1196
  def update!(**args)
1171
1197
  @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly)
1198
+ @confidence = args[:confidence] if args.key?(:confidence)
1172
1199
  @layout_id = args[:layout_id] if args.key?(:layout_id)
1173
1200
  @layout_type = args[:layout_type] if args.key?(:layout_type)
1174
1201
  @page = args[:page] if args.key?(:page)
@@ -1284,6 +1311,12 @@ module Google
1284
1311
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage>]
1285
1312
  attr_accessor :name_detected_languages
1286
1313
 
1314
+ # Structure to identify provenance relationships between annotations in
1315
+ # different revisions.
1316
+ # Corresponds to the JSON property `provenance`
1317
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentProvenance]
1318
+ attr_accessor :provenance
1319
+
1287
1320
  # A list of detected languages for value together with confidence.
1288
1321
  # Corresponds to the JSON property `valueDetectedLanguages`
1289
1322
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage>]
@@ -1305,6 +1338,7 @@ module Google
1305
1338
  @field_name = args[:field_name] if args.key?(:field_name)
1306
1339
  @field_value = args[:field_value] if args.key?(:field_value)
1307
1340
  @name_detected_languages = args[:name_detected_languages] if args.key?(:name_detected_languages)
1341
+ @provenance = args[:provenance] if args.key?(:provenance)
1308
1342
  @value_detected_languages = args[:value_detected_languages] if args.key?(:value_detected_languages)
1309
1343
  @value_type = args[:value_type] if args.key?(:value_type)
1310
1344
  end
@@ -1723,6 +1757,12 @@ module Google
1723
1757
  # @return [Fixnum]
1724
1758
  attr_accessor :id
1725
1759
 
1760
+ # The index of the parent revisions corresponding collection of items (eg. list
1761
+ # of entities, properties within entities, etc.)
1762
+ # Corresponds to the JSON property `index`
1763
+ # @return [Fixnum]
1764
+ attr_accessor :index
1765
+
1726
1766
  # The index of the [Document.revisions] identifying the parent revision.
1727
1767
  # Corresponds to the JSON property `revision`
1728
1768
  # @return [Fixnum]
@@ -1735,6 +1775,7 @@ module Google
1735
1775
  # Update properties of this object
1736
1776
  def update!(**args)
1737
1777
  @id = args[:id] if args.key?(:id)
1778
+ @index = args[:index] if args.key?(:index)
1738
1779
  @revision = args[:revision] if args.key?(:revision)
1739
1780
  end
1740
1781
  end
@@ -2767,6 +2808,12 @@ module Google
2767
2808
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentPageParagraph>]
2768
2809
  attr_accessor :paragraphs
2769
2810
 
2811
+ # Structure to identify provenance relationships between annotations in
2812
+ # different revisions.
2813
+ # Corresponds to the JSON property `provenance`
2814
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentProvenance]
2815
+ attr_accessor :provenance
2816
+
2770
2817
  # A list of visually detected tables on the page.
2771
2818
  # Corresponds to the JSON property `tables`
2772
2819
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentPageTable>]
@@ -2804,6 +2851,7 @@ module Google
2804
2851
  @lines = args[:lines] if args.key?(:lines)
2805
2852
  @page_number = args[:page_number] if args.key?(:page_number)
2806
2853
  @paragraphs = args[:paragraphs] if args.key?(:paragraphs)
2854
+ @provenance = args[:provenance] if args.key?(:provenance)
2807
2855
  @tables = args[:tables] if args.key?(:tables)
2808
2856
  @tokens = args[:tokens] if args.key?(:tokens)
2809
2857
  @transforms = args[:transforms] if args.key?(:transforms)
@@ -2841,6 +2889,11 @@ module Google
2841
2889
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2BoundingPoly]
2842
2890
  attr_accessor :bounding_poly
2843
2891
 
2892
+ # Optional. Confidence of detected page element, if applicable. Range [0, 1].
2893
+ # Corresponds to the JSON property `confidence`
2894
+ # @return [Float]
2895
+ attr_accessor :confidence
2896
+
2844
2897
  # Optional. Deprecated. Use PageRef.bounding_poly instead.
2845
2898
  # Corresponds to the JSON property `layoutId`
2846
2899
  # @return [String]
@@ -2852,7 +2905,9 @@ module Google
2852
2905
  attr_accessor :layout_type
2853
2906
 
2854
2907
  # Required. Index into the Document.pages element, for example using Document.
2855
- # pages to locate the related page element.
2908
+ # pages to locate the related page element. This field is skipped when its value
2909
+ # is the default 0. See https://developers.google.com/protocol-buffers/docs/
2910
+ # proto3#json.
2856
2911
  # Corresponds to the JSON property `page`
2857
2912
  # @return [Fixnum]
2858
2913
  attr_accessor :page
@@ -2864,6 +2919,7 @@ module Google
2864
2919
  # Update properties of this object
2865
2920
  def update!(**args)
2866
2921
  @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly)
2922
+ @confidence = args[:confidence] if args.key?(:confidence)
2867
2923
  @layout_id = args[:layout_id] if args.key?(:layout_id)
2868
2924
  @layout_type = args[:layout_type] if args.key?(:layout_type)
2869
2925
  @page = args[:page] if args.key?(:page)
@@ -2979,6 +3035,12 @@ module Google
2979
3035
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage>]
2980
3036
  attr_accessor :name_detected_languages
2981
3037
 
3038
+ # Structure to identify provenance relationships between annotations in
3039
+ # different revisions.
3040
+ # Corresponds to the JSON property `provenance`
3041
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentProvenance]
3042
+ attr_accessor :provenance
3043
+
2982
3044
  # A list of detected languages for value together with confidence.
2983
3045
  # Corresponds to the JSON property `valueDetectedLanguages`
2984
3046
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage>]
@@ -3000,6 +3062,7 @@ module Google
3000
3062
  @field_name = args[:field_name] if args.key?(:field_name)
3001
3063
  @field_value = args[:field_value] if args.key?(:field_value)
3002
3064
  @name_detected_languages = args[:name_detected_languages] if args.key?(:name_detected_languages)
3065
+ @provenance = args[:provenance] if args.key?(:provenance)
3003
3066
  @value_detected_languages = args[:value_detected_languages] if args.key?(:value_detected_languages)
3004
3067
  @value_type = args[:value_type] if args.key?(:value_type)
3005
3068
  end
@@ -3418,6 +3481,12 @@ module Google
3418
3481
  # @return [Fixnum]
3419
3482
  attr_accessor :id
3420
3483
 
3484
+ # The index of the parent revisions corresponding collection of items (eg. list
3485
+ # of entities, properties within entities, etc.)
3486
+ # Corresponds to the JSON property `index`
3487
+ # @return [Fixnum]
3488
+ attr_accessor :index
3489
+
3421
3490
  # The index of the [Document.revisions] identifying the parent revision.
3422
3491
  # Corresponds to the JSON property `revision`
3423
3492
  # @return [Fixnum]
@@ -3430,6 +3499,7 @@ module Google
3430
3499
  # Update properties of this object
3431
3500
  def update!(**args)
3432
3501
  @id = args[:id] if args.key?(:id)
3502
+ @index = args[:index] if args.key?(:index)
3433
3503
  @revision = args[:revision] if args.key?(:revision)
3434
3504
  end
3435
3505
  end
@@ -4315,6 +4385,71 @@ module Google
4315
4385
  end
4316
4386
  end
4317
4387
 
4388
+ # The long running operation metadata for delete processor method.
4389
+ class GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata
4390
+ include Google::Apis::Core::Hashable
4391
+
4392
+ # The common metadata for long running operations.
4393
+ # Corresponds to the JSON property `commonMetadata`
4394
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
4395
+ attr_accessor :common_metadata
4396
+
4397
+ def initialize(**args)
4398
+ update!(**args)
4399
+ end
4400
+
4401
+ # Update properties of this object
4402
+ def update!(**args)
4403
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
4404
+ end
4405
+ end
4406
+
4407
+ # The long running operation metadata for disable processor method.
4408
+ class GoogleCloudDocumentaiV1beta3DisableProcessorMetadata
4409
+ include Google::Apis::Core::Hashable
4410
+
4411
+ # The common metadata for long running operations.
4412
+ # Corresponds to the JSON property `commonMetadata`
4413
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
4414
+ attr_accessor :common_metadata
4415
+
4416
+ def initialize(**args)
4417
+ update!(**args)
4418
+ end
4419
+
4420
+ # Update properties of this object
4421
+ def update!(**args)
4422
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
4423
+ end
4424
+ end
4425
+
4426
+ # Request message for the disable processor method.
4427
+ class GoogleCloudDocumentaiV1beta3DisableProcessorRequest
4428
+ include Google::Apis::Core::Hashable
4429
+
4430
+ def initialize(**args)
4431
+ update!(**args)
4432
+ end
4433
+
4434
+ # Update properties of this object
4435
+ def update!(**args)
4436
+ end
4437
+ end
4438
+
4439
+ # Response message for the disable processor method. Intentionally empty proto
4440
+ # for adding fields in future.
4441
+ class GoogleCloudDocumentaiV1beta3DisableProcessorResponse
4442
+ include Google::Apis::Core::Hashable
4443
+
4444
+ def initialize(**args)
4445
+ update!(**args)
4446
+ end
4447
+
4448
+ # Update properties of this object
4449
+ def update!(**args)
4450
+ end
4451
+ end
4452
+
4318
4453
  # Document represents the canonical document resource in Document Understanding
4319
4454
  # AI. It is an interchange format that provides insights into documents and
4320
4455
  # allows for collaboration between users and Document Understanding AI to
@@ -4714,6 +4849,12 @@ module Google
4714
4849
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageParagraph>]
4715
4850
  attr_accessor :paragraphs
4716
4851
 
4852
+ # Structure to identify provenance relationships between annotations in
4853
+ # different revisions.
4854
+ # Corresponds to the JSON property `provenance`
4855
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentProvenance]
4856
+ attr_accessor :provenance
4857
+
4717
4858
  # A list of visually detected tables on the page.
4718
4859
  # Corresponds to the JSON property `tables`
4719
4860
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageTable>]
@@ -4751,6 +4892,7 @@ module Google
4751
4892
  @lines = args[:lines] if args.key?(:lines)
4752
4893
  @page_number = args[:page_number] if args.key?(:page_number)
4753
4894
  @paragraphs = args[:paragraphs] if args.key?(:paragraphs)
4895
+ @provenance = args[:provenance] if args.key?(:provenance)
4754
4896
  @tables = args[:tables] if args.key?(:tables)
4755
4897
  @tokens = args[:tokens] if args.key?(:tokens)
4756
4898
  @transforms = args[:transforms] if args.key?(:transforms)
@@ -4788,6 +4930,11 @@ module Google
4788
4930
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BoundingPoly]
4789
4931
  attr_accessor :bounding_poly
4790
4932
 
4933
+ # Optional. Confidence of detected page element, if applicable. Range [0, 1].
4934
+ # Corresponds to the JSON property `confidence`
4935
+ # @return [Float]
4936
+ attr_accessor :confidence
4937
+
4791
4938
  # Optional. Deprecated. Use PageRef.bounding_poly instead.
4792
4939
  # Corresponds to the JSON property `layoutId`
4793
4940
  # @return [String]
@@ -4799,7 +4946,9 @@ module Google
4799
4946
  attr_accessor :layout_type
4800
4947
 
4801
4948
  # Required. Index into the Document.pages element, for example using Document.
4802
- # pages to locate the related page element.
4949
+ # pages to locate the related page element. This field is skipped when its value
4950
+ # is the default 0. See https://developers.google.com/protocol-buffers/docs/
4951
+ # proto3#json.
4803
4952
  # Corresponds to the JSON property `page`
4804
4953
  # @return [Fixnum]
4805
4954
  attr_accessor :page
@@ -4811,6 +4960,7 @@ module Google
4811
4960
  # Update properties of this object
4812
4961
  def update!(**args)
4813
4962
  @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly)
4963
+ @confidence = args[:confidence] if args.key?(:confidence)
4814
4964
  @layout_id = args[:layout_id] if args.key?(:layout_id)
4815
4965
  @layout_type = args[:layout_type] if args.key?(:layout_type)
4816
4966
  @page = args[:page] if args.key?(:page)
@@ -4926,6 +5076,12 @@ module Google
4926
5076
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage>]
4927
5077
  attr_accessor :name_detected_languages
4928
5078
 
5079
+ # Structure to identify provenance relationships between annotations in
5080
+ # different revisions.
5081
+ # Corresponds to the JSON property `provenance`
5082
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentProvenance]
5083
+ attr_accessor :provenance
5084
+
4929
5085
  # A list of detected languages for value together with confidence.
4930
5086
  # Corresponds to the JSON property `valueDetectedLanguages`
4931
5087
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage>]
@@ -4947,6 +5103,7 @@ module Google
4947
5103
  @field_name = args[:field_name] if args.key?(:field_name)
4948
5104
  @field_value = args[:field_value] if args.key?(:field_value)
4949
5105
  @name_detected_languages = args[:name_detected_languages] if args.key?(:name_detected_languages)
5106
+ @provenance = args[:provenance] if args.key?(:provenance)
4950
5107
  @value_detected_languages = args[:value_detected_languages] if args.key?(:value_detected_languages)
4951
5108
  @value_type = args[:value_type] if args.key?(:value_type)
4952
5109
  end
@@ -5365,6 +5522,12 @@ module Google
5365
5522
  # @return [Fixnum]
5366
5523
  attr_accessor :id
5367
5524
 
5525
+ # The index of the parent revisions corresponding collection of items (eg. list
5526
+ # of entities, properties within entities, etc.)
5527
+ # Corresponds to the JSON property `index`
5528
+ # @return [Fixnum]
5529
+ attr_accessor :index
5530
+
5368
5531
  # The index of the [Document.revisions] identifying the parent revision.
5369
5532
  # Corresponds to the JSON property `revision`
5370
5533
  # @return [Fixnum]
@@ -5377,6 +5540,7 @@ module Google
5377
5540
  # Update properties of this object
5378
5541
  def update!(**args)
5379
5542
  @id = args[:id] if args.key?(:id)
5543
+ @index = args[:index] if args.key?(:index)
5380
5544
  @revision = args[:revision] if args.key?(:revision)
5381
5545
  end
5382
5546
  end
@@ -5748,6 +5912,71 @@ module Google
5748
5912
  end
5749
5913
  end
5750
5914
 
5915
+ # The long running operation metadata for enable processor method.
5916
+ class GoogleCloudDocumentaiV1beta3EnableProcessorMetadata
5917
+ include Google::Apis::Core::Hashable
5918
+
5919
+ # The common metadata for long running operations.
5920
+ # Corresponds to the JSON property `commonMetadata`
5921
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
5922
+ attr_accessor :common_metadata
5923
+
5924
+ def initialize(**args)
5925
+ update!(**args)
5926
+ end
5927
+
5928
+ # Update properties of this object
5929
+ def update!(**args)
5930
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
5931
+ end
5932
+ end
5933
+
5934
+ # Request message for the enable processor method.
5935
+ class GoogleCloudDocumentaiV1beta3EnableProcessorRequest
5936
+ include Google::Apis::Core::Hashable
5937
+
5938
+ def initialize(**args)
5939
+ update!(**args)
5940
+ end
5941
+
5942
+ # Update properties of this object
5943
+ def update!(**args)
5944
+ end
5945
+ end
5946
+
5947
+ # Response message for the enable processor method. Intentionally empty proto
5948
+ # for adding fields in future.
5949
+ class GoogleCloudDocumentaiV1beta3EnableProcessorResponse
5950
+ include Google::Apis::Core::Hashable
5951
+
5952
+ def initialize(**args)
5953
+ update!(**args)
5954
+ end
5955
+
5956
+ # Update properties of this object
5957
+ def update!(**args)
5958
+ end
5959
+ end
5960
+
5961
+ # Response message for fetch processor types.
5962
+ class GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse
5963
+ include Google::Apis::Core::Hashable
5964
+
5965
+ # The list of processor types.
5966
+ # Corresponds to the JSON property `processorTypes`
5967
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessorType>]
5968
+ attr_accessor :processor_types
5969
+
5970
+ def initialize(**args)
5971
+ update!(**args)
5972
+ end
5973
+
5974
+ # Update properties of this object
5975
+ def update!(**args)
5976
+ @processor_types = args[:processor_types] if args.key?(:processor_types)
5977
+ end
5978
+ end
5979
+
5751
5980
  # Specifies a document stored on Cloud Storage.
5752
5981
  class GoogleCloudDocumentaiV1beta3GcsDocument
5753
5982
  include Google::Apis::Core::Hashable
@@ -5845,6 +6074,31 @@ module Google
5845
6074
  end
5846
6075
  end
5847
6076
 
6077
+ # Response message for list processors.
6078
+ class GoogleCloudDocumentaiV1beta3ListProcessorsResponse
6079
+ include Google::Apis::Core::Hashable
6080
+
6081
+ # Points to the next processor, otherwise empty.
6082
+ # Corresponds to the JSON property `nextPageToken`
6083
+ # @return [String]
6084
+ attr_accessor :next_page_token
6085
+
6086
+ # The list of processors.
6087
+ # Corresponds to the JSON property `processors`
6088
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor>]
6089
+ attr_accessor :processors
6090
+
6091
+ def initialize(**args)
6092
+ update!(**args)
6093
+ end
6094
+
6095
+ # Update properties of this object
6096
+ def update!(**args)
6097
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
6098
+ @processors = args[:processors] if args.key?(:processors)
6099
+ end
6100
+ end
6101
+
5848
6102
  # A vertex represents a 2D point in the image. NOTE: the normalized vertex
5849
6103
  # coordinates are relative to the original image and range from 0 to 1.
5850
6104
  class GoogleCloudDocumentaiV1beta3NormalizedVertex
@@ -5953,6 +6207,158 @@ module Google
5953
6207
  end
5954
6208
  end
5955
6209
 
6210
+ # The first-class citizen for DAI. Each processor defines how to extract
6211
+ # structural information from a document.
6212
+ class GoogleCloudDocumentaiV1beta3Processor
6213
+ include Google::Apis::Core::Hashable
6214
+
6215
+ # The time the processor was created.
6216
+ # Corresponds to the JSON property `createTime`
6217
+ # @return [String]
6218
+ attr_accessor :create_time
6219
+
6220
+ # The default processor version.
6221
+ # Corresponds to the JSON property `defaultProcessorVersion`
6222
+ # @return [String]
6223
+ attr_accessor :default_processor_version
6224
+
6225
+ # The display name of the processor.
6226
+ # Corresponds to the JSON property `displayName`
6227
+ # @return [String]
6228
+ attr_accessor :display_name
6229
+
6230
+ # The KMS key used for encryption/decryption in CMEK scenarios. See https://
6231
+ # cloud.google.com/security-key-management.
6232
+ # Corresponds to the JSON property `kmsKeyName`
6233
+ # @return [String]
6234
+ attr_accessor :kms_key_name
6235
+
6236
+ # Output only. Immutable. The resource name of the processor. Format: projects/`
6237
+ # project`/locations/`location`/processors/`processor`
6238
+ # Corresponds to the JSON property `name`
6239
+ # @return [String]
6240
+ attr_accessor :name
6241
+
6242
+ # Output only. Immutable. The http endpoint that can be called to invoke
6243
+ # processing.
6244
+ # Corresponds to the JSON property `processEndpoint`
6245
+ # @return [String]
6246
+ attr_accessor :process_endpoint
6247
+
6248
+ # Output only. The state of the processor.
6249
+ # Corresponds to the JSON property `state`
6250
+ # @return [String]
6251
+ attr_accessor :state
6252
+
6253
+ # The processor type, e.g., INVOICE_PARSING, W2_PARSING, etc.
6254
+ # Corresponds to the JSON property `type`
6255
+ # @return [String]
6256
+ attr_accessor :type
6257
+
6258
+ def initialize(**args)
6259
+ update!(**args)
6260
+ end
6261
+
6262
+ # Update properties of this object
6263
+ def update!(**args)
6264
+ @create_time = args[:create_time] if args.key?(:create_time)
6265
+ @default_processor_version = args[:default_processor_version] if args.key?(:default_processor_version)
6266
+ @display_name = args[:display_name] if args.key?(:display_name)
6267
+ @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
6268
+ @name = args[:name] if args.key?(:name)
6269
+ @process_endpoint = args[:process_endpoint] if args.key?(:process_endpoint)
6270
+ @state = args[:state] if args.key?(:state)
6271
+ @type = args[:type] if args.key?(:type)
6272
+ end
6273
+ end
6274
+
6275
+ # A processor type is responsible for performing a certain document
6276
+ # understanding task on a certain type of document. All processor types are
6277
+ # created by the documentai service internally. User will only list all
6278
+ # available processor types via UI. For different users (projects), the
6279
+ # available processor types may be different since we'll expose the access of
6280
+ # some types via EAP whitelisting. We make the ProcessorType a resource under
6281
+ # location so we have a unified API and keep the possibility that UI will load
6282
+ # different available processor types from different regions. But for alpha the
6283
+ # behavior is that the user will always get the union of all available processor
6284
+ # types among all regions no matter which regionalized endpoint is called, and
6285
+ # then we use the 'available_locations' field to show under which regions a
6286
+ # processor type is available. For example, users can call either the 'US' or '
6287
+ # EU' endpoint to feach processor types. In the return, we will have an 'invoice
6288
+ # parsing' processor with 'available_locations' field only containing 'US'. So
6289
+ # the user can try to create an 'invoice parsing' processor under the location '
6290
+ # US'. Such attempt of creating under the location 'EU' will fail. Next ID: 7.
6291
+ class GoogleCloudDocumentaiV1beta3ProcessorType
6292
+ include Google::Apis::Core::Hashable
6293
+
6294
+ # Whether the processor type allows creation. If yes, user can create a
6295
+ # processor of this processor type. Otherwise, user needs to require for
6296
+ # whitelisting.
6297
+ # Corresponds to the JSON property `allowCreation`
6298
+ # @return [Boolean]
6299
+ attr_accessor :allow_creation
6300
+ alias_method :allow_creation?, :allow_creation
6301
+
6302
+ # The locations in which this processor is available.
6303
+ # Corresponds to the JSON property `availableLocations`
6304
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo>]
6305
+ attr_accessor :available_locations
6306
+
6307
+ # The processor category, used by UI to group processor types.
6308
+ # Corresponds to the JSON property `category`
6309
+ # @return [String]
6310
+ attr_accessor :category
6311
+
6312
+ # The resource name of the processor type. Format: projects/`project`/
6313
+ # processorTypes/`processor_type`
6314
+ # Corresponds to the JSON property `name`
6315
+ # @return [String]
6316
+ attr_accessor :name
6317
+
6318
+ # The schema defines the output of the processed document by a processor.
6319
+ # Corresponds to the JSON property `schema`
6320
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Schema]
6321
+ attr_accessor :schema
6322
+
6323
+ # The type of the processor, e.g, "invoice_parsing".
6324
+ # Corresponds to the JSON property `type`
6325
+ # @return [String]
6326
+ attr_accessor :type
6327
+
6328
+ def initialize(**args)
6329
+ update!(**args)
6330
+ end
6331
+
6332
+ # Update properties of this object
6333
+ def update!(**args)
6334
+ @allow_creation = args[:allow_creation] if args.key?(:allow_creation)
6335
+ @available_locations = args[:available_locations] if args.key?(:available_locations)
6336
+ @category = args[:category] if args.key?(:category)
6337
+ @name = args[:name] if args.key?(:name)
6338
+ @schema = args[:schema] if args.key?(:schema)
6339
+ @type = args[:type] if args.key?(:type)
6340
+ end
6341
+ end
6342
+
6343
+ # The location information about where the processor is available.
6344
+ class GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo
6345
+ include Google::Apis::Core::Hashable
6346
+
6347
+ # The location id, currently must be one of [us, eu].
6348
+ # Corresponds to the JSON property `locationId`
6349
+ # @return [String]
6350
+ attr_accessor :location_id
6351
+
6352
+ def initialize(**args)
6353
+ update!(**args)
6354
+ end
6355
+
6356
+ # Update properties of this object
6357
+ def update!(**args)
6358
+ @location_id = args[:location_id] if args.key?(:location_id)
6359
+ end
6360
+ end
6361
+
5956
6362
  # Payload message of raw document content (bytes).
5957
6363
  class GoogleCloudDocumentaiV1beta3RawDocument
5958
6364
  include Google::Apis::Core::Hashable
@@ -6023,7 +6429,7 @@ module Google
6023
6429
  end
6024
6430
  end
6025
6431
 
6026
- # Request message for review document method.
6432
+ # Request message for review document method. Next Id: 6.
6027
6433
  class GoogleCloudDocumentaiV1beta3ReviewDocumentRequest
6028
6434
  include Google::Apis::Core::Hashable
6029
6435
 
@@ -6035,6 +6441,12 @@ module Google
6035
6441
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document]
6036
6442
  attr_accessor :document
6037
6443
 
6444
+ # Whether the validation should be performed on the ad-hoc review request.
6445
+ # Corresponds to the JSON property `enableSchemaValidation`
6446
+ # @return [Boolean]
6447
+ attr_accessor :enable_schema_validation
6448
+ alias_method :enable_schema_validation?, :enable_schema_validation
6449
+
6038
6450
  # Document represents the canonical document resource in Document Understanding
6039
6451
  # AI. It is an interchange format that provides insights into documents and
6040
6452
  # allows for collaboration between users and Document Understanding AI to
@@ -6043,6 +6455,11 @@ module Google
6043
6455
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document]
6044
6456
  attr_accessor :inline_document
6045
6457
 
6458
+ # The priority of the human review task.
6459
+ # Corresponds to the JSON property `priority`
6460
+ # @return [String]
6461
+ attr_accessor :priority
6462
+
6046
6463
  def initialize(**args)
6047
6464
  update!(**args)
6048
6465
  end
@@ -6050,7 +6467,9 @@ module Google
6050
6467
  # Update properties of this object
6051
6468
  def update!(**args)
6052
6469
  @document = args[:document] if args.key?(:document)
6470
+ @enable_schema_validation = args[:enable_schema_validation] if args.key?(:enable_schema_validation)
6053
6471
  @inline_document = args[:inline_document] if args.key?(:inline_document)
6472
+ @priority = args[:priority] if args.key?(:priority)
6054
6473
  end
6055
6474
  end
6056
6475
 
@@ -6073,6 +6492,105 @@ module Google
6073
6492
  end
6074
6493
  end
6075
6494
 
6495
+ # The schema defines the output of the processed document by a processor.
6496
+ class GoogleCloudDocumentaiV1beta3Schema
6497
+ include Google::Apis::Core::Hashable
6498
+
6499
+ # Description of the schema.
6500
+ # Corresponds to the JSON property `description`
6501
+ # @return [String]
6502
+ attr_accessor :description
6503
+
6504
+ # Display name to show to users.
6505
+ # Corresponds to the JSON property `displayName`
6506
+ # @return [String]
6507
+ attr_accessor :display_name
6508
+
6509
+ # Entity types of the schema.
6510
+ # Corresponds to the JSON property `entityTypes`
6511
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaEntityType>]
6512
+ attr_accessor :entity_types
6513
+
6514
+ def initialize(**args)
6515
+ update!(**args)
6516
+ end
6517
+
6518
+ # Update properties of this object
6519
+ def update!(**args)
6520
+ @description = args[:description] if args.key?(:description)
6521
+ @display_name = args[:display_name] if args.key?(:display_name)
6522
+ @entity_types = args[:entity_types] if args.key?(:entity_types)
6523
+ end
6524
+ end
6525
+
6526
+ # EntityType is the wrapper of a label of the corresponding model with detailed
6527
+ # attributes and limitations for entity-based processors. Multiple types can
6528
+ # also compose a dependency tree to represent nested types.
6529
+ class GoogleCloudDocumentaiV1beta3SchemaEntityType
6530
+ include Google::Apis::Core::Hashable
6531
+
6532
+ # Type of the entity. It must be one of the following: `document` - the entity
6533
+ # represents a classification of a logical document. `object` - if the entity
6534
+ # has properties it is likely an object (or or a document.) `datetime` - the
6535
+ # entity is a date or time value. `money` - the entity represents a money value
6536
+ # amount. `number` - the entity is a number - integer or floating point. `string`
6537
+ # - the entity is a string value. `boolean` - the entity is a boolean value. `
6538
+ # address` - the entity is a location address.
6539
+ # Corresponds to the JSON property `baseType`
6540
+ # @return [String]
6541
+ attr_accessor :base_type
6542
+
6543
+ # Description of the entity type.
6544
+ # Corresponds to the JSON property `description`
6545
+ # @return [String]
6546
+ attr_accessor :description
6547
+
6548
+ # If specified, lists all the possible values for this entity.
6549
+ # Corresponds to the JSON property `enumValues`
6550
+ # @return [Array<String>]
6551
+ attr_accessor :enum_values
6552
+
6553
+ # Occurrence type limits the number of times an entity type appears in the
6554
+ # document.
6555
+ # Corresponds to the JSON property `occurrenceType`
6556
+ # @return [String]
6557
+ attr_accessor :occurrence_type
6558
+
6559
+ # Describing the nested structure of an entity. An EntityType may consist of
6560
+ # several other EntityTypes. For example, in a document there can be an
6561
+ # EntityType 'ID', which consists of EntityType 'name' and 'address', with
6562
+ # corresponding attributes, such as TEXT for both types and ONCE for occurrence
6563
+ # types.
6564
+ # Corresponds to the JSON property `properties`
6565
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaEntityType>]
6566
+ attr_accessor :properties
6567
+
6568
+ # Source of this entity type.
6569
+ # Corresponds to the JSON property `source`
6570
+ # @return [String]
6571
+ attr_accessor :source
6572
+
6573
+ # Name of the type. It must be unique within the set of same level types.
6574
+ # Corresponds to the JSON property `type`
6575
+ # @return [String]
6576
+ attr_accessor :type
6577
+
6578
+ def initialize(**args)
6579
+ update!(**args)
6580
+ end
6581
+
6582
+ # Update properties of this object
6583
+ def update!(**args)
6584
+ @base_type = args[:base_type] if args.key?(:base_type)
6585
+ @description = args[:description] if args.key?(:description)
6586
+ @enum_values = args[:enum_values] if args.key?(:enum_values)
6587
+ @occurrence_type = args[:occurrence_type] if args.key?(:occurrence_type)
6588
+ @properties = args[:properties] if args.key?(:properties)
6589
+ @source = args[:source] if args.key?(:source)
6590
+ @type = args[:type] if args.key?(:type)
6591
+ end
6592
+ end
6593
+
6076
6594
  # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are
6077
6595
  # in the same scale as the original image.
6078
6596
  class GoogleCloudDocumentaiV1beta3Vertex
@@ -6171,6 +6689,31 @@ module Google
6171
6689
  end
6172
6690
  end
6173
6691
 
6692
+ # The response message for Operations.ListOperations.
6693
+ class GoogleLongrunningListOperationsResponse
6694
+ include Google::Apis::Core::Hashable
6695
+
6696
+ # The standard List next-page token.
6697
+ # Corresponds to the JSON property `nextPageToken`
6698
+ # @return [String]
6699
+ attr_accessor :next_page_token
6700
+
6701
+ # A list of operations that matches the specified filter in the request.
6702
+ # Corresponds to the JSON property `operations`
6703
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation>]
6704
+ attr_accessor :operations
6705
+
6706
+ def initialize(**args)
6707
+ update!(**args)
6708
+ end
6709
+
6710
+ # Update properties of this object
6711
+ def update!(**args)
6712
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
6713
+ @operations = args[:operations] if args.key?(:operations)
6714
+ end
6715
+ end
6716
+
6174
6717
  # This resource represents a long-running operation that is the result of a
6175
6718
  # network API call.
6176
6719
  class GoogleLongrunningOperation