google-apis-documentai_v1 0.63.0 → 0.64.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: 43db6290c43e1cfb212461f5626c896b0de1d560f89879ad0ff49059039fe9bf
4
- data.tar.gz: c4f8e159b6324217dd68f1f4ebf79b0682abcbadecf35c8db50a122d706d8b23
3
+ metadata.gz: eeb2482c6e70187ff504d06d62ce657d6dd542dd4a1e3a75150a775cc108a1c6
4
+ data.tar.gz: 4f9906f7f37ce3f98d5dab78e2284187049476906c1d97d50cafb26c358823c1
5
5
  SHA512:
6
- metadata.gz: 00f008ddb3c53d58b568946635df78e7ec2e387076178a27125cb2f31d1da115445147c5edb3afd2f5bb34044d1ce3a1acea2365623efc09e352a80b1f4149c7
7
- data.tar.gz: 3429756cf931dcbc46473acc83da86f8c634c0c47d7b3db0f14f7b1503ce4767beade2d7ae82cbd499b0c434e1ec32c77b7fc17e80edeb0d4e1da40e1ab5c459
6
+ metadata.gz: 3dbfa62e64cca965bcd2a028502493cf1b20cce6fdafb6725561f1a7eac49af47140ccea8b93ced7b42ed9b9fbf8105b704d56942e3399e9713bc50b9af24716
7
+ data.tar.gz: '00886cb16e031f4d5f62e9a7a93448ce6ab7dec7140abafe0b25420bcd9e112b07f6442c53dd55277fc18cb866b73308abbfe687bba6e236f973b9edae61d256'
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-documentai_v1
2
2
 
3
+ ### v0.64.0 (2023-05-14)
4
+
5
+ * Regenerated from discovery document revision 20230504
6
+
3
7
  ### v0.63.0 (2023-04-30)
4
8
 
5
9
  * Regenerated from discovery document revision 20230420
@@ -300,7 +300,7 @@ module Google
300
300
  end
301
301
  end
302
302
 
303
- # The long-running operation metadata for CreateLabelerPool.
303
+ # The long-running operation metadata for the CreateLabelerPool method.
304
304
  class GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata
305
305
  include Google::Apis::Core::Hashable
306
306
 
@@ -338,7 +338,7 @@ module Google
338
338
  end
339
339
  end
340
340
 
341
- # The long-running operation metadata for delete processor method.
341
+ # The long-running operation metadata for the DeleteProcessor method.
342
342
  class GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata
343
343
  include Google::Apis::Core::Hashable
344
344
 
@@ -357,7 +357,7 @@ module Google
357
357
  end
358
358
  end
359
359
 
360
- # The long-running operation metadata for delete processor version method.
360
+ # The long-running operation metadata for the DeleteProcessorVersion method.
361
361
  class GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata
362
362
  include Google::Apis::Core::Hashable
363
363
 
@@ -376,7 +376,7 @@ module Google
376
376
  end
377
377
  end
378
378
 
379
- # The long-running operation metadata for deploy processor version method.
379
+ # The long-running operation metadata for the DeployProcessorVersion method.
380
380
  class GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata
381
381
  include Google::Apis::Core::Hashable
382
382
 
@@ -395,7 +395,7 @@ module Google
395
395
  end
396
396
  end
397
397
 
398
- # Response message for the deploy processor version method.
398
+ # Response message for the DeployProcessorVersion method.
399
399
  class GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse
400
400
  include Google::Apis::Core::Hashable
401
401
 
@@ -408,7 +408,7 @@ module Google
408
408
  end
409
409
  end
410
410
 
411
- # The long-running operation metadata for disable processor method.
411
+ # The long-running operation metadata for the DisableProcessor method.
412
412
  class GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata
413
413
  include Google::Apis::Core::Hashable
414
414
 
@@ -427,7 +427,7 @@ module Google
427
427
  end
428
428
  end
429
429
 
430
- # Response message for the disable processor method. Intentionally empty proto
430
+ # Response message for the DisableProcessor method. Intentionally empty proto
431
431
  # for adding fields in future.
432
432
  class GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse
433
433
  include Google::Apis::Core::Hashable
@@ -493,7 +493,7 @@ module Google
493
493
  end
494
494
  end
495
495
 
496
- # The long-running operation metadata for enable processor method.
496
+ # The long-running operation metadata for the EnableProcessor method.
497
497
  class GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata
498
498
  include Google::Apis::Core::Hashable
499
499
 
@@ -512,8 +512,8 @@ module Google
512
512
  end
513
513
  end
514
514
 
515
- # Response message for the enable processor method. Intentionally empty proto
516
- # for adding fields in future.
515
+ # Response message for the EnableProcessor method. Intentionally empty proto for
516
+ # adding fields in future.
517
517
  class GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse
518
518
  include Google::Apis::Core::Hashable
519
519
 
@@ -1010,7 +1010,64 @@ module Google
1010
1010
  end
1011
1011
  end
1012
1012
 
