google-apis-documentai_v1beta3 0.58.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.
@@ -2188,7 +2190,7 @@ module Google
2188
2190
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1BoundingPoly]
2189
2191
  attr_accessor :bounding_poly
2190
2192
 
2191
- # Optional. Confidence of detected page element, if applicable. Range [0, 1].
2193
+ # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
2192
2194
  # Corresponds to the JSON property `confidence`
2193
2195
  # @return [Float]
2194
2196
  attr_accessor :confidence
@@ -2203,10 +2205,10 @@ module Google
2203
2205
  # @return [String]
2204
2206
  attr_accessor :layout_type
2205
2207
 
2206
- # Required. Index into the Document.pages element, for example using Document.
2207
- # pages to locate the related page element. This field is skipped when its value
2208
- # is the default 0. See https://developers.google.com/protocol-buffers/docs/
2209
- # 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.
2210
2212
  # Corresponds to the JSON property `page`
2211
2213
  # @return [Fixnum]
2212
2214
  attr_accessor :page
@@ -2287,12 +2289,12 @@ module Google
2287
2289
  class GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage
2288
2290
  include Google::Apis::Core::Hashable
2289
2291
 
2290
- # Confidence of detected language. Range [0, 1].
2292
+ # Confidence of detected language. Range `[0, 1]`.
2291
2293
  # Corresponds to the JSON property `confidence`
2292
2294
  # @return [Float]
2293
2295
  attr_accessor :confidence
2294
2296
 
2295
- # 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,
2296
2298
  # see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
2297
2299
  # Corresponds to the JSON property `languageCode`
2298
2300
  # @return [String]
@@ -2385,8 +2387,8 @@ module Google
2385
2387
  attr_accessor :value_detected_languages
2386
2388
 
2387
2389
  # If the value is non-textual, this field represents the type. Current valid
2388
- # values are: - blank (this indicates the field_value is normal text) - "
2389
- # unfilled_checkbox" - "filled_checkbox"
2390
+ # values are: - blank (this indicates the `field_value` is normal text) - `
2391
+ # unfilled_checkbox` - `filled_checkbox`
2390
2392
  # Corresponds to the JSON property `valueType`
2391
2393
  # @return [String]
2392
2394
  attr_accessor :value_type
@@ -2455,7 +2457,7 @@ module Google
2455
2457
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect>]
2456
2458
  attr_accessor :detected_defects
2457
2459
 
2458
- # The overall quality score. Range [0, 1] where 1 is perfect quality.
2460
+ # The overall quality score. Range `[0, 1]` where 1 is perfect quality.
2459
2461
  # Corresponds to the JSON property `qualityScore`
2460
2462
  # @return [Float]
2461
2463
  attr_accessor :quality_score
@@ -2475,16 +2477,16 @@ module Google
2475
2477
  class GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect
2476
2478
  include Google::Apis::Core::Hashable
2477
2479
 
2478
- # Confidence of detected defect. Range [0, 1] where 1 indicates strong
2480
+ # Confidence of detected defect. Range `[0, 1]` where 1 indicates strong
2479
2481
  # confidence of that the defect exists.
2480
2482
  # Corresponds to the JSON property `confidence`
2481
2483
  # @return [Float]
2482
2484
  attr_accessor :confidence
2483
2485
 
