google-apis-documentai_v1 0.11.0 → 0.15.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: bbe62526e8abaab91538e7808baddf2f1d0acb7787628fa6a9a09d5cba28e1dd
4
- data.tar.gz: 71cd1647b261a03358535b393135b6d254d5eddf3ff7009a85d2b271030e25fb
3
+ metadata.gz: 78235f12579d80ad89c1dcb4bea8fb8045c8907803ae8efcdbb6490b9d82bffc
4
+ data.tar.gz: f912f29bda80336c6d9f0e07f62be5ffe446231a098247d2096ce7057e7eb064
5
5
  SHA512:
6
- metadata.gz: af920a9d39680b5f7b6cd74086fd90c376c82ca507e121348963866b9cc4bb704b068b16c3e7415277f86c7ed33aa87bedbd5d3be0203cc77b0d1fd148b8a83e
7
- data.tar.gz: 741b983e46872fcca21feca3821150e0b858d25778b78faff5acf2fe978d02092bf2542df7e33604457438687a94ac09ca993b3ffec01e2cfa393bb09f75f894
6
+ metadata.gz: 74954f183bbeaa624a3a04bd97912bcc45642b03ef049ad32b62ab7b2ab465b55f9d627df70b24c7c91a9868cb43441e876ea0c470e4a8145396ea74527431f4
7
+ data.tar.gz: 87ac868fcd0854168d1de9eda3cdebc06a8dcd1b3eeb5b23ae641894486220dde1804002c32479073e2affb10782af650d4fec0f7e026eb4d0b62d0689b58f62
data/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # Release history for google-apis-documentai_v1
2
2
 
3
+ ### v0.15.0 (2021-09-09)
4
+
5
+ * Regenerated from discovery document revision 20210907
6
+
7
+ ### v0.14.0 (2021-09-02)
8
+
9
+ * Regenerated from discovery document revision 20210830
10
+
11
+ ### v0.13.0 (2021-08-24)
12
+
13
+ * Regenerated from discovery document revision 20210820
14
+
15
+ ### v0.12.0 (2021-08-19)
16
+
17
+ * Regenerated from discovery document revision 20210817
18
+
3
19
  ### v0.11.0 (2021-08-03)
4
20
 
5
21
  * Regenerated from discovery document revision 20210731
@@ -22,6 +22,70 @@ module Google
22
22
  module Apis
23
23
  module DocumentaiV1
24
24
 
25
+ #
26
+ class GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata
27
+ include Google::Apis::Core::Hashable
28
+
29
+ # The common metadata for long running operations.
30
+ # Corresponds to the JSON property `commonMetadata`
31
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata]
32
+ attr_accessor :common_metadata
33
+
34
+ def initialize(**args)
35
+ update!(**args)
36
+ end
37
+
38
+ # Update properties of this object
39
+ def update!(**args)
40
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
41
+ end
42
+ end
43
+
44
+ # Response of the delete documents operation.
45
+ class GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse
46
+ include Google::Apis::Core::Hashable
47
+
48
+ def initialize(**args)
49
+ update!(**args)
50
+ end
51
+
52
+ # Update properties of this object
53
+ def update!(**args)
54
+ end
55
+ end
56
+
57
+ #
58
+ class GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata
59
+ include Google::Apis::Core::Hashable
60
+
61
+ # The common metadata for long running operations.
62
+ # Corresponds to the JSON property `commonMetadata`
63
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata]
64
+ attr_accessor :common_metadata
65
+
66
+ def initialize(**args)
67
+ update!(**args)
68
+ end
69
+
70
+ # Update properties of this object
71
+ def update!(**args)
72
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
73
+ end
74
+ end
75
+
76
+ # Response of the batch move documents operation.
77
+ class GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse
78
+ include Google::Apis::Core::Hashable
79
+
80
+ def initialize(**args)
81
+ update!(**args)
82
+ end
83
+
84
+ # Update properties of this object
85
+ def update!(**args)
86
+ end
87
+ end
88
+
25
89
  # The common metadata for long running operations.
