google-apis-documentai_v1beta3 0.57.0 → 0.59.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -1633,26 +1633,28 @@ module Google
1633
1633
  class GoogleCloudDocumentaiV1beta1Barcode
1634
1634
  include Google::Apis::Core::Hashable
1635
1635
 
1636
- # Format of a barcode. The supported formats are: CODE_128: Code 128 type.
1637
- # CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type.
1638
- # DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8:
1639
- # EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type.
1640
- # PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type.
1636
+ # Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. -
1637
+ # `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type.
1638
+ # - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13
1639
+ # type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A
1640
+ # type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code
1641
+ # type. - `DATABAR`: GS1 DataBar code type.
1641
1642
  # Corresponds to the JSON property `format`
1642
1643
  # @return [String]
1643
1644
  attr_accessor :format
1644
1645
 
1645
- # Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://
1646
- # www.google.com;;'.
1646
+ # Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https:/
1647
+ # /www.google.com;;'`.
1647
1648
  # Corresponds to the JSON property `rawValue`
1648
1649
  # @return [String]
1649
1650
  attr_accessor :raw_value
1650
1651
 
1651
1652
  # Value format describes the format of the value that a barcode encodes. The
1652
- # supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address.
1653
- # ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS
1654
- # message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-
1655
- # localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license.
1653
+ # supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email
1654
+ # address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`:
1655
+ # Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `
1656
+ # WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`:
1657
+ # Calendar event. - `DRIVER_LICENSE`: Driver's license.
1656
1658
  # Corresponds to the JSON property `valueFormat`
1657
1659
  # @return [String]
1658
1660
  attr_accessor :value_format
@@ -1778,14 +1780,14 @@ module Google
1778
1780
  # @return [String]
1779
1781
  attr_accessor :text
1780
1782
 
1781
- # Placeholder. A list of text corrections made to [Document.text]. This is
1782
- # usually used for annotating corrections to OCR mistakes. Text changes for a
1783
- # given revision may not overlap with each other.
1783
+ # Placeholder. A list of text corrections made to Document.text. This is usually
1784
+ # used for annotating corrections to OCR mistakes. Text changes for a given
1785
+ # revision may not overlap with each other.
1784
1786
  # Corresponds to the JSON property `textChanges`
1785
1787
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentTextChange>]
1786
1788
  attr_accessor :text_changes
1787
1789
 
1788
- # Placeholder. Styles for the Document.text.
1790
+ # Styles for the Document.text.
1789
1791
  # Corresponds to the JSON property `textStyles`
1790
1792
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentStyle>]
1791
1793
  attr_accessor :text_styles
@@ -1825,7 +1827,7 @@ module Google
1825
1827
  class GoogleCloudDocumentaiV1beta1DocumentEntity
1826
1828
  include Google::Apis::Core::Hashable
1827
1829
 
1828
- # Optional. Confidence of detected Schema entity. Range [0, 1].
1830
+ # Optional. Confidence of detected Schema entity. Range `[0, 1]`.
1829
1831
  # Corresponds to the JSON property `confidence`
1830
1832
  # @return [Float]
1831
1833
  attr_accessor :confidence
@@ -1978,8 +1980,8 @@ module Google
1978
1980
  # Optional. An optional field to store a normalized string. For some entity
1979
1981
  # types, one of respective `structured_value` fields may also be populated. Also
1980
1982
  # not all the types of `structured_value` will be normalized. For example, some
1981
- # processors may not generate float or int normalized text by default. Below are
1982
- # sample formats mapped to structured values. - Money/Currency type (`
1983
+ # processors may not generate `float` or `integer` normalized text by default.
1984
+ # Below are sample formats mapped to structured values. - Money/Currency type (`
1983
1985
  # money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in
1984
1986
  # the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO
1985
1987
  # 8601 text format.
@@ -2071,6 +2073,11 @@ module Google
2071
2073
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentPageImage]
2072
2074
  attr_accessor :image
2073
2075
 
2076
+ # Image Quality Scores for the page image
2077
+ # Corresponds to the JSON property `imageQualityScores`
2078
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores]
2079
+ attr_accessor :image_quality_scores
2080
+
2074
2081
  # Visual element describing a layout unit on a page.
2075
2082
  # Corresponds to the JSON property `layout`
2076
2083
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentPageLayout]
@@ -2139,6 +2146,7 @@ module Google
2139
2146
  @dimension = args[:dimension] if args.key?(:dimension)
2140
2147
  @form_fields = args[:form_fields] if args.key?(:form_fields)
2141
2148
  @image = args[:image] if args.key?(:image)
2149
+ @image_quality_scores = args[:image_quality_scores] if args.key?(:image_quality_scores)
2142
2150
  @layout = args[:layout] if args.key?(:layout)
2143
2151
  @lines = args[:lines] if args.key?(:lines)
2144
2152
  @page_number = args[:page_number] if args.key?(:page_number)
@@ -2182,7 +2190,7 @@ module Google
2182
2190
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1BoundingPoly]
2183
2191
  attr_accessor :bounding_poly
2184
2192
 
2185
- # Optional. Confidence of detected page element, if applicable. Range [0, 1].
2193
+ # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
2186
2194
  # Corresponds to the JSON property `confidence`
2187
2195
  # @return [Float]
2188
2196
  attr_accessor :confidence
@@ -2197,10 +2205,10 @@ module Google
2197
2205
  # @return [String]
2198
2206
  attr_accessor :layout_type
2199
2207
 
2200
- # Required. Index into the Document.pages element, for example using Document.
2201
- # pages to locate the related page element. This field is skipped when its value
2202
- # is the default 0. See https://developers.google.com/protocol-buffers/docs/
2203
- # proto3#json.
2208
+ # Required. Index into the Document.pages element, for example using `Document.
2209
+ # pages` to locate the related page element. This field is skipped when its
2210
+ # value is the default `0`. See https://developers.google.com/protocol-buffers/
2211
+ # docs/proto3#json.
2204
2212
  # Corresponds to the JSON property `page`
2205
2213
  # @return [Fixnum]
2206
2214
  attr_accessor :page
@@ -2281,12 +2289,12 @@ module Google
2281
2289
  class GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage
2282
2290
  include Google::Apis::Core::Hashable
2283
2291
 
2284
- # Confidence of detected language. Range [0, 1].
2292
+ # Confidence of detected language. Range `[0, 1]`.
2285
2293
  # Corresponds to the JSON property `confidence`
2286
2294
  # @return [Float]
2287
2295
  attr_accessor :confidence
2288
2296
 
2289
- # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information,
2297
+ # The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information,
2290
2298
  # see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
2291
2299
  # Corresponds to the JSON property `languageCode`
2292
2300
  # @return [String]
@@ -2379,8 +2387,8 @@ module Google
2379
2387
  attr_accessor :value_detected_languages
2380
2388
 
2381
2389
  # If the value is non-textual, this field represents the type. Current valid
2382
- # values are: - blank (this indicates the field_value is normal text) - "
2383
- # unfilled_checkbox" - "filled_checkbox"
2390
+ # values are: - blank (this indicates the `field_value` is normal text) - `
2391
+ # unfilled_checkbox` - `filled_checkbox`
2384
2392
  # Corresponds to the JSON property `valueType`
2385
2393
  # @return [String]
2386
2394
  attr_accessor :value_type
@@ -2440,6 +2448,60 @@ module Google
2440
2448
  end
2441
2449
  end
2442
2450
 
2451
+ # Image Quality Scores for the page image
2452
+ class GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores
2453
+ include Google::Apis::Core::Hashable
2454
+
2455
+ # A list of detected defects.
2456
+ # Corresponds to the JSON property `detectedDefects`
2457
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect>]
2458
+ attr_accessor :detected_defects
2459
+
2460
+ # The overall quality score. Range `[0, 1]` where 1 is perfect quality.
2461
+ # Corresponds to the JSON property `qualityScore`
2462
+ # @return [Float]
2463
+ attr_accessor :quality_score
2464
+
2465
+ def initialize(**args)
2466
+ update!(**args)
2467
+ end
2468
+
2469
+ # Update properties of this object
2470
+ def update!(**args)
2471
+ @detected_defects = args[:detected_defects] if args.key?(:detected_defects)
2472
+ @quality_score = args[:quality_score] if args.key?(:quality_score)
2473
+ end
2474
+ end
2475
+
2476
+ # Image Quality Defects
2477
+ class GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect
2478
+ include Google::Apis::Core::Hashable
2479
+
2480
+ # Confidence of detected defect. Range `[0, 1]` where 1 indicates strong
2481
+ # confidence of that the defect exists.
2482
+ # Corresponds to the JSON property `confidence`
2483
+ # @return [Float]
2484
+ attr_accessor :confidence
2485
+
2486
+ # Name of the defect type. Supported values are: - `quality/defect_blurry` - `
2487
+ # quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `
2488
+ # quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/
2489
+ # defect_text_cutoff` - `quality/defect_glare`
2490
+ # Corresponds to the JSON property `type`
2491
+ # @return [String]
2492
+ attr_accessor :type
2493
+
2494
+ def initialize(**args)
2495
+ update!(**args)
2496
+ end
2497
+
2498
+ # Update properties of this object
2499
+ def update!(**args)
2500
+ @confidence = args[:confidence] if args.key?(:confidence)
2501
+ @type = args[:type] if args.key?(:type)
2502
+ end
2503
+ end
2504
+
2443
2505
  # Visual element describing a layout unit on a page.