1013
- # The long-running operation metadata for set default processor version method.
1013
+ # Metadata of the sample documents operation.
1014
+ class GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata
1015
+ include Google::Apis::Core::Hashable
1016
+
1017
+ # The common metadata for long running operations.
1018
+ # Corresponds to the JSON property `commonMetadata`
1019
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata]
1020
+ attr_accessor :common_metadata
1021
+
1022
+ def initialize(**args)
1023
+ update!(**args)
1024
+ end
1025
+
1026
+ # Update properties of this object
1027
+ def update!(**args)
1028
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
1029
+ end
1030
+ end
1031
+
1032
+ # Response of the sample documents operation.
1033
+ class GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse
1034
+ include Google::Apis::Core::Hashable
1035
+
1036
+ # The result of the sampling process.
1037
+ # Corresponds to the JSON property `selectedDocuments`
1038
+ # @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument>]
1039
+ attr_accessor :selected_documents
1040
+
1041
+ def initialize(**args)
1042
+ update!(**args)
1043
+ end
1044
+
1045
+ # Update properties of this object
1046
+ def update!(**args)
1047
+ @selected_documents = args[:selected_documents] if args.key?(:selected_documents)
1048
+ end
1049
+ end
1050
+
1051
+ #
1052
+ class GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument
1053
+ include Google::Apis::Core::Hashable
1054
+
1055
+ # An internal identifier for document.
1056
+ # Corresponds to the JSON property `documentId`
1057
+ # @return [String]
1058
+ attr_accessor :document_id
1059
+
1060
+ def initialize(**args)
1061
+ update!(**args)
1062
+ end
1063
+
1064
+ # Update properties of this object
1065
+ def update!(**args)
1066
+ @document_id = args[:document_id] if args.key?(:document_id)
1067
+ end
1068
+ end
1069
+
1070
+ # The long-running operation metadata for the SetDefaultProcessorVersion method.
1014
1071
  class GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata
1015
1072
  include Google::Apis::Core::Hashable
1016
1073
 
@@ -1029,7 +1086,7 @@ module Google
1029
1086
  end
1030
1087
  end
1031
1088
 
1032
- # Response message for set default processor version method.
1089
+ # Response message for the SetDefaultProcessorVersion method.
1033
1090
  class GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse
1034
1091
  include Google::Apis::Core::Hashable
1035
1092
 
@@ -1135,7 +1192,7 @@ module Google
1135
1192
  end
1136
1193
  end
1137
1194
 
1138
- # The long-running operation metadata for the undeploy processor version method.
1195
+ # The long-running operation metadata for the UndeployProcessorVersion method.
1139
1196
  class GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata
1140
1197
  include Google::Apis::Core::Hashable
1141
1198
 
@@ -1154,7 +1211,7 @@ module Google
1154
1211
  end
1155
1212
  end
1156
1213
 
1157
- # Response message for the undeploy processor version method.
1214
+ # Response message for the UndeployProcessorVersion method.
1158
1215
  class GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse
1159
1216
  include Google::Apis::Core::Hashable
1160
1217
 
@@ -1345,16 +1402,15 @@ module Google
1345
1402
  # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1HumanReviewStatus]
1346
1403
  attr_accessor :human_review_status
1347
1404
 
1348
- # The source of the document, same as the [input_gcs_source] field in the
1349
- # request when the batch process started. The batch process is started by take
1350
- # snapshot of that document, since a user can move or change that document
1351
- # during the process.
1405
+ # The source of the document, same as the input_gcs_source field in the request
1406
+ # when the batch process started.
1352
1407
  # Corresponds to the JSON property `inputGcsSource`
1353
1408
  # @return [String]
1354
1409
  attr_accessor :input_gcs_source
1355
1410
 
1356
- # The output_gcs_destination (in the request as `output_gcs_destination`) of the
1357
- # processed document if it was successful, otherwise empty.
1411
+ # The Cloud Storage output destination (in the request as DocumentOutputConfig.
1412
+ # GcsOutputConfig.gcs_uri) of the processed document if it was successful,
1413
+ # otherwise empty.
1358
1414
  # Corresponds to the JSON property `outputGcsDestination`
1359
1415
  # @return [String]
1360
1416
  attr_accessor :output_gcs_destination
@@ -1497,7 +1553,7 @@ module Google
1497
1553
  end
1498
1554
  end
1499
1555
 
1500
- # The long-running operation metadata for delete processor method.
1556
+ # The long-running operation metadata for the DeleteProcessor method.
1501
1557
  class GoogleCloudDocumentaiV1DeleteProcessorMetadata
1502
1558
  include Google::Apis::Core::Hashable
1503
1559
 
@@ -1516,7 +1572,7 @@ module Google
1516
1572
  end
1517
1573
  end
1518
1574
 
1519
- # The long-running operation metadata for delete processor version method.
1575
+ # The long-running operation metadata for the DeleteProcessorVersion method.
1520
1576
  class GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata
1521
1577
  include Google::Apis::Core::Hashable
1522
1578
 
@@ -1535,7 +1591,7 @@ module Google
1535
1591
  end
1536
1592
  end
1537
1593
 
1538
- # The long-running operation metadata for deploy processor version method.
1594
+ # The long-running operation metadata for the DeployProcessorVersion method.
1539
1595
  class GoogleCloudDocumentaiV1DeployProcessorVersionMetadata
1540
1596
  include Google::Apis::Core::Hashable
1541
1597
 
@@ -1554,7 +1610,7 @@ module Google
1554
1610
  end
1555
1611
  end
1556
1612
 
1557
- # Request message for the deploy processor version method.
1613
+ # Request message for the DeployProcessorVersion method.
1558
1614
  class GoogleCloudDocumentaiV1DeployProcessorVersionRequest
1559
1615
  include Google::Apis::Core::Hashable
1560
1616
 
@@ -1567,7 +1623,7 @@ module Google
1567
1623
  end