26
90
  class GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata
27
91
  include Google::Apis::Core::Hashable
@@ -309,6 +373,38 @@ module Google
309
373
  end
310
374
  end
311
375
 
376
+ # Metadata of the import document operation.
377
+ class GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata
378
+ include Google::Apis::Core::Hashable
379
+
380
+ # The common metadata for long running operations.
381
+ # Corresponds to the JSON property `commonMetadata`
382
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata]
383
+ attr_accessor :common_metadata
384
+
385
+ def initialize(**args)
386
+ update!(**args)
387
+ end
388
+
389
+ # Update properties of this object
390
+ def update!(**args)
391
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
392
+ end
393
+ end
394
+
395
+ # Response of the import document operation.
396
+ class GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse
397
+ include Google::Apis::Core::Hashable
398
+
399
+ def initialize(**args)
400
+ update!(**args)
401
+ end
402
+
403
+ # Update properties of this object
404
+ def update!(**args)
405
+ end
406
+ end
407
+
312
408
  # The long running operation metadata for set default processor version method.
313
409
  class GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata
314
410
  include Google::Apis::Core::Hashable
@@ -466,6 +562,25 @@ module Google
466
562
  end
467
563
  end
468
564
 
565
+ #
566
+ class GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata
567
+ include Google::Apis::Core::Hashable
568
+
569
+ # The common metadata for long running operations.
570
+ # Corresponds to the JSON property `commonMetadata`
571
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata]
572
+ attr_accessor :common_metadata
573
+
574
+ def initialize(**args)
575
+ update!(**args)
576
+ end
577
+
578
+ # Update properties of this object
579
+ def update!(**args)
580
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
581
+ end
582
+ end
583
+
469
584
  # The long running operation metadata for updating the human review
470
585
  # configuration.
471
586
  class GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata
@@ -729,6 +844,109 @@ module Google
729
844
  end
730
845
  end
731
846
 
847
+ # The long running operation metadata for delete processor method.
848
+ class GoogleCloudDocumentaiV1DeleteProcessorMetadata
849
+ include Google::Apis::Core::Hashable
850
+
851
+ # The common metadata for long running operations.
852
+ # Corresponds to the JSON property `commonMetadata`
853
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1CommonOperationMetadata]
854
+ attr_accessor :common_metadata
855
+
856
+ def initialize(**args)
857
+ update!(**args)
858
+ end
859
+
860
+ # Update properties of this object
861
+ def update!(**args)
862
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
863
+ end
864
+ end
865
+
866
+ # The long running operation metadata for delete processor version method.
867
+ class GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata
868
+ include Google::Apis::Core::Hashable
869
+
870
+ # The common metadata for long running operations.
871
+ # Corresponds to the JSON property `commonMetadata`
872
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1CommonOperationMetadata]
873
+ attr_accessor :common_metadata
874
+
875
+ def initialize(**args)
876
+ update!(**args)
877
+ end
878
+
879
+ # Update properties of this object
880
+ def update!(**args)
881
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
882
+ end
883
+ end
884
+
885
+ # The long running operation metadata for deploy processor version method.
886
+ class GoogleCloudDocumentaiV1DeployProcessorVersionMetadata
887
+ include Google::Apis::Core::Hashable
888
+
889
+ # The common metadata for long running operations.
890
+ # Corresponds to the JSON property `commonMetadata`
891
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1CommonOperationMetadata]
892
+ attr_accessor :common_metadata
893
+
894
+ def initialize(**args)
895
+ update!(**args)
896
+ end
897
+
898
+ # Update properties of this object
899
+ def update!(**args)
900
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
901
+ end
902
+ end
903
+
904
+ # Response message for the deploy processor version method.
905
+ class GoogleCloudDocumentaiV1DeployProcessorVersionResponse
906
+ include Google::Apis::Core::Hashable
907
+
908
+ def initialize(**args)
909
+ update!(**args)
910
+ end
911
+
912
+ # Update properties of this object
913
+ def update!(**args)
914
+ end
915
+ end
916
+
917
+ # The long running operation metadata for disable processor method.
918
+ class GoogleCloudDocumentaiV1DisableProcessorMetadata
919
+ include Google::Apis::Core::Hashable
920
+
921
+ # The common metadata for long running operations.
922
+ # Corresponds to the JSON property `commonMetadata`
923
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1CommonOperationMetadata]
924
+ attr_accessor :common_metadata
925
+
926
+ def initialize(**args)
927
+ update!(**args)
928
+ end
929
+
930
+ # Update properties of this object
931
+ def update!(**args)
932
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
933
+ end
934
+ end
935
+
936
+ # Response message for the disable processor method. Intentionally empty proto
937
+ # for adding fields in future.
938
+ class GoogleCloudDocumentaiV1DisableProcessorResponse
939
+ include Google::Apis::Core::Hashable
940
+
941
+ def initialize(**args)
942
+ update!(**args)
943
+ end
944
+
945
+ # Update properties of this object
946
+ def update!(**args)
947
+ end
948
+ end
949
+
732
950
  # Document represents the canonical document resource in Document Understanding