2444
2506
  class GoogleCloudDocumentaiV1beta1DocumentPageLayout
2445
2507
  include Google::Apis::Core::Hashable
@@ -2451,7 +2513,7 @@ module Google
2451
2513
 
2452
2514
  # Confidence of the current Layout within context of the object this layout is
2453
2515
  # for. e.g. confidence can be for a single token, a table, a visual element, etc.
2454
- # depending on context. Range [0, 1].
2516
+ # depending on context. Range `[0, 1]`.
2455
2517
  # Corresponds to the JSON property `confidence`
2456
2518
  # @return [Float]
2457
2519
  attr_accessor :confidence
@@ -2635,6 +2697,12 @@ module Google
2635
2697
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentPageLayout]
2636
2698
  attr_accessor :layout
2637
2699
 
2700
+ # Structure to identify provenance relationships between annotations in
2701
+ # different revisions.
2702
+ # Corresponds to the JSON property `provenance`
2703
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentProvenance]
2704
+ attr_accessor :provenance
2705
+
2638
2706
  def initialize(**args)
2639
2707
  update!(**args)
2640
2708
  end
@@ -2645,6 +2713,7 @@ module Google
2645
2713
  @detected_languages = args[:detected_languages] if args.key?(:detected_languages)
2646
2714
  @header_rows = args[:header_rows] if args.key?(:header_rows)
2647
2715
  @layout = args[:layout] if args.key?(:layout)
2716
+ @provenance = args[:provenance] if args.key?(:provenance)
2648
2717
  end
2649
2718
  end
2650
2719
 
@@ -3085,7 +3154,7 @@ module Google
3085
3154
  # @return [Google::Apis::DocumentaiV1beta3::GoogleTypeColor]
3086
3155
  attr_accessor :color
3087
3156
 
3088
- # Font family such as "Arial", "Times New Roman". https://www.w3schools.com/
3157
+ # Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/
3089
3158
  # cssref/pr_font_font-family.asp
3090
3159
  # Corresponds to the JSON property `fontFamily`
3091
3160
  # @return [String]
@@ -3462,26 +3531,28 @@ module Google
3462
3531
  class GoogleCloudDocumentaiV1beta2Barcode
3463
3532
  include Google::Apis::Core::Hashable
3464
3533
 
3465
- # Format of a barcode. The supported formats are: CODE_128: Code 128 type.
3466
- # CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type.
3467
- # DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8:
3468
- # EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type.
3469
- # PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type.
3534
+ # Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. -
3535
+ # `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type.
3536
+ # - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13
3537
+ # type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A
3538
+ # type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code
3539
+ # type. - `DATABAR`: GS1 DataBar code type.
3470
3540
  # Corresponds to the JSON property `format`
3471
3541
  # @return [String]
3472
3542
  attr_accessor :format
3473
3543
 
3474
- # Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://
3475
- # www.google.com;;'.
3544
+ # Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https:/
3545
+ # /www.google.com;;'`.
3476
3546
  # Corresponds to the JSON property `rawValue`
3477
3547
  # @return [String]
3478
3548
  attr_accessor :raw_value
3479
3549
 
3480
3550
  # Value format describes the format of the value that a barcode encodes. The
3481
- # supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address.
3482
- # ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS
3483
- # message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-
3484
- # localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license.
3551
+ # supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email
3552
+ # address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`:
3553
+ # Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `
3554
+ # WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`:
3555
+ # Calendar event. - `DRIVER_LICENSE`: Driver's license.
3485
3556
  # Corresponds to the JSON property `valueFormat`
3486
3557
  # @return [String]
3487
3558
  attr_accessor :value_format
@@ -3612,14 +3683,14 @@ module Google
3612
3683
  # @return [String]
3613
3684
  attr_accessor :text
3614
3685
 
3615
- # Placeholder. A list of text corrections made to [Document.text]. This is
3616
- # usually used for annotating corrections to OCR mistakes. Text changes for a
3617
- # given revision may not overlap with each other.
3686
+ # Placeholder. A list of text corrections made to Document.text. This is usually
3687
+ # used for annotating corrections to OCR mistakes. Text changes for a given
3688
+ # revision may not overlap with each other.
3618
3689
  # Corresponds to the JSON property `textChanges`
3619
3690
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentTextChange>]
3620
3691
  attr_accessor :text_changes
3621
3692
 
3622
- # Placeholder. Styles for the Document.text.
3693
+ # Styles for the Document.text.
3623
3694
  # Corresponds to the JSON property `textStyles`
3624
3695
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentStyle>]
3625
3696
  attr_accessor :text_styles
@@ -3660,7 +3731,7 @@ module Google
3660
3731
  class GoogleCloudDocumentaiV1beta2DocumentEntity
3661
3732
  include Google::Apis::Core::Hashable
3662
3733
 
3663
- # Optional. Confidence of detected Schema entity. Range [0, 1].
3734
+ # Optional. Confidence of detected Schema entity. Range `[0, 1]`.
3664
3735
  # Corresponds to the JSON property `confidence`
3665
3736
  # @return [Float]
3666
3737
  attr_accessor :confidence
@@ -3813,8 +3884,8 @@ module Google
3813
3884
  # Optional. An optional field to store a normalized string. For some entity
3814
3885
  # types, one of respective `structured_value` fields may also be populated. Also
3815
3886
  # not all the types of `structured_value` will be normalized. For example, some
3816
- # processors may not generate float or int normalized text by default. Below are
3817
- # sample formats mapped to structured values. - Money/Currency type (`
3887
+ # processors may not generate `float` or `integer` normalized text by default.
3888
+ # Below are sample formats mapped to structured values. - Money/Currency type (`
3818
3889
  # money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in
3819
3890
  # the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO
3820
3891
  # 8601 text format.
@@ -3943,6 +4014,11 @@ module Google
3943
4014
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentPageImage]
3944
4015
  attr_accessor :image
3945
4016
 
4017
+ # Image Quality Scores for the page image
4018
+ # Corresponds to the JSON property `imageQualityScores`
4019
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores]
4020
+ attr_accessor :image_quality_scores
4021
+
3946
4022
  # Visual element describing a layout unit on a page.
3947
4023
  # Corresponds to the JSON property `layout`
3948
4024
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentPageLayout]
@@ -4011,6 +4087,7 @@ module Google
4011
4087
  @dimension = args[:dimension] if args.key?(:dimension)
4012
4088
  @form_fields = args[:form_fields] if args.key?(:form_fields)
4013
4089
  @image = args[:image] if args.key?(:image)
4090
+ @image_quality_scores = args[:image_quality_scores] if args.key?(:image_quality_scores)
4014
4091
  @layout = args[:layout] if args.key?(:layout)
4015
4092
  @lines = args[:lines] if args.key?(:lines)
4016
4093
  @page_number = args[:page_number] if args.key?(:page_number)
@@ -4054,7 +4131,7 @@ module Google
4054
4131
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2BoundingPoly]
4055
4132
  attr_accessor :bounding_poly
4056
4133
 
4057
- # Optional. Confidence of detected page element, if applicable. Range [0, 1].
4134
+ # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
4058
4135
  # Corresponds to the JSON property `confidence`
4059
4136
  # @return [Float]
4060
4137
  attr_accessor :confidence
@@ -4069,10 +4146,10 @@ module Google
4069
4146
  # @return [String]
4070
4147
  attr_accessor :layout_type
4071
4148
 
4072
- # Required. Index into the Document.pages element, for example using Document.
4073
- # pages to locate the related page element. This field is skipped when its value
4074
- # is the default 0. See https://developers.google.com/protocol-buffers/docs/
4075
- # proto3#json.
4149
+ # Required. Index into the Document.pages element, for example using `Document.
4150
+ # pages` to locate the related page element. This field is skipped when its
4151
+ # value is the default `0`. See https://developers.google.com/protocol-buffers/
4152
+ # docs/proto3#json.
4076
4153
  # Corresponds to the JSON property `page`
4077
4154
  # @return [Fixnum]
4078
4155
  attr_accessor :page
@@ -4153,12 +4230,12 @@ module Google
4153
4230
  class GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage
4154
4231
  include Google::Apis::Core::Hashable
4155
4232
 
4156
- # Confidence of detected language. Range [0, 1].
4233
+ # Confidence of detected language. Range `[0, 1]`.
4157
4234
  # Corresponds to the JSON property `confidence`
4158
4235
  # @return [Float]
4159
4236
  attr_accessor :confidence
4160
4237
 
4161
- # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information,
4238
+ # The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information,
4162
4239
  # see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
4163
4240
  # Corresponds to the JSON property `languageCode`
4164
4241
  # @return [String]
@@ -4251,8 +4328,8 @@ module Google
4251
4328
  attr_accessor :value_detected_languages
4252
4329
 
4253
4330
  # If the value is non-textual, this field represents the type. Current valid
4254
- # values are: - blank (this indicates the field_value is normal text) - "
4255
- # unfilled_checkbox" - "filled_checkbox"
4331
+ # values are: - blank (this indicates the `field_value` is normal text) - `
4332
+ # unfilled_checkbox` - `filled_checkbox`
4256
4333
  # Corresponds to the JSON property `valueType`
4257
4334
  # @return [String]
4258
4335
  attr_accessor :value_type
@@ -4312,6 +4389,60 @@ module Google
4312
4389
  end