1568
1624
  end
1569
1625
 
1570
- # Response message for the deploy processor version method.
1626
+ # Response message for the DeployProcessorVersion method.
1571
1627
  class GoogleCloudDocumentaiV1DeployProcessorVersionResponse
1572
1628
  include Google::Apis::Core::Hashable
1573
1629
 
@@ -1580,7 +1636,7 @@ module Google
1580
1636
  end
1581
1637
  end
1582
1638
 
1583
- # The long-running operation metadata for disable processor method.
1639
+ # The long-running operation metadata for the DisableProcessor method.
1584
1640
  class GoogleCloudDocumentaiV1DisableProcessorMetadata
1585
1641
  include Google::Apis::Core::Hashable
1586
1642
 
@@ -1599,7 +1655,7 @@ module Google
1599
1655
  end
1600
1656
  end
1601
1657
 
1602
- # Request message for the disable processor method.
1658
+ # Request message for the DisableProcessor method.
1603
1659
  class GoogleCloudDocumentaiV1DisableProcessorRequest
1604
1660
  include Google::Apis::Core::Hashable
1605
1661
 
@@ -1612,7 +1668,7 @@ module Google
1612
1668
  end
1613
1669
  end
1614
1670
 
1615
- # Response message for the disable processor method. Intentionally empty proto
1671
+ # Response message for the DisableProcessor method. Intentionally empty proto
1616
1672
  # for adding fields in future.
1617
1673
  class GoogleCloudDocumentaiV1DisableProcessorResponse
1618
1674
  include Google::Apis::Core::Hashable
@@ -1703,9 +1759,9 @@ module Google
1703
1759
  attr_accessor :text_styles
1704
1760
 
1705
1761
  # Optional. Currently supports Google Cloud Storage URI of the form `gs://
1706
- # bucket_name/object_name`. Object versioning is not supported. See [Google
1707
- # Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-
1708
- # uris) for more info.
1762
+ # bucket_name/object_name`. Object versioning is not supported. For more
1763
+ # information, refer to [Google Cloud Storage Request URIs](https://cloud.google.
1764
+ # com/storage/docs/reference-uris).
1709
1765
  # Corresponds to the JSON property `uri`
1710
1766
  # @return [String]
1711
1767
  attr_accessor :uri
@@ -2877,13 +2933,13 @@ module Google
2877
2933
  # @return [Google::Apis::DocumentaiV1::GoogleTypeColor]
2878
2934
  attr_accessor :background_color
2879
2935
 
2880
- # Whether the text is bold (equivalent to font weight >= 700).
2936
+ # Whether the text is bold (equivalent to font_weight is at least `700`).
2881
2937
  # Corresponds to the JSON property `bold`
2882
2938
  # @return [Boolean]
2883
2939
  attr_accessor :bold
2884
2940
  alias_method :bold?, :bold
2885
2941
 
2886
- # Font size in points (1 point is 1/72").
2942
+ # Font size in points (`1` point is `¹⁄₇₂` inches).
2887
2943
  # Corresponds to the JSON property `fontSize`
2888
2944
  # @return [Fixnum]
2889
2945
  attr_accessor :font_size
@@ -2893,8 +2949,8 @@ module Google
2893
2949
  # @return [String]
2894
2950
  attr_accessor :font_type
2895
2951
 
2896
- # TrueType weight on a scale 100 (Thin) to 1000 (Ultra-heavy). Normal is 400,
2897
- # Bold is 700.
2952
+ # TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `
2953
+ # 400`, bold is `700`.
2898
2954
  # Corresponds to the JSON property `fontWeight`
2899
2955
  # @return [Fixnum]
2900
2956
  attr_accessor :font_weight
@@ -2916,12 +2972,12 @@ module Google
2916
2972
  # @return [Float]
2917
2973
  attr_accessor :letter_spacing
2918
2974
 
2919
- # Font size in pixels, equal to unrounded_fontsize * resolution / 72.0.
2975
+ # Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`.
2920
2976
  # Corresponds to the JSON property `pixelFontSize`
2921
2977
  # @return [Float]
2922
2978
  attr_accessor :pixel_font_size
2923
2979
 
2924
- # Whether the text are small caps.
2980
+ # Whether the text is in small caps.
2925
2981
  # Corresponds to the JSON property `smallcaps`
2926
2982
  # @return [Boolean]
2927
2983
  attr_accessor :smallcaps
@@ -3697,7 +3753,7 @@ module Google
3697
3753
  end
3698
3754
  end
3699
3755
 
3700
- # The long-running operation metadata for enable processor method.
3756
+ # The long-running operation metadata for the EnableProcessor method.
3701
3757
  class GoogleCloudDocumentaiV1EnableProcessorMetadata
3702
3758
  include Google::Apis::Core::Hashable
3703
3759
 
@@ -3716,7 +3772,7 @@ module Google
3716
3772
  end
3717
3773
  end
3718
3774
 
3719
- # Request message for the enable processor method.
3775
+ # Request message for the EnableProcessor method.
3720
3776
  class GoogleCloudDocumentaiV1EnableProcessorRequest
3721
3777
  include Google::Apis::Core::Hashable
3722
3778
 
@@ -3729,8 +3785,8 @@ module Google
3729
3785
  end
3730
3786
  end
3731
3787
 
3732
- # Response message for the enable processor method. Intentionally empty proto
3733
- # for adding fields in future.
3788
+ # Response message for the EnableProcessor method. Intentionally empty proto for
3789
+ # adding fields in future.
3734
3790
  class GoogleCloudDocumentaiV1EnableProcessorResponse