733
951
  # AI. It is an interchange format that provides insights into documents and
734
952
  # allows for collaboration between users and Document Understanding AI to
@@ -834,8 +1052,9 @@ module Google
834
1052
  end
835
1053
  end
836
1054
 
837
- # A phrase in the text that is a known entity type, such as a person, an
838
- # organization, or location.
1055
+ # An entity that could be a phrase in the text or a property belongs to the
1056
+ # document. It is a known entity type, such as a person, an organization, or
1057
+ # location.
839
1058
  class GoogleCloudDocumentaiV1DocumentEntity
840
1059
  include Google::Apis::Core::Hashable
841
1060
 
@@ -855,7 +1074,8 @@ module Google
855
1074
  # @return [String]
856
1075
  attr_accessor :mention_id
857
1076
 
858
- # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`.
1077
+ # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the
1078
+ # entity is not present in the document, this field will be empty.
859
1079
  # Corresponds to the JSON property `mentionText`
860
1080
  # @return [String]
861
1081
  attr_accessor :mention_text
@@ -974,17 +1194,29 @@ module Google
974
1194
  # @return [Google::Apis::DocumentaiV1::GoogleTypeDateTime]
975
1195
  attr_accessor :datetime_value
976
1196
 
1197
+ # Float value.
1198
+ # Corresponds to the JSON property `floatValue`
1199
+ # @return [Float]
1200
+ attr_accessor :float_value
1201
+
1202
+ # Integer value.
1203
+ # Corresponds to the JSON property `integerValue`
1204
+ # @return [Fixnum]
1205
+ attr_accessor :integer_value
1206
+
977
1207
  # Represents an amount of money with its currency type.
978
1208
  # Corresponds to the JSON property `moneyValue`
979
1209
  # @return [Google::Apis::DocumentaiV1::GoogleTypeMoney]
980
1210
  attr_accessor :money_value
981
1211
 
982
- # Required. Normalized entity value stored as a string. This field is populated
983
- # for supported document type (e.g. Invoice). For some entity types, one of
984
- # respective 'structured_value' fields may also be populated. - Money/Currency
985
- # type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`)
986
- # is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the
987
- # ISO 8601 text format.
1212
+ # Optional. An optional field to store a normalized string. For some entity
1213
+ # types, one of respective 'structured_value' fields may also be populated. Also
1214
+ # not all the types of 'structured_value' will be normalized. For example, some
1215
+ # processors may not generate float or int normalized text by default. Below are
1216
+ # sample formats mapped to structured values. - Money/Currency type (`
1217
+ # money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in
1218
+ # the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO
1219
+ # 8601 text format.
988
1220
  # Corresponds to the JSON property `text`
989
1221
  # @return [String]
990
1222
  attr_accessor :text