4313
4390
  end
4314
4391
 
4392
+ # Image Quality Scores for the page image
4393
+ class GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores
4394
+ include Google::Apis::Core::Hashable
4395
+
4396
+ # A list of detected defects.
4397
+ # Corresponds to the JSON property `detectedDefects`
4398
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect>]
4399
+ attr_accessor :detected_defects
4400
+
4401
+ # The overall quality score. Range `[0, 1]` where 1 is perfect quality.
4402
+ # Corresponds to the JSON property `qualityScore`
4403
+ # @return [Float]
4404
+ attr_accessor :quality_score
4405
+
4406
+ def initialize(**args)
4407
+ update!(**args)
4408
+ end
4409
+
4410
+ # Update properties of this object
4411
+ def update!(**args)
4412
+ @detected_defects = args[:detected_defects] if args.key?(:detected_defects)
4413
+ @quality_score = args[:quality_score] if args.key?(:quality_score)
4414
+ end
4415
+ end
4416
+
4417
+ # Image Quality Defects
4418
+ class GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect
4419
+ include Google::Apis::Core::Hashable
4420
+
4421
+ # Confidence of detected defect. Range `[0, 1]` where 1 indicates strong
4422
+ # confidence of that the defect exists.
4423
+ # Corresponds to the JSON property `confidence`
4424
+ # @return [Float]
4425
+ attr_accessor :confidence
4426
+
4427
+ # Name of the defect type. Supported values are: - `quality/defect_blurry` - `
4428
+ # quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `
4429
+ # quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/
4430
+ # defect_text_cutoff` - `quality/defect_glare`
4431
+ # Corresponds to the JSON property `type`
4432
+ # @return [String]
4433
+ attr_accessor :type
4434
+
4435
+ def initialize(**args)
4436
+ update!(**args)
4437
+ end
4438
+
4439
+ # Update properties of this object
4440
+ def update!(**args)
4441
+ @confidence = args[:confidence] if args.key?(:confidence)
4442
+ @type = args[:type] if args.key?(:type)
4443
+ end
4444
+ end
4445
+
4315
4446
  # Visual element describing a layout unit on a page.
4316
4447
  class GoogleCloudDocumentaiV1beta2DocumentPageLayout
4317
4448
  include Google::Apis::Core::Hashable
@@ -4323,7 +4454,7 @@ module Google
4323
4454
 
4324
4455
  # Confidence of the current Layout within context of the object this layout is
4325
4456
  # for. e.g. confidence can be for a single token, a table, a visual element, etc.
4326
- # depending on context. Range [0, 1].
4457
+ # depending on context. Range `[0, 1]`.
4327
4458
  # Corresponds to the JSON property `confidence`
4328
4459
  # @return [Float]
4329
4460
  attr_accessor :confidence
@@ -4507,6 +4638,12 @@ module Google
4507
4638
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentPageLayout]
4508
4639
  attr_accessor :layout
4509
4640
 
4641
+ # Structure to identify provenance relationships between annotations in
4642
+ # different revisions.
4643
+ # Corresponds to the JSON property `provenance`
4644
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentProvenance]
4645
+ attr_accessor :provenance
4646
+
4510
4647
  def initialize(**args)
4511
4648
  update!(**args)
4512
4649
  end
@@ -4517,6 +4654,7 @@ module Google
4517
4654
  @detected_languages = args[:detected_languages] if args.key?(:detected_languages)
4518
4655
  @header_rows = args[:header_rows] if args.key?(:header_rows)
4519
4656
  @layout = args[:layout] if args.key?(:layout)
4657
+ @provenance = args[:provenance] if args.key?(:provenance)
4520
4658
  end
4521
4659
  end
4522
4660
 
@@ -4957,7 +5095,7 @@ module Google
4957
5095
  # @return [Google::Apis::DocumentaiV1beta3::GoogleTypeColor]
4958
5096
  attr_accessor :color
4959
5097
 
4960
- # Font family such as "Arial", "Times New Roman". https://www.w3schools.com/
5098
+ # Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/
4961
5099
  # cssref/pr_font_font-family.asp
4962
5100
  # Corresponds to the JSON property `fontFamily`
4963
5101
  # @return [String]
@@ -5344,26 +5482,28 @@ module Google
5344
5482
  class GoogleCloudDocumentaiV1beta3Barcode
5345
5483
  include Google::Apis::Core::Hashable
5346
5484
 
5347
- # Format of a barcode. The supported formats are: CODE_128: Code 128 type.
5348
- # CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type.
5349
- # DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8:
5350
- # EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type.
5351
- # PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type.
5485
+ # Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. -
5486
+ # `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type.
5487
+ # - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13
5488
+ # type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A
5489
+ # type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code
5490
+ # type. - `DATABAR`: GS1 DataBar code type.
5352
5491
  # Corresponds to the JSON property `format`
5353
5492
  # @return [String]
5354
5493
  attr_accessor :format
5355
5494
 
5356
- # Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://
5357
- # www.google.com;;'.
5495
+ # Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https:/
5496
+ # /www.google.com;;'`.
5358
5497
  # Corresponds to the JSON property `rawValue`
5359
5498
  # @return [String]
5360
5499
  attr_accessor :raw_value
5361
5500
 
5362
5501
  # Value format describes the format of the value that a barcode encodes. The
5363
- # supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address.
5364
- # ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS
5365
- # message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-
5366
- # localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license.
5502
+ # supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email
5503
+ # address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`:
5504
+ # Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `
5505
+ # WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`:
5506
+ # Calendar event. - `DRIVER_LICENSE`: Driver's license.
5367
5507
  # Corresponds to the JSON property `valueFormat`
5368
5508
  # @return [String]
5369
5509
  attr_accessor :value_format
@@ -5529,6 +5669,11 @@ module Google
5529
5669
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig]
5530
5670
  attr_accessor :output_config
5531
5671
 
5672
+ # Options for Process API
5673
+ # Corresponds to the JSON property `processOptions`
5674
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessOptions]
5675
+ attr_accessor :process_options
5676
+
5532
5677
  # Whether Human Review feature should be skipped for this request. Default to
5533
5678
  # false.
5534
5679
  # Corresponds to the JSON property `skipHumanReview`
@@ -5546,6 +5691,7 @@ module Google
5546
5691
  @input_configs = args[:input_configs] if args.key?(:input_configs)
5547
5692
  @input_documents = args[:input_documents] if args.key?(:input_documents)
5548
5693
  @output_config = args[:output_config] if args.key?(:output_config)
5694
+ @process_options = args[:process_options] if args.key?(:process_options)
5549
5695
  @skip_human_review = args[:skip_human_review] if args.key?(:skip_human_review)
5550
5696
  end
5551
5697
  end
@@ -5870,14 +6016,14 @@ module Google
5870
6016
  # @return [String]
5871
6017
  attr_accessor :text
5872
6018
 
5873
- # Placeholder. A list of text corrections made to [Document.text]. This is
5874
- # usually used for annotating corrections to OCR mistakes. Text changes for a
5875
- # given revision may not overlap with each other.
6019
+ # Placeholder. A list of text corrections made to Document.text. This is usually
6020
+ # used for annotating corrections to OCR mistakes. Text changes for a given
6021
+ # revision may not overlap with each other.
5876
6022
  # Corresponds to the JSON property `textChanges`
5877
6023
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentTextChange>]
5878
6024
  attr_accessor :text_changes
5879
6025
 
5880
- # Placeholder. Styles for the Document.text.
6026
+ # Styles for the Document.text.
5881
6027
  # Corresponds to the JSON property `textStyles`
5882
6028
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentStyle>]
5883
6029
  attr_accessor :text_styles
@@ -5917,7 +6063,7 @@ module Google
5917
6063
  class GoogleCloudDocumentaiV1beta3DocumentEntity
5918
6064
  include Google::Apis::Core::Hashable
5919
6065
 
5920
- # Optional. Confidence of detected Schema entity. Range [0, 1].
6066
+ # Optional. Confidence of detected Schema entity. Range `[0, 1]`.
5921
6067
  # Corresponds to the JSON property `confidence`
5922
6068
  # @return [Float]
5923
6069
  attr_accessor :confidence
@@ -6070,8 +6216,8 @@ module Google
6070
6216
  # Optional. An optional field to store a normalized string. For some entity
6071
6217
  # types, one of respective `structured_value` fields may also be populated. Also
6072
6218
  # not all the types of `structured_value` will be normalized. For example, some
6073
- # processors may not generate float or int normalized text by default. Below are
6074
- # sample formats mapped to structured values. - Money/Currency type (`
6219
+ # processors may not generate `float` or `integer` normalized text by default.
6220
+ # Below are sample formats mapped to structured values. - Money/Currency type (`
6075
6221
  # money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in
6076
6222
  # the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO
6077
6223
  # 8601 text format.
@@ -6151,7 +6297,9 @@ module Google
6151
6297
  class GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfig
6152
6298
  include Google::Apis::Core::Hashable
6153
6299
 
6154
- # Specifies which fields to include in the output documents.
6300
+ # Specifies which fields to include in the output documents. Only supports top
6301
+ # level document and pages field so it must be in the form of ``
6302
+ # document_field_name`` or `pages.`page_field_name``.
6155
6303
  # Corresponds to the JSON property `fieldMask`
6156
6304
  # @return [String]
6157
6305
  attr_accessor :field_mask