2484
- # Name of the defect type. Supported values are "quality/defect_blurry", "
2485
- # quality/defect_noisy", "quality/defect_dark", "quality/defect_faint", "quality/
2486
- # defect_text_too_small", "quality/defect_document_cutoff", "quality/
2487
- # defect_text_cutoff", "quality/defect_glare"
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`
2488
2490
  # Corresponds to the JSON property `type`
2489
2491
  # @return [String]
2490
2492
  attr_accessor :type
@@ -2511,7 +2513,7 @@ module Google
2511
2513
 
2512
2514
  # Confidence of the current Layout within context of the object this layout is
2513
2515
  # for. e.g. confidence can be for a single token, a table, a visual element, etc.
2514
- # depending on context. Range [0, 1].
2516
+ # depending on context. Range `[0, 1]`.
2515
2517
  # Corresponds to the JSON property `confidence`
2516
2518
  # @return [Float]
2517
2519
  attr_accessor :confidence
@@ -2695,6 +2697,12 @@ module Google
2695
2697
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentPageLayout]
2696
2698
  attr_accessor :layout
2697
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
+
2698
2706
  def initialize(**args)
2699
2707
  update!(**args)
2700
2708
  end
@@ -2705,6 +2713,7 @@ module Google
2705
2713
  @detected_languages = args[:detected_languages] if args.key?(:detected_languages)
2706
2714
  @header_rows = args[:header_rows] if args.key?(:header_rows)
2707
2715
  @layout = args[:layout] if args.key?(:layout)
2716
+ @provenance = args[:provenance] if args.key?(:provenance)
2708
2717
  end
2709
2718
  end
2710
2719
 
@@ -3145,7 +3154,7 @@ module Google
3145
3154
  # @return [Google::Apis::DocumentaiV1beta3::GoogleTypeColor]
3146
3155
  attr_accessor :color
3147
3156
 
3148
- # 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/
3149
3158
  # cssref/pr_font_font-family.asp
3150
3159
  # Corresponds to the JSON property `fontFamily`
3151
3160
  # @return [String]
@@ -3522,26 +3531,28 @@ module Google
3522
3531
  class GoogleCloudDocumentaiV1beta2Barcode
3523
3532
  include Google::Apis::Core::Hashable
3524
3533
 
3525
- # Format of a barcode. The supported formats are: CODE_128: Code 128 type.
3526
- # CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type.
3527
- # DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8:
3528
- # EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type.
3529
- # 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.
3530
3540
  # Corresponds to the JSON property `format`
3531
3541
  # @return [String]
3532
3542
  attr_accessor :format
3533
3543
 
3534
- # Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://
3535
- # www.google.com;;'.
3544
+ # Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https:/
3545
+ # /www.google.com;;'`.
3536
3546
  # Corresponds to the JSON property `rawValue`
3537
3547
  # @return [String]
3538
3548
  attr_accessor :raw_value
3539
3549
 
3540
3550
  # Value format describes the format of the value that a barcode encodes. The
3541
- # supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address.
3542
- # ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS
3543
- # message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-
3544
- # 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.
3545
3556
  # Corresponds to the JSON property `valueFormat`
3546
3557
  # @return [String]
3547
3558
  attr_accessor :value_format
@@ -3672,14 +3683,14 @@ module Google
3672
3683
  # @return [String]
3673
3684
  attr_accessor :text
3674
3685
 
3675
- # Placeholder. A list of text corrections made to [Document.text]. This is
3676
- # usually used for annotating corrections to OCR mistakes. Text changes for a
3677
- # 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.
3678
3689
  # Corresponds to the JSON property `textChanges`
3679
3690
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentTextChange>]
3680
3691
  attr_accessor :text_changes
3681
3692
 
3682
- # Placeholder. Styles for the Document.text.
3693
+ # Styles for the Document.text.
3683
3694
  # Corresponds to the JSON property `textStyles`
3684
3695
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentStyle>]
3685
3696
  attr_accessor :text_styles
@@ -3720,7 +3731,7 @@ module Google
3720
3731
  class GoogleCloudDocumentaiV1beta2DocumentEntity
3721
3732
  include Google::Apis::Core::Hashable
3722
3733
 
3723
- # Optional. Confidence of detected Schema entity. Range [0, 1].
3734
+ # Optional. Confidence of detected Schema entity. Range `[0, 1]`.
3724
3735
  # Corresponds to the JSON property `confidence`
3725
3736
  # @return [Float]
3726
3737
  attr_accessor :confidence
@@ -3873,8 +3884,8 @@ module Google
3873
3884
  # Optional. An optional field to store a normalized string. For some entity
3874
3885
  # types, one of respective `structured_value` fields may also be populated. Also
3875
3886
  # not all the types of `structured_value` will be normalized. For example, some
3876
- # processors may not generate float or int normalized text by default. Below are
3877
- # 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 (`
3878
3889
  # money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in
3879
3890
  # the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO
3880
3891
  # 8601 text format.
@@ -4120,7 +4131,7 @@ module Google
4120
4131
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2BoundingPoly]
4121
4132
  attr_accessor :bounding_poly
4122
4133
 
4123
- # Optional. Confidence of detected page element, if applicable. Range [0, 1].
4134
+ # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
4124
4135
  # Corresponds to the JSON property `confidence`
4125
4136
  # @return [Float]
4126
4137
  attr_accessor :confidence
@@ -4135,10 +4146,10 @@ module Google
4135
4146
  # @return [String]
4136
4147
  attr_accessor :layout_type
4137
4148
 
4138
- # Required. Index into the Document.pages element, for example using Document.
4139
- # pages to locate the related page element. This field is skipped when its value
4140
- # is the default 0. See https://developers.google.com/protocol-buffers/docs/
4141
- # 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.
4142
4153
  # Corresponds to the JSON property `page`
4143
4154
  # @return [Fixnum]
4144
4155
  attr_accessor :page