@@ -999,6 +1231,8 @@ module Google
999
1231
  @boolean_value = args[:boolean_value] if args.key?(:boolean_value)
1000
1232
  @date_value = args[:date_value] if args.key?(:date_value)
1001
1233
  @datetime_value = args[:datetime_value] if args.key?(:datetime_value)
1234
+ @float_value = args[:float_value] if args.key?(:float_value)
1235
+ @integer_value = args[:integer_value] if args.key?(:integer_value)
1002
1236
  @money_value = args[:money_value] if args.key?(:money_value)
1003
1237
  @text = args[:text] if args.key?(:text)
1004
1238
  end
@@ -1340,6 +1574,20 @@ module Google
1340
1574
  class GoogleCloudDocumentaiV1DocumentPageFormField
1341
1575
  include Google::Apis::Core::Hashable
1342
1576
 
1577
+ # Created for Labeling UI to export key text. If corrections were made to the
1578
+ # text identified by the `field_name.text_anchor`, this field will contain the
1579
+ # correction.
1580
+ # Corresponds to the JSON property `correctedKeyText`
1581
+ # @return [String]
1582
+ attr_accessor :corrected_key_text
1583
+
1584
+ # Created for Labeling UI to export value text. If corrections were made to the
1585
+ # text identified by the `field_value.text_anchor`, this field will contain the
1586
+ # correction.
1587
+ # Corresponds to the JSON property `correctedValueText`
1588
+ # @return [String]
1589
+ attr_accessor :corrected_value_text
1590
+
1343
1591
  # Visual element describing a layout unit on a page.
1344
1592
  # Corresponds to the JSON property `fieldName`
1345
1593
  # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageLayout]
@@ -1379,6 +1627,8 @@ module Google
1379
1627
 
1380
1628
  # Update properties of this object
1381
1629
  def update!(**args)
1630
+ @corrected_key_text = args[:corrected_key_text] if args.key?(:corrected_key_text)
1631
+ @corrected_value_text = args[:corrected_value_text] if args.key?(:corrected_value_text)
1382
1632
  @field_name = args[:field_name] if args.key?(:field_name)
1383
1633
  @field_value = args[:field_value] if args.key?(:field_value)
1384
1634
  @name_detected_languages = args[:name_detected_languages] if args.key?(:name_detected_languages)
@@ -2191,6 +2441,39 @@ module Google
2191
2441
  end
2192
2442
  end
2193
2443
 
2444
+ # The long running operation metadata for enable processor method.
2445
+ class GoogleCloudDocumentaiV1EnableProcessorMetadata
2446
+ include Google::Apis::Core::Hashable
2447
+
2448
+ # The common metadata for long running operations.
2449
+ # Corresponds to the JSON property `commonMetadata`
2450
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1CommonOperationMetadata]
2451
+ attr_accessor :common_metadata
2452
+
2453
+ def initialize(**args)
2454
+ update!(**args)
2455
+ end
2456
+
2457
+ # Update properties of this object
2458
+ def update!(**args)
2459
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
2460
+ end
2461
+ end
2462
+
2463
+ # Response message for the enable processor method. Intentionally empty proto
2464
+ # for adding fields in future.
2465
+ class GoogleCloudDocumentaiV1EnableProcessorResponse
2466
+ include Google::Apis::Core::Hashable
2467
+
2468
+ def initialize(**args)
2469
+ update!(**args)
2470
+ end
2471
+
2472
+ # Update properties of this object
2473
+ def update!(**args)
2474
+ end
2475
+ end
2476
+
2194
2477
  # Specifies a document stored on Cloud Storage.
2195
2478
  class GoogleCloudDocumentaiV1GcsDocument
2196
2479
  include Google::Apis::Core::Hashable
@@ -2477,6 +2760,70 @@ module Google
2477
2760
  end
2478
2761
  end
2479
2762
 