3735
3791
  include Google::Apis::Core::Hashable
3736
3792
 
@@ -4095,7 +4151,7 @@ module Google
4095
4151
  end
4096
4152
  end
4097
4153
 
4098
- # Response message for fetch processor types.
4154
+ # Response message for the FetchProcessorTypes method.
4099
4155
  class GoogleCloudDocumentaiV1FetchProcessorTypesResponse
4100
4156
  include Google::Apis::Core::Hashable
4101
4157
 
@@ -4237,7 +4293,7 @@ module Google
4237
4293
  end
4238
4294
  end
4239
4295
 
4240
- # Response message for list processor types.
4296
+ # Response message for the ListProcessorTypes method.
4241
4297
  class GoogleCloudDocumentaiV1ListProcessorTypesResponse
4242
4298
  include Google::Apis::Core::Hashable
4243
4299
 
@@ -4262,7 +4318,7 @@ module Google
4262
4318
  end
4263
4319
  end
4264
4320
 
4265
- # Response message for list processors.
4321
+ # Response message for the ListProcessorVersions method.
4266
4322
  class GoogleCloudDocumentaiV1ListProcessorVersionsResponse
4267
4323
  include Google::Apis::Core::Hashable
4268
4324
 
@@ -4287,7 +4343,7 @@ module Google
4287
4343
  end
4288
4344
  end
4289
4345
 
4290
- # Response message for list processors.
4346
+ # Response message for the ListProcessors method.
4291
4347
  class GoogleCloudDocumentaiV1ListProcessorsResponse
4292
4348
  include Google::Apis::Core::Hashable
4293
4349
 
@@ -4338,12 +4394,12 @@ module Google
4338
4394
  end
4339
4395
  end
4340
4396
 
4341
- # Request message for the process document method.
4397
+ # Request message for the ProcessDocument method.
4342
4398
  class GoogleCloudDocumentaiV1ProcessRequest
4343
4399
  include Google::Apis::Core::Hashable
4344
4400
 
4345
- # Specifies which fields to include in the `ProcessResponse` Document. Only
4346
- # supports top level document and pages field so it must be in the form of ``
4401
+ # Specifies which fields to include in the ProcessResponse.document output. Only
4402
+ # supports top-level document and pages field, so it must be in the form of ``
4347
4403
  # document_field_name`` or `pages.`page_field_name``.
4348
4404
  # Corresponds to the JSON property `fieldMask`
4349
4405
  # @return [String]
@@ -4382,7 +4438,7 @@ module Google
4382
4438
  end
4383
4439
  end
4384
4440
 
4385
- # Response message for the process document method.
4441
+ # Response message for the ProcessDocument method.
4386
4442
  class GoogleCloudDocumentaiV1ProcessResponse
4387
4443
  include Google::Apis::Core::Hashable
4388
4444
 
@@ -4685,7 +4741,7 @@ module Google
4685
4741
  end
4686
4742
  end
4687
4743
 
4688
- # The long-running operation metadata for review document method.
4744
+ # The long-running operation metadata for the ReviewDocument method.
4689
4745
  class GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata
4690
4746
  include Google::Apis::Core::Hashable
4691
4747
 
@@ -4710,7 +4766,7 @@ module Google
4710
4766
  end
4711
4767
  end
4712
4768
 
4713
- # Request message for review document method.
4769
+ # Request message for the ReviewDocument method.
4714
4770
  class GoogleCloudDocumentaiV1ReviewDocumentRequest
4715
4771
  include Google::Apis::Core::Hashable
4716
4772
 
@@ -4751,7 +4807,7 @@ module Google
4751
4807
  end
4752
4808
  end
4753
4809
 
4754
- # Response message for review document method.
4810
+ # Response message for the ReviewDocument method.
4755
4811
  class GoogleCloudDocumentaiV1ReviewDocumentResponse
4756
4812
  include Google::Apis::Core::Hashable
4757
4813
 
@@ -4783,7 +4839,7 @@ module Google
4783
4839
  end
4784
4840
  end
4785
4841
 
4786
- # The long-running operation metadata for set default processor version method.
4842
+ # The long-running operation metadata for the SetDefaultProcessorVersion method.
4787
4843
  class GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata
4788
4844
  include Google::Apis::Core::Hashable
4789
4845
 
@@ -4802,7 +4858,7 @@ module Google
4802
4858
  end
4803
4859
  end
4804
4860
 
4805
- # Request message for the set default processor version method.
4861
+ # Request message for the SetDefaultProcessorVersion method.
4806
4862
  class GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest
4807
4863
  include Google::Apis::Core::Hashable
4808
4864
 
@@ -4823,7 +4879,7 @@ module Google
4823
4879
  end
4824
4880
  end
4825
4881
 
4826
- # Response message for set default processor version method.
4882
+ # Response message for the SetDefaultProcessorVersion method.
4827
4883
  class GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse
4828
4884
  include Google::Apis::Core::Hashable
4829
4885
 
@@ -4910,7 +4966,7 @@ module Google
4910
4966
  end
4911
4967
  end
4912
4968
 
4913
- # Request message for the create processor version method.
4969
+ # Request message for the TrainProcessorVersion method.
4914
4970
  class GoogleCloudDocumentaiV1TrainProcessorVersionRequest
4915
4971
  include Google::Apis::Core::Hashable