@@ -4219,12 +4230,12 @@ module Google
4219
4230
  class GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage
4220
4231
  include Google::Apis::Core::Hashable
4221
4232
 
4222
- # Confidence of detected language. Range [0, 1].
4233
+ # Confidence of detected language. Range `[0, 1]`.
4223
4234
  # Corresponds to the JSON property `confidence`
4224
4235
  # @return [Float]
4225
4236
  attr_accessor :confidence
4226
4237
 
4227
- # 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,
4228
4239
  # see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
4229
4240
  # Corresponds to the JSON property `languageCode`
4230
4241
  # @return [String]
@@ -4317,8 +4328,8 @@ module Google
4317
4328
  attr_accessor :value_detected_languages
4318
4329
 
4319
4330
  # If the value is non-textual, this field represents the type. Current valid
4320
- # values are: - blank (this indicates the field_value is normal text) - "
4321
- # unfilled_checkbox" - "filled_checkbox"
4331
+ # values are: - blank (this indicates the `field_value` is normal text) - `
4332
+ # unfilled_checkbox` - `filled_checkbox`
4322
4333
  # Corresponds to the JSON property `valueType`
4323
4334
  # @return [String]
4324
4335
  attr_accessor :value_type
@@ -4387,7 +4398,7 @@ module Google
4387
4398
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect>]
4388
4399
  attr_accessor :detected_defects
4389
4400
 
4390
- # The overall quality score. Range [0, 1] where 1 is perfect quality.
4401
+ # The overall quality score. Range `[0, 1]` where 1 is perfect quality.
4391
4402
  # Corresponds to the JSON property `qualityScore`
4392
4403
  # @return [Float]
4393
4404
  attr_accessor :quality_score
@@ -4407,16 +4418,16 @@ module Google
4407
4418
  class GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect
4408
4419
  include Google::Apis::Core::Hashable
4409
4420
 
4410
- # Confidence of detected defect. Range [0, 1] where 1 indicates strong
4421
+ # Confidence of detected defect. Range `[0, 1]` where 1 indicates strong
4411
4422
  # confidence of that the defect exists.
4412
4423
  # Corresponds to the JSON property `confidence`
4413
4424
  # @return [Float]
4414
4425
  attr_accessor :confidence
4415
4426
 
4416
- # Name of the defect type. Supported values are "quality/defect_blurry", "
4417
- # quality/defect_noisy", "quality/defect_dark", "quality/defect_faint", "quality/
4418
- # defect_text_too_small", "quality/defect_document_cutoff", "quality/
4419
- # defect_text_cutoff", "quality/defect_glare"
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`
4420
4431
  # Corresponds to the JSON property `type`
4421
4432
  # @return [String]
4422
4433
  attr_accessor :type
@@ -4443,7 +4454,7 @@ module Google
4443
4454
 
4444
4455
  # Confidence of the current Layout within context of the object this layout is
4445
4456
  # for. e.g. confidence can be for a single token, a table, a visual element, etc.
4446
- # depending on context. Range [0, 1].
4457
+ # depending on context. Range `[0, 1]`.
4447
4458
  # Corresponds to the JSON property `confidence`
4448
4459
  # @return [Float]
4449
4460
  attr_accessor :confidence
@@ -4627,6 +4638,12 @@ module Google
4627
4638
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentPageLayout]
4628
4639
  attr_accessor :layout
4629
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
+
4630
4647
  def initialize(**args)
4631
4648
  update!(**args)
4632
4649
  end
@@ -4637,6 +4654,7 @@ module Google
4637
4654
  @detected_languages = args[:detected_languages] if args.key?(:detected_languages)
4638
4655
  @header_rows = args[:header_rows] if args.key?(:header_rows)
4639
4656
  @layout = args[:layout] if args.key?(:layout)
4657
+ @provenance = args[:provenance] if args.key?(:provenance)
4640
4658
  end
4641
4659
  end
4642
4660
 
@@ -5077,7 +5095,7 @@ module Google
5077
5095
  # @return [Google::Apis::DocumentaiV1beta3::GoogleTypeColor]
5078
5096
  attr_accessor :color
5079
5097
 
5080
- # 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/
5081
5099
  # cssref/pr_font_font-family.asp
5082
5100
  # Corresponds to the JSON property `fontFamily`
5083
5101
  # @return [String]
@@ -5464,26 +5482,28 @@ module Google
5464
5482
  class GoogleCloudDocumentaiV1beta3Barcode
5465
5483
  include Google::Apis::Core::Hashable
5466
5484
 
5467
- # Format of a barcode. The supported formats are: CODE_128: Code 128 type.
5468
- # CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type.
5469
- # DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8:
5470
- # EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type.
5471
- # 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.
5472
5491
  # Corresponds to the JSON property `format`
5473
5492
  # @return [String]
5474
5493
  attr_accessor :format
5475
5494
 
5476
- # Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://
5477
- # www.google.com;;'.
5495
+ # Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https:/
5496
+ # /www.google.com;;'`.
5478
5497
  # Corresponds to the JSON property `rawValue`