2763
+ # The long running operation metadata for set default processor version method.
2764
+ class GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata
2765
+ include Google::Apis::Core::Hashable
2766
+
2767
+ # The common metadata for long running operations.
2768
+ # Corresponds to the JSON property `commonMetadata`
2769
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1CommonOperationMetadata]
2770
+ attr_accessor :common_metadata
2771
+
2772
+ def initialize(**args)
2773
+ update!(**args)
2774
+ end
2775
+
2776
+ # Update properties of this object
2777
+ def update!(**args)
2778
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
2779
+ end
2780
+ end
2781
+
2782
+ # Response message for set default processor version method.
2783
+ class GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse
2784
+ include Google::Apis::Core::Hashable
2785
+
2786
+ def initialize(**args)
2787
+ update!(**args)
2788
+ end
2789
+
2790
+ # Update properties of this object
2791
+ def update!(**args)
2792
+ end
2793
+ end
2794
+
2795
+ # The long running operation metadata for the undeploy processor version method.
2796
+ class GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata
2797
+ include Google::Apis::Core::Hashable
2798
+
2799
+ # The common metadata for long running operations.
2800
+ # Corresponds to the JSON property `commonMetadata`
2801
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1CommonOperationMetadata]
2802
+ attr_accessor :common_metadata
2803
+
2804
+ def initialize(**args)
2805
+ update!(**args)
2806
+ end
2807
+
2808
+ # Update properties of this object
2809
+ def update!(**args)
2810
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
2811
+ end
2812
+ end
2813
+
2814
+ # Response message for the undeploy processor version method.
2815
+ class GoogleCloudDocumentaiV1UndeployProcessorVersionResponse
2816
+ include Google::Apis::Core::Hashable
2817
+
2818
+ def initialize(**args)
2819
+ update!(**args)
2820
+ end
2821
+
2822
+ # Update properties of this object
2823
+ def update!(**args)
2824
+ end
2825
+ end
2826
+
2480
2827
  # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are
2481
2828
  # in the same scale as the original image.
2482
2829
  class GoogleCloudDocumentaiV1Vertex
@@ -2653,8 +3000,9 @@ module Google
2653
3000
  end
2654
3001
  end
2655
3002
 
2656
- # A phrase in the text that is a known entity type, such as a person, an
2657
- # organization, or location.
3003
+ # An entity that could be a phrase in the text or a property belongs to the
3004
+ # document. It is a known entity type, such as a person, an organization, or
3005
+ # location.
2658
3006
  class GoogleCloudDocumentaiV1beta1DocumentEntity
2659
3007
  include Google::Apis::Core::Hashable
2660
3008
 
@@ -2674,7 +3022,8 @@ module Google
2674
3022
  # @return [String]
2675
3023
  attr_accessor :mention_id
2676
3024
 
2677
- # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`.
3025
+ # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the
3026
+ # entity is not present in the document, this field will be empty.
2678
3027
  # Corresponds to the JSON property `mentionText`
2679
3028
  # @return [String]
2680
3029
  attr_accessor :mention_text
@@ -2793,17 +3142,29 @@ module Google
2793
3142
  # @return [Google::Apis::DocumentaiV1::GoogleTypeDateTime]
2794
3143
  attr_accessor :datetime_value
2795
3144
 
3145
+ # Float value.
3146
+ # Corresponds to the JSON property `floatValue`
3147
+ # @return [Float]
3148
+ attr_accessor :float_value
3149
+
3150
+ # Integer value.
3151
+ # Corresponds to the JSON property `integerValue`
3152
+ # @return [Fixnum]
3153
+ attr_accessor :integer_value
3154
+
2796
3155
  # Represents an amount of money with its currency type.
2797
3156
  # Corresponds to the JSON property `moneyValue`
2798
3157
  # @return [Google::Apis::DocumentaiV1::GoogleTypeMoney]
2799
3158
  attr_accessor :money_value
2800
3159
 