@@ -6161,6 +6309,11 @@ module Google
6161
6309
  # @return [String]
6162
6310
  attr_accessor :gcs_uri
6163
6311
 
6312
+ # The sharding config for the output document.
6313
+ # Corresponds to the JSON property `shardingConfig`
6314
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfigShardingConfig]
6315
+ attr_accessor :sharding_config
6316
+
6164
6317
  def initialize(**args)
6165
6318
  update!(**args)
6166
6319
  end
@@ -6169,6 +6322,32 @@ module Google
6169
6322
  def update!(**args)
6170
6323
  @field_mask = args[:field_mask] if args.key?(:field_mask)
6171
6324
  @gcs_uri = args[:gcs_uri] if args.key?(:gcs_uri)
6325
+ @sharding_config = args[:sharding_config] if args.key?(:sharding_config)
6326
+ end
6327
+ end
6328
+
6329
+ # The sharding config for the output document.
6330
+ class GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfigShardingConfig
6331
+ include Google::Apis::Core::Hashable
6332
+
6333
+ # The number of overlapping pages between consecutive shards.
6334
+ # Corresponds to the JSON property `pagesOverlap`
6335
+ # @return [Fixnum]
6336
+ attr_accessor :pages_overlap
6337
+
6338
+ # The number of pages per shard.
6339
+ # Corresponds to the JSON property `pagesPerShard`
6340
+ # @return [Fixnum]
6341
+ attr_accessor :pages_per_shard
6342
+
6343
+ def initialize(**args)
6344
+ update!(**args)
6345
+ end
6346
+
6347
+ # Update properties of this object
6348
+ def update!(**args)
6349
+ @pages_overlap = args[:pages_overlap] if args.key?(:pages_overlap)
6350
+ @pages_per_shard = args[:pages_per_shard] if args.key?(:pages_per_shard)
6172
6351
  end
6173
6352
  end
6174
6353
 
@@ -6208,6 +6387,11 @@ module Google
6208
6387
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageImage]
6209
6388
  attr_accessor :image
6210
6389
 
6390
+ # Image Quality Scores for the page image
6391
+ # Corresponds to the JSON property `imageQualityScores`
6392
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScores]
6393
+ attr_accessor :image_quality_scores
6394
+
6211
6395
  # Visual element describing a layout unit on a page.
6212
6396
  # Corresponds to the JSON property `layout`
6213
6397
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageLayout]
@@ -6276,6 +6460,7 @@ module Google
6276
6460
  @dimension = args[:dimension] if args.key?(:dimension)
6277
6461
  @form_fields = args[:form_fields] if args.key?(:form_fields)
6278
6462
  @image = args[:image] if args.key?(:image)
6463
+ @image_quality_scores = args[:image_quality_scores] if args.key?(:image_quality_scores)
6279
6464
  @layout = args[:layout] if args.key?(:layout)
6280
6465
  @lines = args[:lines] if args.key?(:lines)
6281
6466
  @page_number = args[:page_number] if args.key?(:page_number)
@@ -6319,7 +6504,7 @@ module Google
6319
6504
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BoundingPoly]
6320
6505
  attr_accessor :bounding_poly
6321
6506
 
6322
- # Optional. Confidence of detected page element, if applicable. Range [0, 1].
6507
+ # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
6323
6508
  # Corresponds to the JSON property `confidence`
6324
6509
  # @return [Float]
6325
6510
  attr_accessor :confidence
@@ -6334,10 +6519,10 @@ module Google
6334
6519
  # @return [String]
6335
6520
  attr_accessor :layout_type
6336
6521
 
6337
- # Required. Index into the Document.pages element, for example using Document.
6338
- # pages to locate the related page element. This field is skipped when its value
6339
- # is the default 0. See https://developers.google.com/protocol-buffers/docs/
6340
- # proto3#json.
6522
+ # Required. Index into the Document.pages element, for example using `Document.
6523
+ # pages` to locate the related page element. This field is skipped when its
6524
+ # value is the default `0`. See https://developers.google.com/protocol-buffers/
6525
+ # docs/proto3#json.
6341
6526
  # Corresponds to the JSON property `page`
6342
6527
  # @return [Fixnum]
6343
6528
  attr_accessor :page
@@ -6418,12 +6603,12 @@ module Google
6418
6603
  class GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage
6419
6604
  include Google::Apis::Core::Hashable
6420
6605
 
6421
- # Confidence of detected language. Range [0, 1].
6606
+ # Confidence of detected language. Range `[0, 1]`.
6422
6607
  # Corresponds to the JSON property `confidence`
6423
6608
  # @return [Float]
6424
6609
  attr_accessor :confidence
6425
6610
 
6426
- # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information,
6611
+ # The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information,
6427
6612
  # see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
6428
6613
  # Corresponds to the JSON property `languageCode`
6429
6614
  # @return [String]
@@ -6516,8 +6701,8 @@ module Google
6516
6701
  attr_accessor :value_detected_languages
6517
6702
 
6518
6703
  # If the value is non-textual, this field represents the type. Current valid
6519
- # values are: - blank (this indicates the field_value is normal text) - "
6520
- # unfilled_checkbox" - "filled_checkbox"
6704
+ # values are: - blank (this indicates the `field_value` is normal text) - `
6705
+ # unfilled_checkbox` - `filled_checkbox`
6521
6706
  # Corresponds to the JSON property `valueType`
6522
6707
  # @return [String]
6523
6708
  attr_accessor :value_type
@@ -6577,6 +6762,60 @@ module Google
6577
6762
  end
6578
6763
  end
6579
6764
 
6765
+ # Image Quality Scores for the page image
6766
+ class GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScores
6767
+ include Google::Apis::Core::Hashable
6768
+
6769
+ # A list of detected defects.
6770
+ # Corresponds to the JSON property `detectedDefects`
6771
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScoresDetectedDefect>]
6772
+ attr_accessor :detected_defects
6773
+
6774
+ # The overall quality score. Range `[0, 1]` where 1 is perfect quality.
6775
+ # Corresponds to the JSON property `qualityScore`
6776
+ # @return [Float]
6777
+ attr_accessor :quality_score
6778
+
6779
+ def initialize(**args)
6780
+ update!(**args)
6781
+ end
6782
+
6783
+ # Update properties of this object
6784
+ def update!(**args)
6785
+ @detected_defects = args[:detected_defects] if args.key?(:detected_defects)
6786
+ @quality_score = args[:quality_score] if args.key?(:quality_score)
6787
+ end
6788
+ end
6789
+
6790
+ # Image Quality Defects
6791
+ class GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScoresDetectedDefect
6792
+ include Google::Apis::Core::Hashable
6793
+
6794
+ # Confidence of detected defect. Range `[0, 1]` where 1 indicates strong
6795
+ # confidence of that the defect exists.
6796
+ # Corresponds to the JSON property `confidence`
6797
+ # @return [Float]
6798
+ attr_accessor :confidence
6799
+
6800
+ # Name of the defect type. Supported values are: - `quality/defect_blurry` - `
6801
+ # quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `
6802
+ # quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/
6803
+ # defect_text_cutoff` - `quality/defect_glare`
6804
+ # Corresponds to the JSON property `type`
6805
+ # @return [String]
6806
+ attr_accessor :type
6807
+
6808
+ def initialize(**args)
6809
+ update!(**args)
6810
+ end
6811
+
6812
+ # Update properties of this object
6813
+ def update!(**args)
6814
+ @confidence = args[:confidence] if args.key?(:confidence)
6815
+ @type = args[:type] if args.key?(:type)
6816
+ end
6817
+ end
6818
+
6580
6819
  # Visual element describing a layout unit on a page.
6581
6820
  class GoogleCloudDocumentaiV1beta3DocumentPageLayout
6582
6821
  include Google::Apis::Core::Hashable
@@ -6588,7 +6827,7 @@ module Google
6588
6827
 
6589
6828
  # Confidence of the current Layout within context of the object this layout is
6590
6829
  # for. e.g. confidence can be for a single token, a table, a visual element, etc.
6591
- # depending on context. Range [0, 1].
6830
+ # depending on context. Range `[0, 1]`.
6592
6831
  # Corresponds to the JSON property `confidence`
6593
6832
  # @return [Float]
6594
6833
  attr_accessor :confidence
@@ -6772,6 +7011,12 @@ module Google
6772
7011
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageLayout]
6773
7012
  attr_accessor :layout
6774
7013
 
7014
+ # Structure to identify provenance relationships between annotations in
7015
+ # different revisions.
7016
+ # Corresponds to the JSON property `provenance`
7017
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentProvenance]
7018
+ attr_accessor :provenance
7019
+
6775
7020
  def initialize(**args)
6776
7021
  update!(**args)
6777
7022
  end
@@ -6782,6 +7027,7 @@ module Google
6782
7027
  @detected_languages = args[:detected_languages] if args.key?(:detected_languages)
6783
7028
  @header_rows = args[:header_rows] if args.key?(:header_rows)
6784
7029
  @layout = args[:layout] if args.key?(:layout)
7030
+ @provenance = args[:provenance] if args.key?(:provenance)
6785
7031
  end
6786
7032
  end
6787
7033
 
@@ -7140,24 +7386,19 @@ module Google
7140
7386
  # @return [String]
7141
7387
  attr_accessor :display_name
7142
7388
 