5479
5498
  # @return [String]
5480
5499
  attr_accessor :raw_value
5481
5500
 
5482
5501
  # Value format describes the format of the value that a barcode encodes. The
5483
- # supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address.
5484
- # ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS
5485
- # message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-
5486
- # 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.
5487
5507
  # Corresponds to the JSON property `valueFormat`
5488
5508
  # @return [String]
5489
5509
  attr_accessor :value_format
@@ -5649,6 +5669,11 @@ module Google
5649
5669
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig]
5650
5670
  attr_accessor :output_config
5651
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
+
5652
5677
  # Whether Human Review feature should be skipped for this request. Default to
5653
5678
  # false.
5654
5679
  # Corresponds to the JSON property `skipHumanReview`
@@ -5666,6 +5691,7 @@ module Google
5666
5691
  @input_configs = args[:input_configs] if args.key?(:input_configs)
5667
5692
  @input_documents = args[:input_documents] if args.key?(:input_documents)
5668
5693
  @output_config = args[:output_config] if args.key?(:output_config)
5694
+ @process_options = args[:process_options] if args.key?(:process_options)
5669
5695
  @skip_human_review = args[:skip_human_review] if args.key?(:skip_human_review)
5670
5696
  end
5671
5697
  end
@@ -5990,14 +6016,14 @@ module Google
5990
6016
  # @return [String]
5991
6017
  attr_accessor :text
5992
6018
 
5993
- # Placeholder. A list of text corrections made to [Document.text]. This is
5994
- # usually used for annotating corrections to OCR mistakes. Text changes for a
5995
- # 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.
5996
6022
  # Corresponds to the JSON property `textChanges`
5997
6023
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentTextChange>]
5998
6024
  attr_accessor :text_changes
5999
6025
 
6000
- # Placeholder. Styles for the Document.text.
6026
+ # Styles for the Document.text.
6001
6027
  # Corresponds to the JSON property `textStyles`
6002
6028
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentStyle>]
6003
6029
  attr_accessor :text_styles
@@ -6037,7 +6063,7 @@ module Google
6037
6063
  class GoogleCloudDocumentaiV1beta3DocumentEntity
6038
6064
  include Google::Apis::Core::Hashable
6039
6065
 
6040
- # Optional. Confidence of detected Schema entity. Range [0, 1].
6066
+ # Optional. Confidence of detected Schema entity. Range `[0, 1]`.
6041
6067
  # Corresponds to the JSON property `confidence`
6042
6068
  # @return [Float]
6043
6069
  attr_accessor :confidence
@@ -6190,8 +6216,8 @@ module Google
6190
6216
  # Optional. An optional field to store a normalized string. For some entity
6191
6217
  # types, one of respective `structured_value` fields may also be populated. Also
6192
6218
  # not all the types of `structured_value` will be normalized. For example, some
6193
- # processors may not generate float or int normalized text by default. Below are
6194
- # 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 (`
6195
6221
  # money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in
6196
6222
  # the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO
6197
6223
  # 8601 text format.
@@ -6271,7 +6297,9 @@ module Google
6271
6297
  class GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfig
6272
6298
  include Google::Apis::Core::Hashable
6273
6299
 
6274
- # 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``.
6275
6303
  # Corresponds to the JSON property `fieldMask`
6276
6304
  # @return [String]
6277
6305
  attr_accessor :field_mask
@@ -6281,6 +6309,11 @@ module Google
6281
6309
  # @return [String]
6282
6310
  attr_accessor :gcs_uri
6283
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
+
6284
6317
  def initialize(**args)
6285
6318
  update!(**args)
6286
6319
  end
@@ -6289,6 +6322,32 @@ module Google
6289
6322
  def update!(**args)
6290
6323
  @field_mask = args[:field_mask] if args.key?(:field_mask)
6291
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)
6292
6351
  end
6293
6352
  end
6294
6353
 
@@ -6445,7 +6504,7 @@ module Google
6445
6504
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BoundingPoly]
6446
6505
  attr_accessor :bounding_poly
6447
6506
 