2801
- # Required. Normalized entity value stored as a string. This field is populated
2802
- # for supported document type (e.g. Invoice). For some entity types, one of
2803
- # respective 'structured_value' fields may also be populated. - Money/Currency
2804
- # type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`)
2805
- # is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the
2806
- # ISO 8601 text format.
3160
+ # Optional. An optional field to store a normalized string. For some entity
3161
+ # types, one of respective 'structured_value' fields may also be populated. Also
3162
+ # not all the types of 'structured_value' will be normalized. For example, some
3163
+ # processors may not generate float or int normalized text by default. Below are
3164
+ # sample formats mapped to structured values. - Money/Currency type (`
3165
+ # money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in
3166
+ # the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO
3167
+ # 8601 text format.
2807
3168
  # Corresponds to the JSON property `text`
2808
3169
  # @return [String]
2809
3170
  attr_accessor :text
@@ -2818,6 +3179,8 @@ module Google
2818
3179
  @boolean_value = args[:boolean_value] if args.key?(:boolean_value)
2819
3180
  @date_value = args[:date_value] if args.key?(:date_value)
2820
3181
  @datetime_value = args[:datetime_value] if args.key?(:datetime_value)
3182
+ @float_value = args[:float_value] if args.key?(:float_value)
3183
+ @integer_value = args[:integer_value] if args.key?(:integer_value)
2821
3184
  @money_value = args[:money_value] if args.key?(:money_value)
2822
3185
  @text = args[:text] if args.key?(:text)
2823
3186
  end
@@ -3120,6 +3483,20 @@ module Google
3120
3483
  class GoogleCloudDocumentaiV1beta1DocumentPageFormField
3121
3484
  include Google::Apis::Core::Hashable
3122
3485
 
3486
+ # Created for Labeling UI to export key text. If corrections were made to the
3487
+ # text identified by the `field_name.text_anchor`, this field will contain the
3488
+ # correction.
3489
+ # Corresponds to the JSON property `correctedKeyText`
3490
+ # @return [String]
3491
+ attr_accessor :corrected_key_text
3492
+
3493
+ # Created for Labeling UI to export value text. If corrections were made to the
3494
+ # text identified by the `field_value.text_anchor`, this field will contain the
3495
+ # correction.
3496
+ # Corresponds to the JSON property `correctedValueText`
3497
+ # @return [String]
3498
+ attr_accessor :corrected_value_text
3499
+
3123
3500
  # Visual element describing a layout unit on a page.
3124
3501
  # Corresponds to the JSON property `fieldName`
3125
3502
  # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageLayout]
@@ -3159,6 +3536,8 @@ module Google
3159
3536
 
3160
3537
  # Update properties of this object
3161
3538
  def update!(**args)
3539
+ @corrected_key_text = args[:corrected_key_text] if args.key?(:corrected_key_text)
3540
+ @corrected_value_text = args[:corrected_value_text] if args.key?(:corrected_value_text)
3162
3541
  @field_name = args[:field_name] if args.key?(:field_name)
3163
3542
  @field_value = args[:field_value] if args.key?(:field_value)
3164
3543
  @name_detected_languages = args[:name_detected_languages] if args.key?(:name_detected_languages)
@@ -4340,8 +4719,9 @@ module Google
4340
4719
  end
4341
4720
  end
4342
4721
 
4343
- # A phrase in the text that is a known entity type, such as a person, an
4344
- # organization, or location.
4722
+ # An entity that could be a phrase in the text or a property belongs to the
4723
+ # document. It is a known entity type, such as a person, an organization, or
4724
+ # location.
4345
4725
  class GoogleCloudDocumentaiV1beta2DocumentEntity
4346
4726
  include Google::Apis::Core::Hashable
4347
4727
 
@@ -4361,7 +4741,8 @@ module Google
4361
4741
  # @return [String]
4362
4742
  attr_accessor :mention_id
4363
4743
 
4364
- # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`.
4744
+ # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the
4745
+ # entity is not present in the document, this field will be empty.
4365
4746
  # Corresponds to the JSON property `mentionText`
4366
4747
  # @return [String]
4367
4748
  attr_accessor :mention_text