7143
- # Metadata about an entity type.
7144
- # Corresponds to the JSON property `entityTypeMetadata`
7145
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EntityTypeMetadata]
7146
- attr_accessor :entity_type_metadata
7147
-
7148
7389
  # Defines the a list of enum values.
7149
7390
  # Corresponds to the JSON property `enumValues`
7150
7391
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues]
7151
7392
  attr_accessor :enum_values
7152
7393
 
7153
7394
  # Name of the type. It must be unique within the schema file and cannot be a '
7154
- # Common Type'. Besides that we use the following naming conventions: - *use
7155
- # snake_casing* - name matching is case-insensitive - Maximum 64 characters. -
7395
+ # Common Type'. Besides that we use the following naming conventions: - *use `
7396
+ # snake_casing`* - name matching is case-sensitive - Maximum 64 characters. -
7156
7397
  # Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (
7157
7398
  # For backward compatibility internal infrastructure and tooling can handle any
7158
- # ascii character) - The '/' is sometimes used to denote a property of a type.
7159
- # For example line_item/amount. This convention is deprecated, but will still be
7160
- # honored for backward compatibility.
7399
+ # ascii character) - The `/` is sometimes used to denote a property of a type.
7400
+ # For example `line_item/amount`. This convention is deprecated, but will still
7401
+ # be honored for backward compatibility.
7161
7402
  # Corresponds to the JSON property `name`
7162
7403
  # @return [String]
7163
7404
  attr_accessor :name
@@ -7175,7 +7416,6 @@ module Google
7175
7416
  def update!(**args)
7176
7417
  @base_types = args[:base_types] if args.key?(:base_types)
7177
7418
  @display_name = args[:display_name] if args.key?(:display_name)
7178
- @entity_type_metadata = args[:entity_type_metadata] if args.key?(:entity_type_metadata)
7179
7419
  @enum_values = args[:enum_values] if args.key?(:enum_values)
7180
7420
  @name = args[:name] if args.key?(:name)
7181
7421
  @properties = args[:properties] if args.key?(:properties)
@@ -7216,11 +7456,6 @@ module Google
7216
7456
  # @return [String]
7217
7457
  attr_accessor :occurrence_type
7218
7458
 
7219
- # Metadata about a property.
7220
- # Corresponds to the JSON property `propertyMetadata`
7221
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3PropertyMetadata]
7222
- attr_accessor :property_metadata
7223
-
7224
7459
  # A reference to the value type of the property. This type is subject to the
7225
7460
  # same conventions as the `Entity.base_types` field.
7226
7461
  # Corresponds to the JSON property `valueType`
@@ -7235,7 +7470,6 @@ module Google
7235
7470
  def update!(**args)
7236
7471
  @name = args[:name] if args.key?(:name)
7237
7472
  @occurrence_type = args[:occurrence_type] if args.key?(:occurrence_type)
7238
- @property_metadata = args[:property_metadata] if args.key?(:property_metadata)
7239
7473
  @value_type = args[:value_type] if args.key?(:value_type)
7240
7474
  end
7241
7475
  end
@@ -7421,7 +7655,7 @@ module Google
7421
7655
  # @return [Google::Apis::DocumentaiV1beta3::GoogleTypeColor]
7422
7656
  attr_accessor :color
7423
7657
 
7424
- # Font family such as "Arial", "Times New Roman". https://www.w3schools.com/
7658
+ # Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/
7425
7659
  # cssref/pr_font_font-family.asp
7426
7660
  # Corresponds to the JSON property `fontFamily`
7427
7661
  # @return [String]
@@ -7627,25 +7861,304 @@ module Google
7627
7861
  end
7628
7862
  end
7629
7863
 
7630
- # Metadata about an entity type.
7631
- class GoogleCloudDocumentaiV1beta3EntityTypeMetadata
7864
+ # Metadata of the EvaluateProcessorVersion method.
7865
+ class GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata
7632
7866
  include Google::Apis::Core::Hashable
7633
7867
 
7634
- # Metadata for human review labeling config.
7635
- # Corresponds to the JSON property `humanReviewLabelingMetadata`
7636
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3HumanReviewLabelingMetadata]
7637
- attr_accessor :human_review_labeling_metadata
7868
+ # The common metadata for long running operations.
7869
+ # Corresponds to the JSON property `commonMetadata`
7870
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
7871
+ attr_accessor :common_metadata
7638
7872
 
7639
- # Metadata for Human Review config.
7640
- # Corresponds to the JSON property `humanReviewMetadata`
7641
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3HumanReviewValidationMetadata]
7642
- attr_accessor :human_review_metadata
7873
+ def initialize(**args)
7874
+ update!(**args)
7875
+ end
7643
7876
 