6448
- # Optional. Confidence of detected page element, if applicable. Range [0, 1].
6507
+ # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
6449
6508
  # Corresponds to the JSON property `confidence`
6450
6509
  # @return [Float]
6451
6510
  attr_accessor :confidence
@@ -6460,10 +6519,10 @@ module Google
6460
6519
  # @return [String]
6461
6520
  attr_accessor :layout_type
6462
6521
 
6463
- # Required. Index into the Document.pages element, for example using Document.
6464
- # pages to locate the related page element. This field is skipped when its value
6465
- # is the default 0. See https://developers.google.com/protocol-buffers/docs/
6466
- # 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.
6467
6526
  # Corresponds to the JSON property `page`
6468
6527
  # @return [Fixnum]
6469
6528
  attr_accessor :page
@@ -6544,12 +6603,12 @@ module Google
6544
6603
  class GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage
6545
6604
  include Google::Apis::Core::Hashable
6546
6605
 
6547
- # Confidence of detected language. Range [0, 1].
6606
+ # Confidence of detected language. Range `[0, 1]`.
6548
6607
  # Corresponds to the JSON property `confidence`
6549
6608
  # @return [Float]
6550
6609
  attr_accessor :confidence
6551
6610
 
6552
- # 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,
6553
6612
  # see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
6554
6613
  # Corresponds to the JSON property `languageCode`
6555
6614
  # @return [String]
@@ -6642,8 +6701,8 @@ module Google
6642
6701
  attr_accessor :value_detected_languages
6643
6702
 
6644
6703
  # If the value is non-textual, this field represents the type. Current valid
6645
- # values are: - blank (this indicates the field_value is normal text) - "
6646
- # unfilled_checkbox" - "filled_checkbox"
6704
+ # values are: - blank (this indicates the `field_value` is normal text) - `
6705
+ # unfilled_checkbox` - `filled_checkbox`
6647
6706
  # Corresponds to the JSON property `valueType`
6648
6707
  # @return [String]
6649
6708
  attr_accessor :value_type
@@ -6712,7 +6771,7 @@ module Google
6712
6771
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScoresDetectedDefect>]
6713
6772
  attr_accessor :detected_defects
6714
6773
 
6715
- # The overall quality score. Range [0, 1] where 1 is perfect quality.
6774
+ # The overall quality score. Range `[0, 1]` where 1 is perfect quality.
6716
6775
  # Corresponds to the JSON property `qualityScore`
6717
6776
  # @return [Float]
6718
6777
  attr_accessor :quality_score
@@ -6732,16 +6791,16 @@ module Google
6732
6791
  class GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScoresDetectedDefect
6733
6792
  include Google::Apis::Core::Hashable
6734
6793
 
6735
- # Confidence of detected defect. Range [0, 1] where 1 indicates strong
6794
+ # Confidence of detected defect. Range `[0, 1]` where 1 indicates strong
6736
6795
  # confidence of that the defect exists.
6737
6796
  # Corresponds to the JSON property `confidence`
6738
6797
  # @return [Float]
6739
6798
  attr_accessor :confidence
6740
6799
 