@@ -4480,17 +4861,29 @@ module Google
4480
4861
  # @return [Google::Apis::DocumentaiV1::GoogleTypeDateTime]
4481
4862
  attr_accessor :datetime_value
4482
4863
 
4864
+ # Float value.
4865
+ # Corresponds to the JSON property `floatValue`
4866
+ # @return [Float]
4867
+ attr_accessor :float_value
4868
+
4869
+ # Integer value.
4870
+ # Corresponds to the JSON property `integerValue`
4871
+ # @return [Fixnum]
4872
+ attr_accessor :integer_value
4873
+
4483
4874
  # Represents an amount of money with its currency type.
4484
4875
  # Corresponds to the JSON property `moneyValue`
4485
4876
  # @return [Google::Apis::DocumentaiV1::GoogleTypeMoney]
4486
4877
  attr_accessor :money_value
4487
4878
 
4488
- # Required. Normalized entity value stored as a string. This field is populated
4489
- # for supported document type (e.g. Invoice). For some entity types, one of
4490
- # respective 'structured_value' fields may also be populated. - Money/Currency
4491
- # type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`)
4492
- # is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the
4493
- # ISO 8601 text format.
4879
+ # Optional. An optional field to store a normalized string. For some entity
4880
+ # types, one of respective 'structured_value' fields may also be populated. Also
4881
+ # not all the types of 'structured_value' will be normalized. For example, some
4882
+ # processors may not generate float or int normalized text by default. Below are
4883
+ # sample formats mapped to structured values. - Money/Currency type (`
4884
+ # money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in
4885
+ # the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO
4886
+ # 8601 text format.
4494
4887
  # Corresponds to the JSON property `text`
4495
4888
  # @return [String]
4496
4889
  attr_accessor :text
@@ -4505,6 +4898,8 @@ module Google
4505
4898
  @boolean_value = args[:boolean_value] if args.key?(:boolean_value)
4506
4899
  @date_value = args[:date_value] if args.key?(:date_value)
4507
4900
  @datetime_value = args[:datetime_value] if args.key?(:datetime_value)
4901
+ @float_value = args[:float_value] if args.key?(:float_value)
4902
+ @integer_value = args[:integer_value] if args.key?(:integer_value)
4508
4903
  @money_value = args[:money_value] if args.key?(:money_value)
4509
4904
  @text = args[:text] if args.key?(:text)
4510
4905
  end
@@ -4844,6 +5239,20 @@ module Google
4844
5239
  class GoogleCloudDocumentaiV1beta2DocumentPageFormField
4845
5240
  include Google::Apis::Core::Hashable
4846
5241
 
5242
+ # Created for Labeling UI to export key text. If corrections were made to the
5243
+ # text identified by the `field_name.text_anchor`, this field will contain the
5244
+ # correction.
5245
+ # Corresponds to the JSON property `correctedKeyText`
5246
+ # @return [String]
5247
+ attr_accessor :corrected_key_text
5248
+
5249
+ # Created for Labeling UI to export value text. If corrections were made to the
5250
+ # text identified by the `field_value.text_anchor`, this field will contain the
5251
+ # correction.
5252
+ # Corresponds to the JSON property `correctedValueText`
5253
+ # @return [String]
5254
+ attr_accessor :corrected_value_text
5255
+
4847
5256
  # Visual element describing a layout unit on a page.
4848
5257
  # Corresponds to the JSON property `fieldName`
4849
5258
  # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentPageLayout]
@@ -4883,6 +5292,8 @@ module Google
4883
5292
 
4884
5293
  # Update properties of this object
4885
5294
  def update!(**args)
5295
+ @corrected_key_text = args[:corrected_key_text] if args.key?(:corrected_key_text)
5296
+ @corrected_value_text = args[:corrected_value_text] if args.key?(:corrected_value_text)
4886
5297
  @field_name = args[:field_name] if args.key?(:field_name)
4887
5298
  @field_value = args[:field_value] if args.key?(:field_value)
4888
5299
  @name_detected_languages = args[:name_detected_languages] if args.key?(:name_detected_languages)