7644
- # Whether the entity type should be considered as "inactive".
7645
- # Corresponds to the JSON property `inactive`
7646
- # @return [Boolean]
7647
- attr_accessor :inactive
7648
- alias_method :inactive?, :inactive
7877
+ # Update properties of this object
7878
+ def update!(**args)
7879
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
7880
+ end
7881
+ end
7882
+
7883
+ # Evaluates the given ProcessorVersion against the supplied documents.
7884
+ class GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionRequest
7885
+ include Google::Apis::Core::Hashable
7886
+
7887
+ # The common config to specify a set of documents used as input.
7888
+ # Corresponds to the JSON property `evaluationDocuments`
7889
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig]
7890
+ attr_accessor :evaluation_documents
7891
+
7892
+ def initialize(**args)
7893
+ update!(**args)
7894
+ end
7895
+
7896
+ # Update properties of this object
7897
+ def update!(**args)
7898
+ @evaluation_documents = args[:evaluation_documents] if args.key?(:evaluation_documents)
7899
+ end
7900
+ end
7901
+
7902
+ # Metadata of the EvaluateProcessorVersion method.
7903
+ class GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse
7904
+ include Google::Apis::Core::Hashable
7905
+
7906
+ # The resource name of the created evaluation.
7907
+ # Corresponds to the JSON property `evaluation`
7908
+ # @return [String]
7909
+ attr_accessor :evaluation
7910
+
7911
+ def initialize(**args)
7912
+ update!(**args)
7913
+ end
7914
+
7915
+ # Update properties of this object
7916
+ def update!(**args)
7917
+ @evaluation = args[:evaluation] if args.key?(:evaluation)
7918
+ end
7919
+ end
7920
+
7921
+ # An evaluation of a ProcessorVersion's performance.
7922
+ class GoogleCloudDocumentaiV1beta3Evaluation
7923
+ include Google::Apis::Core::Hashable
7924
+
7925
+ # Metrics across multiple confidence levels.
7926
+ # Corresponds to the JSON property `allEntitiesMetrics`
7927
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EvaluationMultiConfidenceMetrics]
7928
+ attr_accessor :all_entities_metrics
7929
+
7930
+ # The time that the evaluation was created.
7931
+ # Corresponds to the JSON property `createTime`
7932
+ # @return [String]
7933
+ attr_accessor :create_time
7934
+
7935
+ # Evaluation counters for the documents that were used.
7936
+ # Corresponds to the JSON property `documentCounters`
7937
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EvaluationCounters]
7938
+ attr_accessor :document_counters
7939
+
7940
+ # Metrics across confidence levels, for different entities.
7941
+ # Corresponds to the JSON property `entityMetrics`
7942
+ # @return [Hash<String,Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EvaluationMultiConfidenceMetrics>]
7943
+ attr_accessor :entity_metrics
7944
+
7945
+ # The KMS key name used for encryption.
7946
+ # Corresponds to the JSON property `kmsKeyName`
7947
+ # @return [String]
7948
+ attr_accessor :kms_key_name
7949
+
7950
+ # The KMS key version with which data is encrypted.
7951
+ # Corresponds to the JSON property `kmsKeyVersionName`
7952
+ # @return [String]
7953
+ attr_accessor :kms_key_version_name
7954
+
7955
+ # The resource name of the evaluation. Format: `projects/`project`/locations/`
7956
+ # location`/processors/`processor`/processorVersions/`processor_version`/
7957
+ # evaluations/`evaluation``
7958
+ # Corresponds to the JSON property `name`
7959
+ # @return [String]
7960
+ attr_accessor :name
7961
+
7962
+ def initialize(**args)
7963
+ update!(**args)
7964
+ end
7965
+
7966
+ # Update properties of this object
7967
+ def update!(**args)
7968
+ @all_entities_metrics = args[:all_entities_metrics] if args.key?(:all_entities_metrics)
7969
+ @create_time = args[:create_time] if args.key?(:create_time)
7970
+ @document_counters = args[:document_counters] if args.key?(:document_counters)
7971
+ @entity_metrics = args[:entity_metrics] if args.key?(:entity_metrics)
7972
+ @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
7973
+ @kms_key_version_name = args[:kms_key_version_name] if args.key?(:kms_key_version_name)
7974
+ @name = args[:name] if args.key?(:name)
7975
+ end
7976
+ end
7977
+
7978
+ # Evaluations metrics, at a specific confidence level.
7979
+ class GoogleCloudDocumentaiV1beta3EvaluationConfidenceLevelMetrics
7980
+ include Google::Apis::Core::Hashable
7981
+
7982
+ # The confidence level.
7983
+ # Corresponds to the JSON property `confidenceLevel`
7984
+ # @return [Float]
7985
+ attr_accessor :confidence_level
7986
+
7987
+ # Evaluation metrics, either in aggregate or about a specific entity.
7988
+ # Corresponds to the JSON property `metrics`
7989
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EvaluationMetrics]
7990
+ attr_accessor :metrics
7991
+
7992
+ def initialize(**args)
7993
+ update!(**args)
7994
+ end
7995
+
7996
+ # Update properties of this object
7997
+ def update!(**args)
7998
+ @confidence_level = args[:confidence_level] if args.key?(:confidence_level)
7999
+ @metrics = args[:metrics] if args.key?(:metrics)
8000
+ end
8001
+ end
8002
+
8003
+ # Evaluation counters for the documents that were used.
8004
+ class GoogleCloudDocumentaiV1beta3EvaluationCounters
8005
+ include Google::Apis::Core::Hashable
8006
+
8007
+ # How many documents were used in the evaluation.
8008
+ # Corresponds to the JSON property `evaluatedDocumentsCount`
8009
+ # @return [Fixnum]
8010
+ attr_accessor :evaluated_documents_count
8011
+
8012
+ # How many documents were not included in the evaluation as Document AI failed
8013
+ # to process them.
8014
+ # Corresponds to the JSON property `failedDocumentsCount`
8015
+ # @return [Fixnum]
8016
+ attr_accessor :failed_documents_count
8017
+
8018
+ # How many documents were sent for evaluation.
8019
+ # Corresponds to the JSON property `inputDocumentsCount`
8020
+ # @return [Fixnum]
8021
+ attr_accessor :input_documents_count
8022
+
8023
+ # How many documents were not included in the evaluation as they didn't pass
8024
+ # validation.
8025
+ # Corresponds to the JSON property `invalidDocumentsCount`
8026
+ # @return [Fixnum]
8027
+ attr_accessor :invalid_documents_count
8028
+
8029
+ def initialize(**args)
8030
+ update!(**args)
8031
+ end
8032
+
8033
+ # Update properties of this object
8034
+ def update!(**args)
8035
+ @evaluated_documents_count = args[:evaluated_documents_count] if args.key?(:evaluated_documents_count)
8036
+ @failed_documents_count = args[:failed_documents_count] if args.key?(:failed_documents_count)
8037
+ @input_documents_count = args[:input_documents_count] if args.key?(:input_documents_count)
8038
+ @invalid_documents_count = args[:invalid_documents_count] if args.key?(:invalid_documents_count)
8039
+ end
8040
+ end
8041
+
8042
+ # Evaluation metrics, either in aggregate or about a specific entity.
8043
+ class GoogleCloudDocumentaiV1beta3EvaluationMetrics
8044
+ include Google::Apis::Core::Hashable
8045
+
8046
+ # The calculated f1 score.
8047
+ # Corresponds to the JSON property `f1Score`
8048
+ # @return [Float]
8049
+ attr_accessor :f1_score
8050
+
8051
+ # The amount of false negatives.
8052
+ # Corresponds to the JSON property `falseNegativesCount`
8053
+ # @return [Fixnum]
8054
+ attr_accessor :false_negatives_count
8055
+
8056
+ # The amount of false positives.
8057
+ # Corresponds to the JSON property `falsePositivesCount`
8058
+ # @return [Fixnum]
8059
+ attr_accessor :false_positives_count
8060
+
8061
+ # The amount of documents with a ground truth occurrence.
8062
+ # Corresponds to the JSON property `groundTruthDocumentCount`
8063
+ # @return [Fixnum]
8064
+ attr_accessor :ground_truth_document_count
8065
+
8066
+ # The amount of occurrences in ground truth documents.
8067
+ # Corresponds to the JSON property `groundTruthOccurrencesCount`
8068
+ # @return [Fixnum]
8069
+ attr_accessor :ground_truth_occurrences_count
8070
+
8071
+ # The calculated precision.
8072
+ # Corresponds to the JSON property `precision`
8073
+ # @return [Float]
8074
+ attr_accessor :precision
8075
+
8076
+ # The amount of documents with a predicted occurrence.
8077
+ # Corresponds to the JSON property `predictedDocumentCount`
8078
+ # @return [Fixnum]
8079
+ attr_accessor :predicted_document_count
8080
+
8081
+ # The amount of occurrences in predicted documents.
8082
+ # Corresponds to the JSON property `predictedOccurrencesCount`
8083
+ # @return [Fixnum]
8084
+ attr_accessor :predicted_occurrences_count
8085
+
8086
+ # The calculated recall.
8087
+ # Corresponds to the JSON property `recall`
8088
+ # @return [Float]
8089
+ attr_accessor :recall
8090
+
8091
+ # The amount of documents that had an occurrence of this label.
8092
+ # Corresponds to the JSON property `totalDocumentsCount`
8093
+ # @return [Fixnum]
8094
+ attr_accessor :total_documents_count
8095
+
8096
+ # The amount of true positives.
8097
+ # Corresponds to the JSON property `truePositivesCount`
8098
+ # @return [Fixnum]
8099
+ attr_accessor :true_positives_count
8100
+
8101
+ def initialize(**args)
8102
+ update!(**args)
8103
+ end
8104
+
8105
+ # Update properties of this object
8106
+ def update!(**args)
8107
+ @f1_score = args[:f1_score] if args.key?(:f1_score)
8108
+ @false_negatives_count = args[:false_negatives_count] if args.key?(:false_negatives_count)
8109
+ @false_positives_count = args[:false_positives_count] if args.key?(:false_positives_count)
8110
+ @ground_truth_document_count = args[:ground_truth_document_count] if args.key?(:ground_truth_document_count)
8111
+ @ground_truth_occurrences_count = args[:ground_truth_occurrences_count] if args.key?(:ground_truth_occurrences_count)
8112
+ @precision = args[:precision] if args.key?(:precision)
8113
+ @predicted_document_count = args[:predicted_document_count] if args.key?(:predicted_document_count)
8114
+ @predicted_occurrences_count = args[:predicted_occurrences_count] if args.key?(:predicted_occurrences_count)
8115
+ @recall = args[:recall] if args.key?(:recall)
8116
+ @total_documents_count = args[:total_documents_count] if args.key?(:total_documents_count)
8117
+ @true_positives_count = args[:true_positives_count] if args.key?(:true_positives_count)
8118
+ end
8119
+ end
8120
+
8121
+ # Metrics across multiple confidence levels.
8122
+ class GoogleCloudDocumentaiV1beta3EvaluationMultiConfidenceMetrics
8123
+ include Google::Apis::Core::Hashable
8124
+
8125
+ # The calculated area under the precision recall curve (AUPRC), computed by
8126
+ # integrating over all confidence thresholds.
8127
+ # Corresponds to the JSON property `auprc`
8128
+ # @return [Float]
8129
+ attr_accessor :auprc
8130
+
8131
+ # The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only.
8132
+ # Corresponds to the JSON property `auprcExact`
8133
+ # @return [Float]
8134
+ attr_accessor :auprc_exact
8135
+
8136
+ # Metrics across confidence levels with fuzzy matching enabled.
8137
+ # Corresponds to the JSON property `confidenceLevelMetrics`
8138
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EvaluationConfidenceLevelMetrics>]
8139
+ attr_accessor :confidence_level_metrics
8140
+
8141
+ # Metrics across confidence levels with only exact matching.
8142
+ # Corresponds to the JSON property `confidenceLevelMetricsExact`
8143
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EvaluationConfidenceLevelMetrics>]
8144
+ attr_accessor :confidence_level_metrics_exact
8145
+
8146
+ # The Estimated Calibration Error (ECE) of the confidence of the predicted
8147
+ # entities.
8148
+ # Corresponds to the JSON property `estimatedCalibrationError`
8149
+ # @return [Float]
8150
+ attr_accessor :estimated_calibration_error
8151
+
8152
+ # The ECE for the predicted entities with fuzzy matching disabled, i.e., exact
8153
+ # matching only.
8154
+ # Corresponds to the JSON property `estimatedCalibrationErrorExact`
8155
+ # @return [Float]
8156
+ attr_accessor :estimated_calibration_error_exact
8157
+
8158
+ # The metrics type for the label.
8159
+ # Corresponds to the JSON property `metricsType`
8160
+ # @return [String]
8161
+ attr_accessor :metrics_type
7649
8162
 
7650
8163
  def initialize(**args)
7651
8164
  update!(**args)
@@ -7653,9 +8166,13 @@ module Google
7653
8166
 
7654
8167
  # Update properties of this object
7655
8168
  def update!(**args)
7656
- @human_review_labeling_metadata = args[:human_review_labeling_metadata] if args.key?(:human_review_labeling_metadata)
7657
- @human_review_metadata = args[:human_review_metadata] if args.key?(:human_review_metadata)
7658
- @inactive = args[:inactive] if args.key?(:inactive)
8169
+ @auprc = args[:auprc] if args.key?(:auprc)
8170
+ @auprc_exact = args[:auprc_exact] if args.key?(:auprc_exact)
8171
+ @confidence_level_metrics = args[:confidence_level_metrics] if args.key?(:confidence_level_metrics)
8172
+ @confidence_level_metrics_exact = args[:confidence_level_metrics_exact] if args.key?(:confidence_level_metrics_exact)
8173
+ @estimated_calibration_error = args[:estimated_calibration_error] if args.key?(:estimated_calibration_error)
8174
+ @estimated_calibration_error_exact = args[:estimated_calibration_error_exact] if args.key?(:estimated_calibration_error_exact)
8175
+ @metrics_type = args[:metrics_type] if args.key?(:metrics_type)
7659
8176
  end