4916
4972
 
@@ -4926,7 +4982,7 @@ module Google
4926
4982
  # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchema]
4927
4983
  attr_accessor :document_schema
4928
4984
 
4929
- # The input data used to train a new `ProcessorVersion`.
4985
+ # The input data used to train a new ProcessorVersion.
4930
4986
  # Corresponds to the JSON property `inputData`
4931
4987
  # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData]
4932
4988
  attr_accessor :input_data
@@ -4953,7 +5009,7 @@ module Google
4953
5009
  end
4954
5010
  end
4955
5011
 
4956
- # The input data used to train a new `ProcessorVersion`.
5012
+ # The input data used to train a new ProcessorVersion.
4957
5013
  class GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData
4958
5014
  include Google::Apis::Core::Hashable
4959
5015
 
@@ -4997,7 +5053,7 @@ module Google
4997
5053
  end
4998
5054
  end
4999
5055
 
5000
- # The long-running operation metadata for the undeploy processor version method.
5056
+ # The long-running operation metadata for the UndeployProcessorVersion method.
5001
5057
  class GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata
5002
5058
  include Google::Apis::Core::Hashable
5003
5059
 
@@ -5016,7 +5072,7 @@ module Google
5016
5072
  end
5017
5073
  end
5018
5074
 
5019
- # Request message for the undeploy processor version method.
5075
+ # Request message for the UndeployProcessorVersion method.
5020
5076
  class GoogleCloudDocumentaiV1UndeployProcessorVersionRequest
5021
5077
  include Google::Apis::Core::Hashable
5022
5078
 
@@ -5029,7 +5085,7 @@ module Google
5029
5085
  end
5030
5086
  end
5031
5087
 
5032
- # Response message for the undeploy processor version method.
5088
+ # Response message for the UndeployProcessorVersion method.
5033
5089
  class GoogleCloudDocumentaiV1UndeployProcessorVersionResponse
5034
5090
  include Google::Apis::Core::Hashable
5035
5091
 
@@ -5232,9 +5288,9 @@ module Google
5232
5288
  attr_accessor :text_styles
5233
5289
 
5234
5290
  # Optional. Currently supports Google Cloud Storage URI of the form `gs://
5235
- # bucket_name/object_name`. Object versioning is not supported. See [Google
5236
- # Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-
5237
- # uris) for more info.
5291
+ # bucket_name/object_name`. Object versioning is not supported. For more
5292
+ # information, refer to [Google Cloud Storage Request URIs](https://cloud.google.
5293
+ # com/storage/docs/reference-uris).
5238
5294
  # Corresponds to the JSON property `uri`
5239
5295
  # @return [String]
5240
5296
  attr_accessor :uri
@@ -6328,13 +6384,13 @@ module Google
6328
6384
  # @return [Google::Apis::DocumentaiV1::GoogleTypeColor]
6329
6385
  attr_accessor :background_color
6330
6386
 
6331
- # Whether the text is bold (equivalent to font weight >= 700).
6387
+ # Whether the text is bold (equivalent to font_weight is at least `700`).
6332
6388
  # Corresponds to the JSON property `bold`
6333
6389
  # @return [Boolean]
6334
6390
  attr_accessor :bold
6335
6391
  alias_method :bold?, :bold
6336
6392
 
6337
- # Font size in points (1 point is 1/72").
6393
+ # Font size in points (`1` point is `¹⁄₇₂` inches).
6338
6394
  # Corresponds to the JSON property `fontSize`
6339
6395
  # @return [Fixnum]
6340
6396
  attr_accessor :font_size
@@ -6344,8 +6400,8 @@ module Google
6344
6400
  # @return [String]
6345
6401
  attr_accessor :font_type
6346
6402
 
6347
- # TrueType weight on a scale 100 (Thin) to 1000 (Ultra-heavy). Normal is 400,
6348
- # Bold is 700.
6403
+ # TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `
6404
+ # 400`, bold is `700`.
6349
6405
  # Corresponds to the JSON property `fontWeight`
6350
6406
  # @return [Fixnum]
6351
6407
  attr_accessor :font_weight
@@ -6367,12 +6423,12 @@ module Google
6367
6423
  # @return [Float]
6368
6424
  attr_accessor :letter_spacing
6369
6425
 
6370
- # Font size in pixels, equal to unrounded_fontsize * resolution / 72.0.
6426
+ # Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`.
6371
6427
  # Corresponds to the JSON property `pixelFontSize`
6372
6428
  # @return [Float]
6373
6429
  attr_accessor :pixel_font_size
6374
6430
 
6375
- # Whether the text are small caps.
6431
+ # Whether the text is in small caps.
6376
6432
  # Corresponds to the JSON property `smallcaps`
6377
6433
  # @return [Boolean]
6378
6434
  attr_accessor :smallcaps
@@ -7343,9 +7399,9 @@ module Google
7343
7399
  attr_accessor :text_styles
7344
7400
 
7345
7401
  # Optional. Currently supports Google Cloud Storage URI of the form `gs://
7346
- # bucket_name/object_name`. Object versioning is not supported. See [Google
7347
- # Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-
7348
- # uris) for more info.
7402
+ # bucket_name/object_name`. Object versioning is not supported. For more
7403
+ # information, refer to [Google Cloud Storage Request URIs](https://cloud.google.
7404
+ # com/storage/docs/reference-uris).
7349
7405
  # Corresponds to the JSON property `uri`