6741
- # Name of the defect type. Supported values are "quality/defect_blurry", "
6742
- # quality/defect_noisy", "quality/defect_dark", "quality/defect_faint", "quality/
6743
- # defect_text_too_small", "quality/defect_document_cutoff", "quality/
6744
- # defect_text_cutoff", "quality/defect_glare"
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`
6745
6804
  # Corresponds to the JSON property `type`
6746
6805
  # @return [String]
6747
6806
  attr_accessor :type
@@ -6768,7 +6827,7 @@ module Google
6768
6827
 
6769
6828
  # Confidence of the current Layout within context of the object this layout is
6770
6829
  # for. e.g. confidence can be for a single token, a table, a visual element, etc.
6771
- # depending on context. Range [0, 1].
6830
+ # depending on context. Range `[0, 1]`.
6772
6831
  # Corresponds to the JSON property `confidence`
6773
6832
  # @return [Float]
6774
6833
  attr_accessor :confidence
@@ -6952,6 +7011,12 @@ module Google
6952
7011
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageLayout]
6953
7012
  attr_accessor :layout
6954
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
+
6955
7020
  def initialize(**args)
6956
7021
  update!(**args)
6957
7022
  end
@@ -6962,6 +7027,7 @@ module Google
6962
7027
  @detected_languages = args[:detected_languages] if args.key?(:detected_languages)
6963
7028
  @header_rows = args[:header_rows] if args.key?(:header_rows)
6964
7029
  @layout = args[:layout] if args.key?(:layout)
7030
+ @provenance = args[:provenance] if args.key?(:provenance)
6965
7031
  end
6966
7032
  end
6967
7033
 
@@ -7320,24 +7386,19 @@ module Google
7320
7386
  # @return [String]
7321
7387
  attr_accessor :display_name
7322
7388
 
7323
- # Metadata about an entity type.
7324
- # Corresponds to the JSON property `entityTypeMetadata`
7325
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EntityTypeMetadata]
7326
- attr_accessor :entity_type_metadata
7327
-
7328
7389
  # Defines the a list of enum values.
7329
7390
  # Corresponds to the JSON property `enumValues`
7330
7391
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues]
7331
7392
  attr_accessor :enum_values
7332
7393
 
7333
7394
  # Name of the type. It must be unique within the schema file and cannot be a '
7334
- # Common Type'. Besides that we use the following naming conventions: - *use
7335
- # 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. -
7336
7397
  # Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (
7337
7398
  # For backward compatibility internal infrastructure and tooling can handle any
7338
- # ascii character) - The '/' is sometimes used to denote a property of a type.
7339
- # For example line_item/amount. This convention is deprecated, but will still be
7340
- # 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.
7341
7402
  # Corresponds to the JSON property `name`
7342
7403
  # @return [String]
7343
7404
  attr_accessor :name
@@ -7355,7 +7416,6 @@ module Google
7355
7416
  def update!(**args)
7356
7417
  @base_types = args[:base_types] if args.key?(:base_types)
7357
7418
  @display_name = args[:display_name] if args.key?(:display_name)
7358
- @entity_type_metadata = args[:entity_type_metadata] if args.key?(:entity_type_metadata)
7359
7419
  @enum_values = args[:enum_values] if args.key?(:enum_values)
7360
7420
  @name = args[:name] if args.key?(:name)
7361
7421
  @properties = args[:properties] if args.key?(:properties)
@@ -7396,11 +7456,6 @@ module Google
7396
7456
  # @return [String]
7397
7457
  attr_accessor :occurrence_type
7398
7458
 
7399
- # Metadata about a property.
7400
- # Corresponds to the JSON property `propertyMetadata`
7401
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3PropertyMetadata]
7402
- attr_accessor :property_metadata
7403
-
7404
7459
  # A reference to the value type of the property. This type is subject to the
7405
7460
  # same conventions as the `Entity.base_types` field.
7406
7461
  # Corresponds to the JSON property `valueType`
@@ -7415,7 +7470,6 @@ module Google
7415
7470
  def update!(**args)
7416
7471
  @name = args[:name] if args.key?(:name)
7417
7472
  @occurrence_type = args[:occurrence_type] if args.key?(:occurrence_type)
7418
- @property_metadata = args[:property_metadata] if args.key?(:property_metadata)
7419
7473
  @value_type = args[:value_type] if args.key?(:value_type)
7420
7474
  end
7421
7475
  end
@@ -7601,7 +7655,7 @@ module Google
7601
7655
  # @return [Google::Apis::DocumentaiV1beta3::GoogleTypeColor]
7602
7656
  attr_accessor :color
7603
7657
 
7604
- # 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/
7605
7659
  # cssref/pr_font_font-family.asp
7606
7660
  # Corresponds to the JSON property `fontFamily`
7607
7661
  # @return [String]
@@ -7807,25 +7861,304 @@ module Google
7807
7861
  end
7808
7862
  end
7809
7863
 
7810
- # Metadata about an entity type.
7811
- class GoogleCloudDocumentaiV1beta3EntityTypeMetadata
7864
+ # Metadata of the EvaluateProcessorVersion method.
7865
+ class GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata
7812
7866
  include Google::Apis::Core::Hashable
7813
7867
 
7814
- # Metadata for human review labeling config.
7815
- # Corresponds to the JSON property `humanReviewLabelingMetadata`
7816
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3HumanReviewLabelingMetadata]
7817
- 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
7818
7872
 
7819
- # Metadata for Human Review config.
7820
- # Corresponds to the JSON property `humanReviewMetadata`
7821
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3HumanReviewValidationMetadata]
7822
- attr_accessor :human_review_metadata
7873
+ def initialize(**args)
7874
+ update!(**args)
7875
+ end
7823
7876
 
7824
- # Whether the entity type should be considered as "inactive".
7825
- # Corresponds to the JSON property `inactive`
7826
- # @return [Boolean]
7827
- attr_accessor :inactive
7828
- 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
7829
8162
 
7830
8163
  def initialize(**args)
7831
8164
  update!(**args)
@@ -7833,9 +8166,13 @@ module Google
7833
8166
 
7834
8167
  # Update properties of this object
7835
8168
  def update!(**args)
7836
- @human_review_labeling_metadata = args[:human_review_labeling_metadata] if args.key?(:human_review_labeling_metadata)
7837
- @human_review_metadata = args[:human_review_metadata] if args.key?(:human_review_metadata)
7838
- @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)
7839
8176
  end
7840
8177
  end
7841
8178
 
@@ -7921,26 +8258,6 @@ module Google
7921
8258
  end
7922
8259
  end
7923
8260
 
7924
- # Metadata for human review labeling config.
7925
- class GoogleCloudDocumentaiV1beta3HumanReviewLabelingMetadata
7926
- include Google::Apis::Core::Hashable
7927
-
7928
- # Whether to enable normalization editing.
7929
- # Corresponds to the JSON property `enableNormalizationEditing`
7930
- # @return [Boolean]
7931
- attr_accessor :enable_normalization_editing
7932
- alias_method :enable_normalization_editing?, :enable_normalization_editing
7933
-
7934
- def initialize(**args)
7935
- update!(**args)
7936
- end
7937
-
7938
- # Update properties of this object
7939
- def update!(**args)
7940
- @enable_normalization_editing = args[:enable_normalization_editing] if args.key?(:enable_normalization_editing)
7941
- end
7942
- end
7943
-
7944
8261
  # The status of human review on a processed document.
7945
8262
  class GoogleCloudDocumentaiV1beta3HumanReviewStatus
7946
8263
  include Google::Apis::Core::Hashable
@@ -7975,20 +8292,20 @@ module Google
7975
8292
  end
7976
8293
  end
7977
8294
 
7978
- # Metadata for Human Review config.
7979
- class GoogleCloudDocumentaiV1beta3HumanReviewValidationMetadata
8295
+ # The response from ListEvaluations.
8296
+ class GoogleCloudDocumentaiV1beta3ListEvaluationsResponse
7980
8297
  include Google::Apis::Core::Hashable
7981
8298
 
7982
- # The confidence threshold if human review validation is enabled.
7983
- # Corresponds to the JSON property `confidenceThreshold`
7984
- # @return [Float]
7985
- 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
7986
8303
 
7987
- # Whether to enable human review validation.
7988
- # Corresponds to the JSON property `enableValidation`
7989
- # @return [Boolean]
7990
- attr_accessor :enable_validation
7991
- 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
7992
8309
 
7993
8310
  def initialize(**args)
7994
8311
  update!(**args)
@@ -7996,8 +8313,8 @@ module Google
7996
8313
 
7997
8314
  # Update properties of this object
7998
8315
  def update!(**args)
7999
- @confidence_threshold = args[:confidence_threshold] if args.key?(:confidence_threshold)
8000
- @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)
8001
8318
  end
8002
8319
  end
8003
8320
 
@@ -8102,6 +8419,46 @@ module Google
8102
8419
  end
8103
8420
  end
8104
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
+
8105
8462
  # Request message for the process document method.
8106
8463
  class GoogleCloudDocumentaiV1beta3ProcessRequest
8107
8464
  include Google::Apis::Core::Hashable
@@ -8114,7 +8471,9 @@ module Google
8114
8471
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document]
8115
8472
  attr_accessor :document
8116
8473
 
8117
- # 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``.
8118
8477
  # Corresponds to the JSON property `fieldMask`
8119
8478
  # @return [String]
8120
8479
  attr_accessor :field_mask
@@ -8127,6 +8486,11 @@ module Google
8127
8486
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document]
8128
8487
  attr_accessor :inline_document
8129
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
+
8130
8494
  # Payload message of raw document content (bytes).
8131
8495
  # Corresponds to the JSON property `rawDocument`
8132
8496
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3RawDocument]
@@ -8148,6 +8512,7 @@ module Google
8148
8512
  @document = args[:document] if args.key?(:document)
8149
8513
  @field_mask = args[:field_mask] if args.key?(:field_mask)
8150
8514
  @inline_document = args[:inline_document] if args.key?(:inline_document)
8515
+ @process_options = args[:process_options] if args.key?(:process_options)
8151
8516
  @raw_document = args[:raw_document] if args.key?(:raw_document)
8152
8517
  @skip_human_review = args[:skip_human_review] if args.key?(:skip_human_review)
8153
8518
  end
@@ -8233,8 +8598,8 @@ module Google
8233
8598
  # @return [String]
8234
8599
  attr_accessor :state
8235
8600
 
8236
- # The processor type, e.g., OCR_PROCESSOR, INVOICE_PROCESSOR, etc. To get a list
8237
- # 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.
8238
8603
  # Corresponds to the JSON property `type`
8239
8604
  # @return [String]
8240
8605
  attr_accessor :type
@@ -8283,13 +8648,18 @@ module Google
8283
8648
  # @return [String]
8284
8649
  attr_accessor :launch_stage
8285
8650
 
8286
- # The resource name of the processor type. Format: projects/`project`/
8287
- # processorTypes/`processor_type`
8651
+ # The resource name of the processor type. Format: `projects/`project`/
8652
+ # processorTypes/`processor_type``
8288
8653
  # Corresponds to the JSON property `name`