7660
8177
  end
7661
8178
 
@@ -7741,26 +8258,6 @@ module Google
7741
8258
  end
7742
8259
  end
7743
8260
 
7744
- # Metadata for human review labeling config.
7745
- class GoogleCloudDocumentaiV1beta3HumanReviewLabelingMetadata
7746
- include Google::Apis::Core::Hashable
7747
-
7748
- # Whether to enable normalization editing.
7749
- # Corresponds to the JSON property `enableNormalizationEditing`
7750
- # @return [Boolean]
7751
- attr_accessor :enable_normalization_editing
7752
- alias_method :enable_normalization_editing?, :enable_normalization_editing
7753
-
7754
- def initialize(**args)
7755
- update!(**args)
7756
- end
7757
-
7758
- # Update properties of this object
7759
- def update!(**args)
7760
- @enable_normalization_editing = args[:enable_normalization_editing] if args.key?(:enable_normalization_editing)
7761
- end
7762
- end
7763
-
7764
8261
  # The status of human review on a processed document.
7765
8262
  class GoogleCloudDocumentaiV1beta3HumanReviewStatus
7766
8263
  include Google::Apis::Core::Hashable
@@ -7795,20 +8292,20 @@ module Google
7795
8292
  end
7796
8293
  end
7797
8294
 
7798
- # Metadata for Human Review config.
7799
- class GoogleCloudDocumentaiV1beta3HumanReviewValidationMetadata
8295
+ # The response from ListEvaluations.
8296
+ class GoogleCloudDocumentaiV1beta3ListEvaluationsResponse
7800
8297
  include Google::Apis::Core::Hashable
7801
8298
 
7802
- # The confidence threshold if human review validation is enabled.
7803
- # Corresponds to the JSON property `confidenceThreshold`
7804
- # @return [Float]
7805
- attr_accessor :confidence_threshold
8299
+ # The evaluations requested.
8300
+ # Corresponds to the JSON property `evaluations`
8301
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Evaluation>]
8302
+ attr_accessor :evaluations
7806
8303
 
7807
- # Whether to enable human review validation.
7808
- # Corresponds to the JSON property `enableValidation`
7809
- # @return [Boolean]
7810
- attr_accessor :enable_validation
7811
- alias_method :enable_validation?, :enable_validation
8304
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
8305
+ # field is omitted, there are no subsequent pages.
8306
+ # Corresponds to the JSON property `nextPageToken`
8307
+ # @return [String]
8308
+ attr_accessor :next_page_token
7812
8309
 
7813
8310
  def initialize(**args)
7814
8311
  update!(**args)
@@ -7816,8 +8313,8 @@ module Google
7816
8313
 
7817
8314
  # Update properties of this object
7818
8315
  def update!(**args)
7819
- @confidence_threshold = args[:confidence_threshold] if args.key?(:confidence_threshold)
7820
- @enable_validation = args[:enable_validation] if args.key?(:enable_validation)
8316
+ @evaluations = args[:evaluations] if args.key?(:evaluations)
8317
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
7821
8318
  end
7822
8319
  end
7823
8320
 
@@ -7922,6 +8419,46 @@ module Google
7922
8419
  end
7923
8420
  end
7924
8421
 
8422
+ # Config for Document OCR.
8423
+ class GoogleCloudDocumentaiV1beta3OcrConfig
8424
+ include Google::Apis::Core::Hashable
8425
+
8426
+ # Enables special handling for PDFs with existing text information. Results in
8427
+ # better text extraction quality in such PDF inputs.
8428
+ # Corresponds to the JSON property `enableNativePdfParsing`
8429
+ # @return [Boolean]
8430
+ attr_accessor :enable_native_pdf_parsing
8431
+ alias_method :enable_native_pdf_parsing?, :enable_native_pdf_parsing
8432
+
8433
+ def initialize(**args)
8434
+ update!(**args)
8435
+ end
8436
+
8437
+ # Update properties of this object
8438
+ def update!(**args)
8439
+ @enable_native_pdf_parsing = args[:enable_native_pdf_parsing] if args.key?(:enable_native_pdf_parsing)
8440
+ end
8441
+ end
8442
+
8443
+ # Options for Process API
8444
+ class GoogleCloudDocumentaiV1beta3ProcessOptions
8445
+ include Google::Apis::Core::Hashable
8446
+
8447
+ # Config for Document OCR.
8448
+ # Corresponds to the JSON property `ocrConfig`
8449
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3OcrConfig]
8450
+ attr_accessor :ocr_config
8451
+
8452
+ def initialize(**args)
8453
+ update!(**args)
8454
+ end
8455
+
8456
+ # Update properties of this object
8457
+ def update!(**args)
8458
+ @ocr_config = args[:ocr_config] if args.key?(:ocr_config)
8459
+ end
8460
+ end
8461
+
7925
8462
  # Request message for the process document method.
7926
8463
  class GoogleCloudDocumentaiV1beta3ProcessRequest
7927
8464
  include Google::Apis::Core::Hashable
@@ -7934,7 +8471,9 @@ module Google
7934
8471
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document]
7935
8472
  attr_accessor :document
7936
8473
 
7937
- # Specifies which fields to include in ProcessResponse's document.
8474
+ # Specifies which fields to include in ProcessResponse's document. Only supports
8475
+ # top level document and pages field so it must be in the form of ``
8476
+ # document_field_name`` or `pages.`page_field_name``.
7938
8477
  # Corresponds to the JSON property `fieldMask`
7939
8478
  # @return [String]
7940
8479
  attr_accessor :field_mask
@@ -7947,6 +8486,11 @@ module Google
7947
8486
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document]
7948
8487
  attr_accessor :inline_document
7949
8488
 
8489
+ # Options for Process API
8490
+ # Corresponds to the JSON property `processOptions`
8491
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessOptions]
8492
+ attr_accessor :process_options
8493
+
7950
8494
  # Payload message of raw document content (bytes).
7951
8495
  # Corresponds to the JSON property `rawDocument`
7952
8496
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3RawDocument]
@@ -7968,6 +8512,7 @@ module Google
7968
8512
  @document = args[:document] if args.key?(:document)
7969
8513
  @field_mask = args[:field_mask] if args.key?(:field_mask)
7970
8514
  @inline_document = args[:inline_document] if args.key?(:inline_document)
8515
+ @process_options = args[:process_options] if args.key?(:process_options)
7971
8516
  @raw_document = args[:raw_document] if args.key?(:raw_document)
7972
8517
  @skip_human_review = args[:skip_human_review] if args.key?(:skip_human_review)
7973
8518
  end
@@ -8053,8 +8598,8 @@ module Google
8053
8598
  # @return [String]
8054
8599
  attr_accessor :state
8055
8600
 
8056
- # The processor type, e.g., OCR_PROCESSOR, INVOICE_PROCESSOR, etc. To get a list
8057
- # of processors types, see FetchProcessorTypes.
8601
+ # The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc. To get a
8602
+ # list of processors types, see FetchProcessorTypes.
8058
8603
  # Corresponds to the JSON property `type`
8059
8604
  # @return [String]
8060
8605
  attr_accessor :type
@@ -8103,13 +8648,18 @@ module Google
8103
8648
  # @return [String]
8104
8649
  attr_accessor :launch_stage
8105
8650
 
8106
- # The resource name of the processor type. Format: projects/`project`/
8107
- # processorTypes/`processor_type`
8651
+ # The resource name of the processor type. Format: `projects/`project`/
8652
+ # processorTypes/`processor_type``
8108
8653
  # Corresponds to the JSON property `name`
8109
8654
  # @return [String]
8110
8655
  attr_accessor :name
8111
8656
 
8112
- # The type of the processor, e.g., "invoice_parsing".
8657
+ # A set of Cloud Storage URIs of sample documents for this processor.
8658
+ # Corresponds to the JSON property `sampleDocumentUris`
8659
+ # @return [Array<String>]
8660
+ attr_accessor :sample_document_uris
8661
+
8662
+ # The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc.
8113
8663
  # Corresponds to the JSON property `type`
8114
8664
  # @return [String]
8115
8665
  attr_accessor :type
@@ -8125,6 +8675,7 @@ module Google
8125
8675
  @category = args[:category] if args.key?(:category)
8126
8676
  @launch_stage = args[:launch_stage] if args.key?(:launch_stage)
8127
8677
  @name = args[:name] if args.key?(:name)
8678
+ @sample_document_uris = args[:sample_document_uris] if args.key?(:sample_document_uris)
8128
8679
  @type = args[:type] if args.key?(:type)
8129
8680
  end
8130
8681
  end
@@ -8171,6 +8722,11 @@ module Google
8171
8722
  # @return [String]
8172
8723
  attr_accessor :display_name
8173
8724
 
8725
+ # The schema defines the output of the processed document by a processor.
8726
+ # Corresponds to the JSON property `documentSchema`
8727
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentSchema]
8728
+ attr_accessor :document_schema
8729
+
8174
8730
  # Denotes that this ProcessorVersion is managed by google.
8175
8731
  # Corresponds to the JSON property `googleManaged`
8176
8732
  # @return [Boolean]
@@ -8208,6 +8764,7 @@ module Google
8208
8764
  @create_time = args[:create_time] if args.key?(:create_time)