@@ -6086,6 +6497,57 @@ module Google
6086
6497
  end
6087
6498
  end
6088
6499
 
6500
+ # The long running operation metadata for delete processor version method.
6501
+ class GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata
6502
+ include Google::Apis::Core::Hashable
6503
+
6504
+ # The common metadata for long running operations.
6505
+ # Corresponds to the JSON property `commonMetadata`
6506
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
6507
+ attr_accessor :common_metadata
6508
+
6509
+ def initialize(**args)
6510
+ update!(**args)
6511
+ end
6512
+
6513
+ # Update properties of this object
6514
+ def update!(**args)
6515
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
6516
+ end
6517
+ end
6518
+
6519
+ # The long running operation metadata for deploy processor version method.
6520
+ class GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata
6521
+ include Google::Apis::Core::Hashable
6522
+
6523
+ # The common metadata for long running operations.
6524
+ # Corresponds to the JSON property `commonMetadata`
6525
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
6526
+ attr_accessor :common_metadata
6527
+
6528
+ def initialize(**args)
6529
+ update!(**args)
6530
+ end
6531
+
6532
+ # Update properties of this object
6533
+ def update!(**args)
6534
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
6535
+ end
6536
+ end
6537
+
6538
+ # Response message for the deploy processor version method.
6539
+ class GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse
6540
+ include Google::Apis::Core::Hashable
6541
+
6542
+ def initialize(**args)
6543
+ update!(**args)
6544
+ end
6545
+
6546
+ # Update properties of this object
6547
+ def update!(**args)
6548
+ end
6549
+ end
6550
+
6089
6551
  # The long running operation metadata for disable processor method.
6090
6552
  class GoogleCloudDocumentaiV1beta3DisableProcessorMetadata
6091
6553
  include Google::Apis::Core::Hashable
@@ -6249,6 +6711,70 @@ module Google
6249
6711
  end
6250
6712
  end
6251
6713
 
6714
+ # The long running operation metadata for set default processor version method.
6715
+ class GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata
6716
+ include Google::Apis::Core::Hashable
6717
+
6718
+ # The common metadata for long running operations.
6719
+ # Corresponds to the JSON property `commonMetadata`
6720
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
6721
+ attr_accessor :common_metadata
6722
+
6723
+ def initialize(**args)
6724
+ update!(**args)
6725
+ end
6726
+
6727
+ # Update properties of this object
6728
+ def update!(**args)
6729
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
6730
+ end
6731
+ end
6732
+
6733
+ # Response message for set default processor version method.
6734
+ class GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse
6735
+ include Google::Apis::Core::Hashable
6736
+
6737
+ def initialize(**args)
6738
+ update!(**args)
6739
+ end
6740
+
6741
+ # Update properties of this object
6742
+ def update!(**args)
6743
+ end
6744
+ end
6745
+
6746
+ # The long running operation metadata for the undeploy processor version method.
6747
+ class GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata
6748
+ include Google::Apis::Core::Hashable
6749
+
6750
+ # The common metadata for long running operations.
6751
+ # Corresponds to the JSON property `commonMetadata`
6752
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
6753
+ attr_accessor :common_metadata
6754
+
6755
+ def initialize(**args)
6756
+ update!(**args)
6757
+ end
6758
+
6759
+ # Update properties of this object
6760
+ def update!(**args)
6761
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
6762
+ end
6763
+ end
6764
+
6765
+ # Response message for the undeploy processor version method.
6766
+ class GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse
6767
+ include Google::Apis::Core::Hashable
6768
+
6769
+ def initialize(**args)
6770
+ update!(**args)
6771
+ end
6772
+
6773
+ # Update properties of this object
6774
+ def update!(**args)
6775
+ end
6776
+ end
6777
+
6252
6778
  # The response message for Locations.ListLocations.
6253
6779
  class GoogleCloudLocationListLocationsResponse
6254
6780
  include Google::Apis::Core::Hashable