8289
8654
  # @return [String]
8290
8655
  attr_accessor :name
8291
8656
 
8292
- # 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.
8293
8663
  # Corresponds to the JSON property `type`
8294
8664
  # @return [String]
8295
8665
  attr_accessor :type
@@ -8305,6 +8675,7 @@ module Google
8305
8675
  @category = args[:category] if args.key?(:category)
8306
8676
  @launch_stage = args[:launch_stage] if args.key?(:launch_stage)
8307
8677
  @name = args[:name] if args.key?(:name)
8678
+ @sample_document_uris = args[:sample_document_uris] if args.key?(:sample_document_uris)
8308
8679
  @type = args[:type] if args.key?(:type)
8309
8680
  end
8310
8681
  end
@@ -8351,6 +8722,11 @@ module Google
8351
8722
  # @return [String]
8352
8723
  attr_accessor :display_name
8353
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
+
8354
8730
  # Denotes that this ProcessorVersion is managed by google.
8355
8731
  # Corresponds to the JSON property `googleManaged`
8356
8732
  # @return [Boolean]
@@ -8388,6 +8764,7 @@ module Google
8388
8764
  @create_time = args[:create_time] if args.key?(:create_time)
8389
8765
  @deprecation_info = args[:deprecation_info] if args.key?(:deprecation_info)