8209
8765
  @deprecation_info = args[:deprecation_info] if args.key?(:deprecation_info)
8210
8766
  @display_name = args[:display_name] if args.key?(:display_name)
8767
+ @document_schema = args[:document_schema] if args.key?(:document_schema)
8211
8768
  @google_managed = args[:google_managed] if args.key?(:google_managed)
8212
8769
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
8213
8770
  @kms_key_version_name = args[:kms_key_version_name] if args.key?(:kms_key_version_name)
@@ -8241,38 +8798,6 @@ module Google
8241
8798
  end
8242
8799
  end
8243
8800
 
8244
- # Metadata about a property.
8245
- class GoogleCloudDocumentaiV1beta3PropertyMetadata
8246
- include Google::Apis::Core::Hashable
8247
-
8248
- # Metadata for human review labeling config.
8249
- # Corresponds to the JSON property `humanReviewLabelingMetadata`
8250
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3HumanReviewLabelingMetadata]
8251
- attr_accessor :human_review_labeling_metadata
8252
-
8253
- # Metadata for Human Review config.
8254
- # Corresponds to the JSON property `humanReviewMetadata`
8255
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3HumanReviewValidationMetadata]
8256
- attr_accessor :human_review_metadata
8257
-
8258
- # Whether the property should be considered as "inactive".
8259
- # Corresponds to the JSON property `inactive`
8260
- # @return [Boolean]
8261
- attr_accessor :inactive
8262
- alias_method :inactive?, :inactive
8263
-
8264
- def initialize(**args)
8265
- update!(**args)
8266
- end
8267
-
8268
- # Update properties of this object
8269
- def update!(**args)
8270
- @human_review_labeling_metadata = args[:human_review_labeling_metadata] if args.key?(:human_review_labeling_metadata)
8271
- @human_review_metadata = args[:human_review_metadata] if args.key?(:human_review_metadata)
8272
- @inactive = args[:inactive] if args.key?(:inactive)
8273
- end
8274
- end
8275
-
8276
8801
  # Payload message of raw document content (bytes).
8277
8802
  class GoogleCloudDocumentaiV1beta3RawDocument
8278
8803
  include Google::Apis::Core::Hashable
@@ -8283,7 +8808,7 @@ module Google
8283
8808
  # @return [String]
8284
8809
  attr_accessor :content
8285
8810
 
8286
- # An IANA MIME type (RFC6838) indicating the nature and format of the [content].
8811
+ # An IANA MIME type (RFC6838) indicating the nature and format of the content.
8287
8812
  # Corresponds to the JSON property `mimeType`
8288
8813
  # @return [String]
8289
8814
  attr_accessor :mime_type
@@ -8484,6 +9009,167 @@ module Google
8484
9009
  end
8485
9010
  end
8486
9011
 
9012
+ # The metadata that represents a processor version being created.
9013
+ class GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata
9014
+ include Google::Apis::Core::Hashable
9015
+
9016
+ # The common metadata for long running operations.
9017
+ # Corresponds to the JSON property `commonMetadata`
9018
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
9019
+ attr_accessor :common_metadata
9020
+
9021
+ # The dataset validation information. This includes any and all errors with
9022
+ # documents and the dataset.
9023
+ # Corresponds to the JSON property `testDatasetValidation`
9024
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation]
9025
+ attr_accessor :test_dataset_validation
9026
+
9027
+ # The dataset validation information. This includes any and all errors with
9028
+ # documents and the dataset.
9029
+ # Corresponds to the JSON property `trainingDatasetValidation`
9030
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation]
9031
+ attr_accessor :training_dataset_validation
9032
+
9033
+ def initialize(**args)
9034
+ update!(**args)
9035
+ end
9036
+
9037
+ # Update properties of this object
9038
+ def update!(**args)
9039
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
9040
+ @test_dataset_validation = args[:test_dataset_validation] if args.key?(:test_dataset_validation)
9041
+ @training_dataset_validation = args[:training_dataset_validation] if args.key?(:training_dataset_validation)
9042
+ end
9043
+ end
9044
+
9045
+ # The dataset validation information. This includes any and all errors with
9046
+ # documents and the dataset.
9047
+ class GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation
9048
+ include Google::Apis::Core::Hashable
9049
+
9050
+ # The total number of dataset errors.
9051
+ # Corresponds to the JSON property `datasetErrorCount`
9052
+ # @return [Fixnum]
9053
+ attr_accessor :dataset_error_count
9054
+
9055
+ # Error information for the dataset as a whole. A maximum of 10 dataset errors
9056
+ # will be returned. A single dataset error is terminal for training.
9057
+ # Corresponds to the JSON property `datasetErrors`
9058
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleRpcStatus>]
9059
+ attr_accessor :dataset_errors
9060
+
9061
+ # The total number of document errors.
9062
+ # Corresponds to the JSON property `documentErrorCount`
9063
+ # @return [Fixnum]
9064
+ attr_accessor :document_error_count
9065
+
9066
+ # Error information pertaining to specific documents. A maximum of 10 document
9067
+ # errors will be returned. Any document with errors will not be used throughout
9068
+ # training.
9069
+ # Corresponds to the JSON property `documentErrors`
9070
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleRpcStatus>]
9071
+ attr_accessor :document_errors
9072
+
9073
+ def initialize(**args)
9074
+ update!(**args)
9075
+ end
9076
+
9077
+ # Update properties of this object
9078
+ def update!(**args)
9079
+ @dataset_error_count = args[:dataset_error_count] if args.key?(:dataset_error_count)
9080
+ @dataset_errors = args[:dataset_errors] if args.key?(:dataset_errors)
9081
+ @document_error_count = args[:document_error_count] if args.key?(:document_error_count)
9082
+ @document_errors = args[:document_errors] if args.key?(:document_errors)
9083
+ end
9084
+ end
9085
+
9086
+ # Request message for the create processor version method.
9087
+ class GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequest
9088
+ include Google::Apis::Core::Hashable
9089
+
9090
+ # Optional. The processor version to use as a base for training. This processor
9091
+ # version must be a child of `parent`. Format: `projects/`project`/locations/`
9092
+ # location`/processors/`processor`/processorVersions/`processorVersion``.
9093
+ # Corresponds to the JSON property `baseProcessorVersion`
9094
+ # @return [String]
9095
+ attr_accessor :base_processor_version
9096
+
9097
+ # The schema defines the output of the processed document by a processor.
9098
+ # Corresponds to the JSON property `documentSchema`
9099
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentSchema]
9100
+ attr_accessor :document_schema
9101
+
9102
+ # The input data used to train a new `ProcessorVersion`.
9103
+ # Corresponds to the JSON property `inputData`
9104
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestInputData]
9105
+ attr_accessor :input_data
9106
+
9107
+ # A processor version is an implementation of a processor. Each processor can
9108
+ # have multiple versions, pre-trained by Google internally or up-trained by the
9109
+ # customer. At a time, a processor can only have one default version version. So
9110
+ # the processor's behavior (when processing documents) is defined by a default
9111
+ # version
9112
+ # Corresponds to the JSON property `processorVersion`
9113
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessorVersion]
9114
+ attr_accessor :processor_version
9115
+
9116
+ def initialize(**args)
9117
+ update!(**args)
9118
+ end
9119
+
9120
+ # Update properties of this object
9121
+ def update!(**args)
9122
+ @base_processor_version = args[:base_processor_version] if args.key?(:base_processor_version)
9123
+ @document_schema = args[:document_schema] if args.key?(:document_schema)
9124
+ @input_data = args[:input_data] if args.key?(:input_data)
9125
+ @processor_version = args[:processor_version] if args.key?(:processor_version)
9126
+ end
9127
+ end
9128
+
9129
+ # The input data used to train a new `ProcessorVersion`.
9130
+ class GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestInputData
9131
+ include Google::Apis::Core::Hashable
9132
+
9133
+ # The common config to specify a set of documents used as input.
9134
+ # Corresponds to the JSON property `testDocuments`
9135
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig]
9136
+ attr_accessor :test_documents
9137
+
9138
+ # The common config to specify a set of documents used as input.
9139
+ # Corresponds to the JSON property `trainingDocuments`
9140
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig]
9141
+ attr_accessor :training_documents
9142
+
9143
+ def initialize(**args)
9144
+ update!(**args)
9145
+ end
9146
+
9147
+ # Update properties of this object
9148
+ def update!(**args)
9149
+ @test_documents = args[:test_documents] if args.key?(:test_documents)
9150
+ @training_documents = args[:training_documents] if args.key?(:training_documents)
9151
+ end
9152
+ end
9153
+
9154
+ # The response for the TrainProcessorVersion method.
9155
+ class GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse
9156
+ include Google::Apis::Core::Hashable
9157
+
9158
+ # The resource name of the processor version produced by training.
9159
+ # Corresponds to the JSON property `processorVersion`
9160
+ # @return [String]
9161
+ attr_accessor :processor_version
9162
+
9163
+ def initialize(**args)
9164
+ update!(**args)
9165
+ end
9166
+
9167
+ # Update properties of this object
9168
+ def update!(**args)
9169
+ @processor_version = args[:processor_version] if args.key?(:processor_version)
9170
+ end
9171
+ end
9172
+
8487
9173
  # The long running operation metadata for the undeploy processor version method.
8488
9174
  class GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata
8489
9175
  include Google::Apis::Core::Hashable