7350
7406
  # @return [String]
7351
7407
  attr_accessor :uri
@@ -8477,13 +8533,13 @@ module Google
8477
8533
  # @return [Google::Apis::DocumentaiV1::GoogleTypeColor]
8478
8534
  attr_accessor :background_color
8479
8535
 
8480
- # Whether the text is bold (equivalent to font weight >= 700).
8536
+ # Whether the text is bold (equivalent to font_weight is at least `700`).
8481
8537
  # Corresponds to the JSON property `bold`
8482
8538
  # @return [Boolean]
8483
8539
  attr_accessor :bold
8484
8540
  alias_method :bold?, :bold
8485
8541
 
8486
- # Font size in points (1 point is 1/72").
8542
+ # Font size in points (`1` point is `¹⁄₇₂` inches).
8487
8543
  # Corresponds to the JSON property `fontSize`
8488
8544
  # @return [Fixnum]
8489
8545
  attr_accessor :font_size
@@ -8493,8 +8549,8 @@ module Google
8493
8549
  # @return [String]
8494
8550
  attr_accessor :font_type
8495
8551
 
8496
- # TrueType weight on a scale 100 (Thin) to 1000 (Ultra-heavy). Normal is 400,
8497
- # Bold is 700.
8552
+ # TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `
8553
+ # 400`, bold is `700`.
8498
8554
  # Corresponds to the JSON property `fontWeight`
8499
8555
  # @return [Fixnum]
8500
8556
  attr_accessor :font_weight
@@ -8516,12 +8572,12 @@ module Google
8516
8572
  # @return [Float]
8517
8573
  attr_accessor :letter_spacing
8518
8574
 
8519
- # Font size in pixels, equal to unrounded_fontsize * resolution / 72.0.
8575
+ # Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`.
8520
8576
  # Corresponds to the JSON property `pixelFontSize`
8521
8577
  # @return [Float]
8522
8578
  attr_accessor :pixel_font_size
8523
8579
 
8524
- # Whether the text are small caps.
8580
+ # Whether the text is in small caps.
8525
8581
  # Corresponds to the JSON property `smallcaps`
8526
8582
  # @return [Boolean]
8527
8583
  attr_accessor :smallcaps
@@ -9383,7 +9439,7 @@ module Google
9383
9439
 
9384
9440
  # The name of the operation triggered by the processed document. If the human
9385
9441
  # review process isn't triggered, this field will be empty. It has the same
9386
- # response type and metadata as the long-running operation returned by
9442
+ # response type and metadata as the long-running operation returned by the
9387
9443
  # ReviewDocument method.
9388
9444
  # Corresponds to the JSON property `humanReviewOperation`
9389
9445
  # @return [String]
@@ -9394,16 +9450,15 @@ module Google
9394
9450
  # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta3HumanReviewStatus]
9395
9451
  attr_accessor :human_review_status
9396
9452
 
9397
- # The source of the document, same as the [input_gcs_source] field in the
9398
- # request when the batch process started. The batch process is started by take
9399
- # snapshot of that document, since a user can move or change that document
9400
- # during the process.
9453
+ # The source of the document, same as the input_gcs_source field in the request
9454
+ # when the batch process started.
9401
9455
  # Corresponds to the JSON property `inputGcsSource`
9402
9456
  # @return [String]
9403
9457
  attr_accessor :input_gcs_source
9404
9458
 
9405
- # The output_gcs_destination (in the request as `output_gcs_destination`) of the
9406
- # processed document if it was successful, otherwise empty.
9459
+ # The Cloud Storage output destination (in the request as DocumentOutputConfig.
9460
+ # GcsOutputConfig.gcs_uri) of the processed document if it was successful,
9461
+ # otherwise empty.
9407
9462
  # Corresponds to the JSON property `outputGcsDestination`
9408
9463
  # @return [String]
9409
9464
  attr_accessor :output_gcs_destination
@@ -9488,7 +9543,7 @@ module Google
9488
9543
  end
9489
9544
  end
9490
9545
 
9491
- # The long-running operation metadata for delete processor method.
9546
+ # The long-running operation metadata for the DeleteProcessor method.
9492
9547
  class GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata
9493
9548
  include Google::Apis::Core::Hashable
9494
9549
 
@@ -9507,7 +9562,7 @@ module Google
9507
9562
  end
9508
9563
  end
9509
9564
 
9510
- # The long-running operation metadata for delete processor version method.
9565
+ # The long-running operation metadata for the DeleteProcessorVersion method.
9511
9566
  class GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata
9512
9567
  include Google::Apis::Core::Hashable
9513
9568
 
@@ -9526,7 +9581,7 @@ module Google
9526
9581
  end
9527
9582
  end
9528
9583
 
9529
- # The long-running operation metadata for deploy processor version method.
9584
+ # The long-running operation metadata for the DeployProcessorVersion method.
9530
9585
  class GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata
9531
9586
  include Google::Apis::Core::Hashable
9532
9587
 
@@ -9545,7 +9600,7 @@ module Google
9545
9600
  end
9546
9601
  end
9547
9602
 
9548
- # Response message for the deploy processor version method.
9603
+ # Response message for the DeployProcessorVersion method.
9549
9604
  class GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse
9550
9605
  include Google::Apis::Core::Hashable
9551
9606
 
@@ -9558,7 +9613,7 @@ module Google
9558
9613
  end
9559
9614
  end
9560
9615
 