8390
8766
  @display_name = args[:display_name] if args.key?(:display_name)
8767
+ @document_schema = args[:document_schema] if args.key?(:document_schema)
8391
8768
  @google_managed = args[:google_managed] if args.key?(:google_managed)
8392
8769
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
8393
8770
  @kms_key_version_name = args[:kms_key_version_name] if args.key?(:kms_key_version_name)
@@ -8421,38 +8798,6 @@ module Google
8421
8798
  end
8422
8799
  end
8423
8800
 
8424
- # Metadata about a property.
8425
- class GoogleCloudDocumentaiV1beta3PropertyMetadata
8426
- include Google::Apis::Core::Hashable
8427
-
8428
- # Metadata for human review labeling config.
8429
- # Corresponds to the JSON property `humanReviewLabelingMetadata`
8430
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3HumanReviewLabelingMetadata]
8431
- attr_accessor :human_review_labeling_metadata
8432
-
8433
- # Metadata for Human Review config.
8434
- # Corresponds to the JSON property `humanReviewMetadata`
8435
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3HumanReviewValidationMetadata]
8436
- attr_accessor :human_review_metadata
8437
-
8438
- # Whether the property should be considered as "inactive".
8439
- # Corresponds to the JSON property `inactive`
8440
- # @return [Boolean]
8441
- attr_accessor :inactive
8442
- alias_method :inactive?, :inactive
8443
-
8444
- def initialize(**args)
8445
- update!(**args)
8446
- end
8447
-
8448
- # Update properties of this object
8449
- def update!(**args)
8450
- @human_review_labeling_metadata = args[:human_review_labeling_metadata] if args.key?(:human_review_labeling_metadata)
8451
- @human_review_metadata = args[:human_review_metadata] if args.key?(:human_review_metadata)
8452
- @inactive = args[:inactive] if args.key?(:inactive)
8453
- end
8454
- end
8455
-
8456
8801
  # Payload message of raw document content (bytes).
8457
8802
  class GoogleCloudDocumentaiV1beta3RawDocument
8458
8803
  include Google::Apis::Core::Hashable
@@ -8463,7 +8808,7 @@ module Google
8463
8808
  # @return [String]
8464
8809
  attr_accessor :content
8465
8810
 
8466
- # 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.
8467
8812
  # Corresponds to the JSON property `mimeType`
8468
8813
  # @return [String]
8469
8814
  attr_accessor :mime_type
@@ -8664,6 +9009,167 @@ module Google
8664
9009
  end
8665
9010
  end
8666
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
+
8667
9173
  # The long running operation metadata for the undeploy processor version method.
8668
9174
  class GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata
8669
9175
  include Google::Apis::Core::Hashable