9561
- # The long-running operation metadata for disable processor method.
9616
+ # The long-running operation metadata for the DisableProcessor method.
9562
9617
  class GoogleCloudDocumentaiV1beta3DisableProcessorMetadata
9563
9618
  include Google::Apis::Core::Hashable
9564
9619
 
@@ -9577,7 +9632,7 @@ module Google
9577
9632
  end
9578
9633
  end
9579
9634
 
9580
- # Response message for the disable processor method. Intentionally empty proto
9635
+ # Response message for the DisableProcessor method. Intentionally empty proto
9581
9636
  # for adding fields in future.
9582
9637
  class GoogleCloudDocumentaiV1beta3DisableProcessorResponse
9583
9638
  include Google::Apis::Core::Hashable
@@ -9591,7 +9646,7 @@ module Google
9591
9646
  end
9592
9647
  end
9593
9648
 
9594
- # The long-running operation metadata for enable processor method.
9649
+ # The long-running operation metadata for the EnableProcessor method.
9595
9650
  class GoogleCloudDocumentaiV1beta3EnableProcessorMetadata
9596
9651
  include Google::Apis::Core::Hashable
9597
9652
 
@@ -9610,8 +9665,8 @@ module Google
9610
9665
  end
9611
9666
  end
9612
9667
 
9613
- # Response message for the enable processor method. Intentionally empty proto
9614
- # for adding fields in future.
9668
+ # Response message for the EnableProcessor method. Intentionally empty proto for
9669
+ # adding fields in future.
9615
9670
  class GoogleCloudDocumentaiV1beta3EnableProcessorResponse
9616
9671
  include Google::Apis::Core::Hashable
9617
9672
 
@@ -9734,7 +9789,7 @@ module Google
9734
9789
  end
9735
9790
  end
9736
9791
 
9737
- # The long-running operation metadata for review document method.
9792
+ # The long-running operation metadata for the ReviewDocument method.
9738
9793
  class GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata
9739
9794
  include Google::Apis::Core::Hashable
9740
9795
 
@@ -9784,7 +9839,7 @@ module Google
9784
9839
  end
9785
9840
  end
9786
9841
 
9787
- # Response message for review document method.
9842
+ # Response message for the ReviewDocument method.
9788
9843
  class GoogleCloudDocumentaiV1beta3ReviewDocumentResponse
9789
9844
  include Google::Apis::Core::Hashable
9790
9845
 
@@ -9816,7 +9871,7 @@ module Google
9816
9871
  end
9817
9872
  end
9818
9873
 
9819
- # The long-running operation metadata for set default processor version method.
9874
+ # The long-running operation metadata for the SetDefaultProcessorVersion method.
9820
9875
  class GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata
9821
9876
  include Google::Apis::Core::Hashable
9822
9877
 
@@ -9835,7 +9890,7 @@ module Google
9835
9890
  end
9836
9891
  end
9837
9892
 
9838
- # Response message for set default processor version method.
9893
+ # Response message for the SetDefaultProcessorVersion method.
9839
9894
  class GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse
9840
9895
  include Google::Apis::Core::Hashable
9841
9896
 
@@ -9941,7 +9996,7 @@ module Google
9941
9996
  end
9942
9997
  end
9943
9998
 
9944
- # The long-running operation metadata for the undeploy processor version method.
9999
+ # The long-running operation metadata for the UndeployProcessorVersion method.
9945
10000
  class GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata
9946
10001
  include Google::Apis::Core::Hashable
9947
10002
 
@@ -9960,7 +10015,7 @@ module Google
9960
10015
  end
9961
10016
  end
9962
10017
 
9963
- # Response message for the undeploy processor version method.
10018
+ # Response message for the UndeployProcessorVersion method.
9964
10019
  class GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse
9965
10020
  include Google::Apis::Core::Hashable
9966
10021
 
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DocumentaiV1
18
18
  # Version of the google-apis-documentai_v1 gem
19
- GEM_VERSION = "0.63.0"
19
+ GEM_VERSION = "0.64.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.12.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20230420"
25
+ REVISION = "20230504"
26
26
  end
27
27
  end
28
28
  end
@@ -268,6 +268,24 @@ module Google
268
268
  include Google::Apis::Core::JsonObjectSupport
269
269
  end
270
270
 
271
+ class GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata
272
+ class Representation < Google::Apis::Core::JsonRepresentation; end
273
+
274
+ include Google::Apis::Core::JsonObjectSupport
275
+ end
276
+
277
+ class GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse
278
+ class Representation < Google::Apis::Core::JsonRepresentation; end
279
+
280
+ include Google::Apis::Core::JsonObjectSupport
281
+ end
282
+
283
+ class GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument
284
+ class Representation < Google::Apis::Core::JsonRepresentation; end
285
+
286
+ include Google::Apis::Core::JsonObjectSupport
287
+ end
288
+
271
289
  class GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata
272
290
  class Representation < Google::Apis::Core::JsonRepresentation; end
273
291
 
@@ -2126,6 +2144,29 @@ module Google
2126
2144
  end
2127
2145
  end
2128
2146
 
2147
+ class GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata
2148
+ # @private
2149
+ class Representation < Google::Apis::Core::JsonRepresentation
2150
+ property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation
2151
+
2152
+ end
2153
+ end
2154
+
2155
+ class GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse
2156
+ # @private
2157
+ class Representation < Google::Apis::Core::JsonRepresentation
2158
+ collection :selected_documents, as: 'selectedDocuments', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument::Representation
2159
+
2160
+ end
2161
+ end
2162
+
2163
+ class GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument
2164
+ # @private
2165
+ class Representation < Google::Apis::Core::JsonRepresentation
2166
+ property :document_id, as: 'documentId'
2167
+ end
2168
+ end
2169
+
2129
2170
  class GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata
2130
2171
  # @private
2131
2172
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -87,9 +87,8 @@ module Google
87
87
  # Fetches processor types. Note that we don't use ListProcessorTypes here,
88
88
  # because it isn't paginated.
89
89
  # @param [String] parent
90
- # Required. The project of processor type to list. The available processor types
91
- # may depend on the allow-listing on projects. Format: `projects/`project`/
92
- # locations/`location``
90
+ # Required. The location of processor types to list. Format: `projects/`project`/
91
+ # locations/`location``.
93
92
  # @param [String] fields
94
93
  # Selector specifying which fields to include in a partial response.
95
94
  # @param [String] quota_user
@@ -330,13 +329,12 @@ module Google
330
329
 
331
330
  # Lists the processor types that exist.
332
331
  # @param [String] parent
333
- # Required. The location of processor type to list. The available processor
334
- # types may depend on the allow-listing on projects. Format: `projects/`project`/
335
- # locations/`location``
332
+ # Required. The location of processor types to list. Format: `projects/`project`/
333
+ # locations/`location``.
336
334
  # @param [Fixnum] page_size
337
- # The maximum number of processor types to return. If unspecified, at most 100
338
- # processor types will be returned. The maximum value is 500; values above 500
339
- # will be coerced to 500.
335
+ # The maximum number of processor types to return. If unspecified, at most `100`
336
+ # processor types will be returned. The maximum value is `500`. Values above `
337
+ # 500` will be coerced to `500`.
340
338
  # @param [String] page_token
341
339
  # Used to retrieve the next page of results, empty if at the end of the list.
342
340
  # @param [String] fields
@@ -405,8 +403,8 @@ module Google
405
403
  execute_or_queue_command(command, &block)
406
404
  end
407
405
 
408
- # Creates a processor from the type processor that the user chose. The processor
409
- # will be at "ENABLED" state by default after its creation.
406
+ # Creates a processor from the ProcessorType provided. The processor will be at `
407
+ # ENABLED` state by default after its creation.
410
408
  # @param [String] parent
411
409
  # Required. The parent (project and location) under which to create the
412
410
  # processor. Format: `projects/`project`/locations/`location``
@@ -572,9 +570,9 @@ module Google
572
570
  # Required. The parent (project and location) which owns this collection of
573
571
  # Processors. Format: `projects/`project`/locations/`location``
574
572
  # @param [Fixnum] page_size
575
- # The maximum number of processors to return. If unspecified, at most 50
576
- # processors will be returned. The maximum value is 100; values above 100 will
577
- # be coerced to 100.
573
+ # The maximum number of processors to return. If unspecified, at most `50`
574
+ # processors will be returned. The maximum value is `100`. Values above `100`
575
+ # will be coerced to `100`.
578
576
  # @param [String] page_token
579
577
  # We will return the processors sorted by creation time. The page token will
580
578
  # point to the next processor.
@@ -885,9 +883,9 @@ module Google
885
883
  # Required. The parent (project, location and processor) to list all versions.
886
884
  # Format: `projects/`project`/locations/`location`/processors/`processor``
887
885
  # @param [Fixnum] page_size
888
- # The maximum number of processor versions to return. If unspecified, at most 10
889
- # processor versions will be returned. The maximum value is 20; values above 20
890
- # will be coerced to 20.
886
+ # The maximum number of processor versions to return. If unspecified, at most `
887
+ # 10` processor versions will be returned. The maximum value is `20`. Values
888
+ # above `20` will be coerced to `20`.
891
889
  # @param [String] page_token
892
890
  # We will return the processor versions sorted by creation time. The page token
893
891
  # will point to the next processor version.
@@ -958,7 +956,7 @@ module Google
958
956
  end
959
957
 
960
958
  # Trains a new processor version. Operation metadata is returned as
961
- # cloud_documentai_core.TrainProcessorVersionMetadata.
959
+ # TrainProcessorVersionMetadata.
962
960
  # @param [String] parent
963
961
  # Required. The parent (project, location and processor) to create the new
964
962
  # version for. Format: `projects/`project`/locations/`location`/processors/`
@@ -1064,9 +1062,8 @@ module Google
1064
1062
  # projects/`project`/locations/`location`/processors/`processor`/
1065
1063
  # processorVersions/`processorVersion``
1066
1064
  # @param [Fixnum] page_size
1067
- # The standard list page size. If unspecified, at most `5` evaluations will be
1068
- # returned. The maximum value is `100`; values above `100` will be coerced to `
1069
- # 100`.
1065
+ # The standard list page size. If unspecified, at most `5` evaluations are
1066
+ # returned. The maximum value is `100`. Values above `100` are coerced to `100`.
1070
1067
  # @param [String] page_token
1071
1068
  # A page token, received from a previous `ListEvaluations` call. Provide this to
1072
1069
  # retrieve the subsequent page.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-documentai_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.63.0
4
+ version: 0.64.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-04-30 00:00:00.000000000 Z
11
+ date: 2023-05-14 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-documentai_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1/v0.63.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1/v0.64.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-documentai_v1
63
63
  post_install_message:
64
64
  rdoc_options: []