google-apis-documentai_v1beta3 0.58.0 → 0.60.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -389,8 +389,8 @@ module Google
389
389
  class GoogleCloudDocumentaiUiv1beta3DocumentId
390
390
  include Google::Apis::Core::Hashable
391
391
 
392
- # Identifies a document uniquely within the scope of a dataset in the GCS-based
393
- # option.
392
+ # Identifies a document uniquely within the scope of a dataset in the Cloud
393
+ # Storage option.
394
394
  # Corresponds to the JSON property `gcsManagedDocId`
395
395
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentIdGcsManagedDocumentId]
396
396
  attr_accessor :gcs_managed_doc_id
@@ -411,12 +411,12 @@ module Google
411
411
  end
412
412
  end
413
413
 
414
- # Identifies a document uniquely within the scope of a dataset in the GCS-based
415
- # option.
414
+ # Identifies a document uniquely within the scope of a dataset in the Cloud
415
+ # Storage option.
416
416
  class GoogleCloudDocumentaiUiv1beta3DocumentIdGcsManagedDocumentId
417
417
  include Google::Apis::Core::Hashable
418
418
 
419
- # Optional. Id of the document (indexed) managed by Content Warehouse.
419
+ # Id of the document (indexed) managed by Content Warehouse.
420
420
  # Corresponds to the JSON property `cwDocId`
421
421
  # @return [String]
422
422
  attr_accessor :cw_doc_id
@@ -887,18 +887,17 @@ module Google
887
887
  class GoogleCloudDocumentaiUiv1beta3RevisionReference
888
888
  include Google::Apis::Core::Hashable
889
889
 
890
- # Read the revision generated by the processor version, returns error if it does
891
- # not exist.
890
+ # Reads the revision generated by the processor version.
892
891
  # Corresponds to the JSON property `latestProcessorVersion`
893
892
  # @return [String]
894
893
  attr_accessor :latest_processor_version
895
894
 
896
- # Read the revision by the predefined case.
895
+ # Reads the revision by the predefined case.
897
896
  # Corresponds to the JSON property `revisionCase`
898
897
  # @return [String]
899
898
  attr_accessor :revision_case
900
899
 
901
- # Read the revision given by the id, returns error if it does not exist.
900
+ # Reads the revision given by the id.
902
901
  # Corresponds to the JSON property `revisionId`
903
902
  # @return [String]
904
903
  attr_accessor :revision_id
@@ -1567,92 +1566,32 @@ module Google
1567
1566
  end
1568
1567
  end
1569
1568
 
1570
- # The long running operation metadata for AnalyzeHitlData.
1571
- class GoogleCloudDocumentaiV1alpha1AnalyzeHitlDataMetadata
1572
- include Google::Apis::Core::Hashable
1573
-
1574
- # The common metadata for long running operations.
1575
- # Corresponds to the JSON property `commonMetadata`
1576
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1alpha1CommonOperationMetadata]
1577
- attr_accessor :common_metadata
1578
-
1579
- def initialize(**args)
1580
- update!(**args)
1581
- end
1582
-
1583
- # Update properties of this object
1584
- def update!(**args)
1585
- @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
1586
- end
1587
- end
1588
-
1589
- # The common metadata for long running operations.
1590
- class GoogleCloudDocumentaiV1alpha1CommonOperationMetadata
1591
- include Google::Apis::Core::Hashable
1592
-
1593
- # The creation time of the operation.
1594
- # Corresponds to the JSON property `createTime`
1595
- # @return [String]
1596
- attr_accessor :create_time
1597
-
1598
- # A related resource to this operation.
1599
- # Corresponds to the JSON property `resource`
1600
- # @return [String]
1601
- attr_accessor :resource
1602
-
1603
- # The state of the operation.
1604
- # Corresponds to the JSON property `state`
1605
- # @return [String]
1606
- attr_accessor :state
1607
-
1608
- # A message providing more details about the current state of processing.
1609
- # Corresponds to the JSON property `stateMessage`
1610
- # @return [String]
1611
- attr_accessor :state_message
1612
-
1613
- # The last update time of the operation.
1614
- # Corresponds to the JSON property `updateTime`
1615
- # @return [String]
1616
- attr_accessor :update_time
1617
-
1618
- def initialize(**args)
1619
- update!(**args)
1620
- end
1621
-
1622
- # Update properties of this object
1623
- def update!(**args)
1624
- @create_time = args[:create_time] if args.key?(:create_time)
1625
- @resource = args[:resource] if args.key?(:resource)
1626
- @state = args[:state] if args.key?(:state)
1627
- @state_message = args[:state_message] if args.key?(:state_message)
1628
- @update_time = args[:update_time] if args.key?(:update_time)
1629
- end
1630
- end
1631
-
1632
1569
  # Encodes the detailed information of a barcode.
1633
1570
  class GoogleCloudDocumentaiV1beta1Barcode
1634
1571
  include Google::Apis::Core::Hashable
1635
1572
 
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.
1573
+ # Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. -
1574
+ # `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type.
1575
+ # - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13
1576
+ # type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A
1577
+ # type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code
1578
+ # type. - `DATABAR`: GS1 DataBar code type.
1641
1579
  # Corresponds to the JSON property `format`
1642
1580
  # @return [String]
1643
1581
  attr_accessor :format
1644
1582
 
1645
- # Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://
1646
- # www.google.com;;'.
1583
+ # Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https:/
1584
+ # /www.google.com;;'`.
1647
1585
  # Corresponds to the JSON property `rawValue`
1648
1586
  # @return [String]
1649
1587
  attr_accessor :raw_value
1650
1588
 
1651
1589
  # 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.
1590
+ # supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email
1591
+ # address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`:
1592
+ # Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `
1593
+ # WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`:
1594
+ # Calendar event. - `DRIVER_LICENSE`: Driver's license.
1656
1595
  # Corresponds to the JSON property `valueFormat`
1657
1596
  # @return [String]
1658
1597
  attr_accessor :value_format
@@ -1778,14 +1717,14 @@ module Google
1778
1717
  # @return [String]
1779
1718
  attr_accessor :text
1780
1719
 
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.
1720
+ # Placeholder. A list of text corrections made to Document.text. This is usually
1721
+ # used for annotating corrections to OCR mistakes. Text changes for a given
1722
+ # revision may not overlap with each other.
1784
1723
  # Corresponds to the JSON property `textChanges`
1785
1724
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentTextChange>]
1786
1725
  attr_accessor :text_changes
1787
1726
 
1788
- # Placeholder. Styles for the Document.text.
1727
+ # Styles for the Document.text.
1789
1728
  # Corresponds to the JSON property `textStyles`
1790
1729
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentStyle>]
1791
1730
  attr_accessor :text_styles
@@ -1825,7 +1764,7 @@ module Google
1825
1764
  class GoogleCloudDocumentaiV1beta1DocumentEntity
1826
1765
  include Google::Apis::Core::Hashable
1827
1766
 
1828
- # Optional. Confidence of detected Schema entity. Range [0, 1].
1767
+ # Optional. Confidence of detected Schema entity. Range `[0, 1]`.
1829
1768
  # Corresponds to the JSON property `confidence`
1830
1769
  # @return [Float]
1831
1770
  attr_accessor :confidence
@@ -1978,8 +1917,8 @@ module Google
1978
1917
  # Optional. An optional field to store a normalized string. For some entity
1979
1918
  # types, one of respective `structured_value` fields may also be populated. Also
1980
1919
  # 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 (`
1920
+ # processors may not generate `float` or `integer` normalized text by default.
1921
+ # Below are sample formats mapped to structured values. - Money/Currency type (`
1983
1922
  # money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in
1984
1923
  # the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO
1985
1924
  # 8601 text format.
@@ -2188,7 +2127,7 @@ module Google
2188
2127
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1BoundingPoly]
2189
2128
  attr_accessor :bounding_poly
2190
2129
 
2191
- # Optional. Confidence of detected page element, if applicable. Range [0, 1].
2130
+ # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
2192
2131
  # Corresponds to the JSON property `confidence`
2193
2132
  # @return [Float]
2194
2133
  attr_accessor :confidence
@@ -2203,10 +2142,10 @@ module Google
2203
2142
  # @return [String]
2204
2143
  attr_accessor :layout_type
2205
2144
 
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.
2145
+ # Required. Index into the Document.pages element, for example using `Document.
2146
+ # pages` to locate the related page element. This field is skipped when its
2147
+ # value is the default `0`. See https://developers.google.com/protocol-buffers/
2148
+ # docs/proto3#json.
2210
2149
  # Corresponds to the JSON property `page`
2211
2150
  # @return [Fixnum]
2212
2151
  attr_accessor :page
@@ -2287,12 +2226,12 @@ module Google
2287
2226
  class GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage
2288
2227
  include Google::Apis::Core::Hashable
2289
2228
 
2290
- # Confidence of detected language. Range [0, 1].
2229
+ # Confidence of detected language. Range `[0, 1]`.
2291
2230
  # Corresponds to the JSON property `confidence`
2292
2231
  # @return [Float]
2293
2232
  attr_accessor :confidence
2294
2233
 
2295
- # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information,
2234
+ # The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information,
2296
2235
  # see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
2297
2236
  # Corresponds to the JSON property `languageCode`
2298
2237
  # @return [String]
@@ -2385,8 +2324,8 @@ module Google
2385
2324
  attr_accessor :value_detected_languages
2386
2325
 
2387
2326
  # 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"
2327
+ # values are: - blank (this indicates the `field_value` is normal text) - `
2328
+ # unfilled_checkbox` - `filled_checkbox`
2390
2329
  # Corresponds to the JSON property `valueType`
2391
2330
  # @return [String]
2392
2331
  attr_accessor :value_type
@@ -2455,7 +2394,7 @@ module Google
2455
2394
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect>]
2456
2395
  attr_accessor :detected_defects
2457
2396
 
2458
- # The overall quality score. Range [0, 1] where 1 is perfect quality.
2397
+ # The overall quality score. Range `[0, 1]` where 1 is perfect quality.
2459
2398
  # Corresponds to the JSON property `qualityScore`
2460
2399
  # @return [Float]
2461
2400
  attr_accessor :quality_score
@@ -2475,16 +2414,16 @@ module Google
2475
2414
  class GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect
2476
2415
  include Google::Apis::Core::Hashable
2477
2416
 
2478
- # Confidence of detected defect. Range [0, 1] where 1 indicates strong
2417
+ # Confidence of detected defect. Range `[0, 1]` where 1 indicates strong
2479
2418
  # confidence of that the defect exists.
2480
2419
  # Corresponds to the JSON property `confidence`
2481
2420
  # @return [Float]
2482
2421
  attr_accessor :confidence
2483
2422
 
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"
2423
+ # Name of the defect type. Supported values are: - `quality/defect_blurry` - `
2424
+ # quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `
2425
+ # quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/
2426
+ # defect_text_cutoff` - `quality/defect_glare`
2488
2427
  # Corresponds to the JSON property `type`
2489
2428
  # @return [String]
2490
2429
  attr_accessor :type
@@ -2511,7 +2450,7 @@ module Google
2511
2450
 
2512
2451
  # Confidence of the current Layout within context of the object this layout is
2513
2452
  # for. e.g. confidence can be for a single token, a table, a visual element, etc.
2514
- # depending on context. Range [0, 1].
2453
+ # depending on context. Range `[0, 1]`.
2515
2454
  # Corresponds to the JSON property `confidence`
2516
2455
  # @return [Float]
2517
2456
  attr_accessor :confidence
@@ -2695,6 +2634,12 @@ module Google
2695
2634
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentPageLayout]
2696
2635
  attr_accessor :layout
2697
2636
 
2637
+ # Structure to identify provenance relationships between annotations in
2638
+ # different revisions.
2639
+ # Corresponds to the JSON property `provenance`
2640
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentProvenance]
2641
+ attr_accessor :provenance
2642
+
2698
2643
  def initialize(**args)
2699
2644
  update!(**args)
2700
2645
  end
@@ -2705,6 +2650,7 @@ module Google
2705
2650
  @detected_languages = args[:detected_languages] if args.key?(:detected_languages)
2706
2651
  @header_rows = args[:header_rows] if args.key?(:header_rows)
2707
2652
  @layout = args[:layout] if args.key?(:layout)
2653
+ @provenance = args[:provenance] if args.key?(:provenance)
2708
2654
  end
2709
2655
  end
2710
2656
 
@@ -3145,7 +3091,7 @@ module Google
3145
3091
  # @return [Google::Apis::DocumentaiV1beta3::GoogleTypeColor]
3146
3092
  attr_accessor :color
3147
3093
 
3148
- # Font family such as "Arial", "Times New Roman". https://www.w3schools.com/
3094
+ # Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/
3149
3095
  # cssref/pr_font_font-family.asp
3150
3096
  # Corresponds to the JSON property `fontFamily`
3151
3097
  # @return [String]
@@ -3522,26 +3468,28 @@ module Google
3522
3468
  class GoogleCloudDocumentaiV1beta2Barcode
3523
3469
  include Google::Apis::Core::Hashable
3524
3470
 
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.
3471
+ # Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. -
3472
+ # `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type.
3473
+ # - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13
3474
+ # type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A
3475
+ # type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code
3476
+ # type. - `DATABAR`: GS1 DataBar code type.
3530
3477
  # Corresponds to the JSON property `format`
3531
3478
  # @return [String]
3532
3479
  attr_accessor :format
3533
3480
 
3534
- # Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://
3535
- # www.google.com;;'.
3481
+ # Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https:/
3482
+ # /www.google.com;;'`.
3536
3483
  # Corresponds to the JSON property `rawValue`
3537
3484
  # @return [String]
3538
3485
  attr_accessor :raw_value
3539
3486
 
3540
3487
  # 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.
3488
+ # supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email
3489
+ # address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`:
3490
+ # Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `
3491
+ # WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`:
3492
+ # Calendar event. - `DRIVER_LICENSE`: Driver's license.
3545
3493
  # Corresponds to the JSON property `valueFormat`
3546
3494
  # @return [String]
3547
3495
  attr_accessor :value_format
@@ -3672,14 +3620,14 @@ module Google
3672
3620
  # @return [String]
3673
3621
  attr_accessor :text
3674
3622
 
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.
3623
+ # Placeholder. A list of text corrections made to Document.text. This is usually
3624
+ # used for annotating corrections to OCR mistakes. Text changes for a given
3625
+ # revision may not overlap with each other.
3678
3626
  # Corresponds to the JSON property `textChanges`
3679
3627
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentTextChange>]
3680
3628
  attr_accessor :text_changes
3681
3629
 
3682
- # Placeholder. Styles for the Document.text.
3630
+ # Styles for the Document.text.
3683
3631
  # Corresponds to the JSON property `textStyles`
3684
3632
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentStyle>]
3685
3633
  attr_accessor :text_styles
@@ -3720,7 +3668,7 @@ module Google
3720
3668
  class GoogleCloudDocumentaiV1beta2DocumentEntity
3721
3669
  include Google::Apis::Core::Hashable
3722
3670
 
3723
- # Optional. Confidence of detected Schema entity. Range [0, 1].
3671
+ # Optional. Confidence of detected Schema entity. Range `[0, 1]`.
3724
3672
  # Corresponds to the JSON property `confidence`
3725
3673
  # @return [Float]
3726
3674
  attr_accessor :confidence
@@ -3873,8 +3821,8 @@ module Google
3873
3821
  # Optional. An optional field to store a normalized string. For some entity
3874
3822
  # types, one of respective `structured_value` fields may also be populated. Also
3875
3823
  # 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 (`
3824
+ # processors may not generate `float` or `integer` normalized text by default.
3825
+ # Below are sample formats mapped to structured values. - Money/Currency type (`
3878
3826
  # money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in
3879
3827
  # the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO
3880
3828
  # 8601 text format.
@@ -4120,7 +4068,7 @@ module Google
4120
4068
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2BoundingPoly]
4121
4069
  attr_accessor :bounding_poly
4122
4070
 
4123
- # Optional. Confidence of detected page element, if applicable. Range [0, 1].
4071
+ # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
4124
4072
  # Corresponds to the JSON property `confidence`
4125
4073
  # @return [Float]
4126
4074
  attr_accessor :confidence
@@ -4135,10 +4083,10 @@ module Google
4135
4083
  # @return [String]
4136
4084
  attr_accessor :layout_type
4137
4085
 
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.
4086
+ # Required. Index into the Document.pages element, for example using `Document.
4087
+ # pages` to locate the related page element. This field is skipped when its
4088
+ # value is the default `0`. See https://developers.google.com/protocol-buffers/
4089
+ # docs/proto3#json.
4142
4090
  # Corresponds to the JSON property `page`
4143
4091
  # @return [Fixnum]
4144
4092
  attr_accessor :page
@@ -4219,12 +4167,12 @@ module Google
4219
4167
  class GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage
4220
4168
  include Google::Apis::Core::Hashable
4221
4169
 
4222
- # Confidence of detected language. Range [0, 1].
4170
+ # Confidence of detected language. Range `[0, 1]`.
4223
4171
  # Corresponds to the JSON property `confidence`
4224
4172
  # @return [Float]
4225
4173
  attr_accessor :confidence
4226
4174
 
4227
- # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information,
4175
+ # The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information,
4228
4176
  # see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
4229
4177
  # Corresponds to the JSON property `languageCode`
4230
4178
  # @return [String]
@@ -4317,8 +4265,8 @@ module Google
4317
4265
  attr_accessor :value_detected_languages
4318
4266
 
4319
4267
  # 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"
4268
+ # values are: - blank (this indicates the `field_value` is normal text) - `
4269
+ # unfilled_checkbox` - `filled_checkbox`
4322
4270
  # Corresponds to the JSON property `valueType`
4323
4271
  # @return [String]
4324
4272
  attr_accessor :value_type
@@ -4387,7 +4335,7 @@ module Google
4387
4335
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect>]
4388
4336
  attr_accessor :detected_defects
4389
4337
 
4390
- # The overall quality score. Range [0, 1] where 1 is perfect quality.
4338
+ # The overall quality score. Range `[0, 1]` where 1 is perfect quality.
4391
4339
  # Corresponds to the JSON property `qualityScore`
4392
4340
  # @return [Float]
4393
4341
  attr_accessor :quality_score
@@ -4407,16 +4355,16 @@ module Google
4407
4355
  class GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect
4408
4356
  include Google::Apis::Core::Hashable
4409
4357
 
4410
- # Confidence of detected defect. Range [0, 1] where 1 indicates strong
4358
+ # Confidence of detected defect. Range `[0, 1]` where 1 indicates strong
4411
4359
  # confidence of that the defect exists.
4412
4360
  # Corresponds to the JSON property `confidence`
4413
4361
  # @return [Float]
4414
4362
  attr_accessor :confidence
4415
4363
 
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"
4364
+ # Name of the defect type. Supported values are: - `quality/defect_blurry` - `
4365
+ # quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `
4366
+ # quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/
4367
+ # defect_text_cutoff` - `quality/defect_glare`
4420
4368
  # Corresponds to the JSON property `type`
4421
4369
  # @return [String]
4422
4370
  attr_accessor :type
@@ -4443,7 +4391,7 @@ module Google
4443
4391
 
4444
4392
  # Confidence of the current Layout within context of the object this layout is
4445
4393
  # for. e.g. confidence can be for a single token, a table, a visual element, etc.
4446
- # depending on context. Range [0, 1].
4394
+ # depending on context. Range `[0, 1]`.
4447
4395
  # Corresponds to the JSON property `confidence`
4448
4396
  # @return [Float]
4449
4397
  attr_accessor :confidence
@@ -4627,6 +4575,12 @@ module Google
4627
4575
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentPageLayout]
4628
4576
  attr_accessor :layout
4629
4577
 
4578
+ # Structure to identify provenance relationships between annotations in
4579
+ # different revisions.
4580
+ # Corresponds to the JSON property `provenance`
4581
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentProvenance]
4582
+ attr_accessor :provenance
4583
+
4630
4584
  def initialize(**args)
4631
4585
  update!(**args)
4632
4586
  end
@@ -4637,6 +4591,7 @@ module Google
4637
4591
  @detected_languages = args[:detected_languages] if args.key?(:detected_languages)
4638
4592
  @header_rows = args[:header_rows] if args.key?(:header_rows)
4639
4593
  @layout = args[:layout] if args.key?(:layout)
4594
+ @provenance = args[:provenance] if args.key?(:provenance)
4640
4595
  end
4641
4596
  end
4642
4597
 
@@ -5077,7 +5032,7 @@ module Google
5077
5032
  # @return [Google::Apis::DocumentaiV1beta3::GoogleTypeColor]
5078
5033
  attr_accessor :color
5079
5034
 
5080
- # Font family such as "Arial", "Times New Roman". https://www.w3schools.com/
5035
+ # Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/
5081
5036
  # cssref/pr_font_font-family.asp
5082
5037
  # Corresponds to the JSON property `fontFamily`
5083
5038
  # @return [String]
@@ -5464,26 +5419,28 @@ module Google
5464
5419
  class GoogleCloudDocumentaiV1beta3Barcode
5465
5420
  include Google::Apis::Core::Hashable
5466
5421
 
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.
5422
+ # Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. -
5423
+ # `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type.
5424
+ # - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13
5425
+ # type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A
5426
+ # type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code
5427
+ # type. - `DATABAR`: GS1 DataBar code type.
5472
5428
  # Corresponds to the JSON property `format`
5473
5429
  # @return [String]
5474
5430
  attr_accessor :format
5475
5431
 
5476
- # Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://
5477
- # www.google.com;;'.
5432
+ # Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https:/
5433
+ # /www.google.com;;'`.
5478
5434
  # Corresponds to the JSON property `rawValue`
5479
5435
  # @return [String]
5480
5436
  attr_accessor :raw_value
5481
5437
 
5482
5438
  # 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.
5439
+ # supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email
5440
+ # address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`:
5441
+ # Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `
5442
+ # WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`:
5443
+ # Calendar event. - `DRIVER_LICENSE`: Driver's license.
5487
5444
  # Corresponds to the JSON property `valueFormat`
5488
5445
  # @return [String]
5489
5446
  attr_accessor :value_format
@@ -5649,6 +5606,11 @@ module Google
5649
5606
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig]
5650
5607
  attr_accessor :output_config
5651
5608
 
5609
+ # Options for Process API
5610
+ # Corresponds to the JSON property `processOptions`
5611
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessOptions]
5612
+ attr_accessor :process_options
5613
+
5652
5614
  # Whether Human Review feature should be skipped for this request. Default to
5653
5615
  # false.
5654
5616
  # Corresponds to the JSON property `skipHumanReview`
@@ -5666,6 +5628,7 @@ module Google
5666
5628
  @input_configs = args[:input_configs] if args.key?(:input_configs)
5667
5629
  @input_documents = args[:input_documents] if args.key?(:input_documents)
5668
5630
  @output_config = args[:output_config] if args.key?(:output_config)
5631
+ @process_options = args[:process_options] if args.key?(:process_options)
5669
5632
  @skip_human_review = args[:skip_human_review] if args.key?(:skip_human_review)
5670
5633
  end
5671
5634
  end
@@ -5990,14 +5953,14 @@ module Google
5990
5953
  # @return [String]
5991
5954
  attr_accessor :text
5992
5955
 
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.
5956
+ # Placeholder. A list of text corrections made to Document.text. This is usually
5957
+ # used for annotating corrections to OCR mistakes. Text changes for a given
5958
+ # revision may not overlap with each other.
5996
5959
  # Corresponds to the JSON property `textChanges`
5997
5960
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentTextChange>]
5998
5961
  attr_accessor :text_changes
5999
5962
 
6000
- # Placeholder. Styles for the Document.text.
5963
+ # Styles for the Document.text.
6001
5964
  # Corresponds to the JSON property `textStyles`
6002
5965
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentStyle>]
6003
5966
  attr_accessor :text_styles
@@ -6037,7 +6000,7 @@ module Google
6037
6000
  class GoogleCloudDocumentaiV1beta3DocumentEntity
6038
6001
  include Google::Apis::Core::Hashable
6039
6002
 
6040
- # Optional. Confidence of detected Schema entity. Range [0, 1].
6003
+ # Optional. Confidence of detected Schema entity. Range `[0, 1]`.
6041
6004
  # Corresponds to the JSON property `confidence`
6042
6005
  # @return [Float]
6043
6006
  attr_accessor :confidence
@@ -6190,8 +6153,8 @@ module Google
6190
6153
  # Optional. An optional field to store a normalized string. For some entity
6191
6154
  # types, one of respective `structured_value` fields may also be populated. Also
6192
6155
  # 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 (`
6156
+ # processors may not generate `float` or `integer` normalized text by default.
6157
+ # Below are sample formats mapped to structured values. - Money/Currency type (`
6195
6158
  # money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in
6196
6159
  # the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO
6197
6160
  # 8601 text format.
@@ -6271,7 +6234,9 @@ module Google
6271
6234
  class GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfig
6272
6235
  include Google::Apis::Core::Hashable
6273
6236
 
6274
- # Specifies which fields to include in the output documents.
6237
+ # Specifies which fields to include in the output documents. Only supports top
6238
+ # level document and pages field so it must be in the form of ``
6239
+ # document_field_name`` or `pages.`page_field_name``.
6275
6240
  # Corresponds to the JSON property `fieldMask`
6276
6241
  # @return [String]
6277
6242
  attr_accessor :field_mask
@@ -6281,6 +6246,11 @@ module Google
6281
6246
  # @return [String]
6282
6247
  attr_accessor :gcs_uri
6283
6248
 
6249
+ # The sharding config for the output document.
6250
+ # Corresponds to the JSON property `shardingConfig`
6251
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfigShardingConfig]
6252
+ attr_accessor :sharding_config
6253
+
6284
6254
  def initialize(**args)
6285
6255
  update!(**args)
6286
6256
  end
@@ -6289,6 +6259,32 @@ module Google
6289
6259
  def update!(**args)
6290
6260
  @field_mask = args[:field_mask] if args.key?(:field_mask)
6291
6261
  @gcs_uri = args[:gcs_uri] if args.key?(:gcs_uri)
6262
+ @sharding_config = args[:sharding_config] if args.key?(:sharding_config)
6263
+ end
6264
+ end
6265
+
6266
+ # The sharding config for the output document.
6267
+ class GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfigShardingConfig
6268
+ include Google::Apis::Core::Hashable
6269
+
6270
+ # The number of overlapping pages between consecutive shards.
6271
+ # Corresponds to the JSON property `pagesOverlap`
6272
+ # @return [Fixnum]
6273
+ attr_accessor :pages_overlap
6274
+
6275
+ # The number of pages per shard.
6276
+ # Corresponds to the JSON property `pagesPerShard`
6277
+ # @return [Fixnum]
6278
+ attr_accessor :pages_per_shard
6279
+
6280
+ def initialize(**args)
6281
+ update!(**args)
6282
+ end
6283
+
6284
+ # Update properties of this object
6285
+ def update!(**args)
6286
+ @pages_overlap = args[:pages_overlap] if args.key?(:pages_overlap)
6287
+ @pages_per_shard = args[:pages_per_shard] if args.key?(:pages_per_shard)
6292
6288
  end
6293
6289
  end
6294
6290
 
@@ -6445,7 +6441,7 @@ module Google
6445
6441
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BoundingPoly]
6446
6442
  attr_accessor :bounding_poly
6447
6443
 
6448
- # Optional. Confidence of detected page element, if applicable. Range [0, 1].
6444
+ # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
6449
6445
  # Corresponds to the JSON property `confidence`
6450
6446
  # @return [Float]
6451
6447
  attr_accessor :confidence
@@ -6460,10 +6456,10 @@ module Google
6460
6456
  # @return [String]
6461
6457
  attr_accessor :layout_type
6462
6458
 
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.
6459
+ # Required. Index into the Document.pages element, for example using `Document.
6460
+ # pages` to locate the related page element. This field is skipped when its
6461
+ # value is the default `0`. See https://developers.google.com/protocol-buffers/
6462
+ # docs/proto3#json.
6467
6463
  # Corresponds to the JSON property `page`
6468
6464
  # @return [Fixnum]
6469
6465
  attr_accessor :page
@@ -6544,12 +6540,12 @@ module Google
6544
6540
  class GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage
6545
6541
  include Google::Apis::Core::Hashable
6546
6542
 
6547
- # Confidence of detected language. Range [0, 1].
6543
+ # Confidence of detected language. Range `[0, 1]`.
6548
6544
  # Corresponds to the JSON property `confidence`
6549
6545
  # @return [Float]
6550
6546
  attr_accessor :confidence
6551
6547
 
6552
- # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information,
6548
+ # The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information,
6553
6549
  # see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
6554
6550
  # Corresponds to the JSON property `languageCode`
6555
6551
  # @return [String]
@@ -6642,8 +6638,8 @@ module Google
6642
6638
  attr_accessor :value_detected_languages
6643
6639
 
6644
6640
  # 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"
6641
+ # values are: - blank (this indicates the `field_value` is normal text) - `
6642
+ # unfilled_checkbox` - `filled_checkbox`
6647
6643
  # Corresponds to the JSON property `valueType`
6648
6644
  # @return [String]
6649
6645
  attr_accessor :value_type
@@ -6712,7 +6708,7 @@ module Google
6712
6708
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScoresDetectedDefect>]
6713
6709
  attr_accessor :detected_defects
6714
6710
 
6715
- # The overall quality score. Range [0, 1] where 1 is perfect quality.
6711
+ # The overall quality score. Range `[0, 1]` where 1 is perfect quality.
6716
6712
  # Corresponds to the JSON property `qualityScore`
6717
6713
  # @return [Float]
6718
6714
  attr_accessor :quality_score
@@ -6732,16 +6728,16 @@ module Google
6732
6728
  class GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScoresDetectedDefect
6733
6729
  include Google::Apis::Core::Hashable
6734
6730
 
6735
- # Confidence of detected defect. Range [0, 1] where 1 indicates strong
6731
+ # Confidence of detected defect. Range `[0, 1]` where 1 indicates strong
6736
6732
  # confidence of that the defect exists.
6737
6733
  # Corresponds to the JSON property `confidence`
6738
6734
  # @return [Float]
6739
6735
  attr_accessor :confidence
6740
6736
 
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"
6737
+ # Name of the defect type. Supported values are: - `quality/defect_blurry` - `
6738
+ # quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `
6739
+ # quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/
6740
+ # defect_text_cutoff` - `quality/defect_glare`
6745
6741
  # Corresponds to the JSON property `type`
6746
6742
  # @return [String]
6747
6743
  attr_accessor :type
@@ -6768,7 +6764,7 @@ module Google
6768
6764
 
6769
6765
  # Confidence of the current Layout within context of the object this layout is
6770
6766
  # for. e.g. confidence can be for a single token, a table, a visual element, etc.
6771
- # depending on context. Range [0, 1].
6767
+ # depending on context. Range `[0, 1]`.
6772
6768
  # Corresponds to the JSON property `confidence`
6773
6769
  # @return [Float]
6774
6770
  attr_accessor :confidence
@@ -6952,6 +6948,12 @@ module Google
6952
6948
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageLayout]
6953
6949
  attr_accessor :layout
6954
6950
 
6951
+ # Structure to identify provenance relationships between annotations in
6952
+ # different revisions.
6953
+ # Corresponds to the JSON property `provenance`
6954
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentProvenance]
6955
+ attr_accessor :provenance
6956
+
6955
6957
  def initialize(**args)
6956
6958
  update!(**args)
6957
6959
  end
@@ -6962,6 +6964,7 @@ module Google
6962
6964
  @detected_languages = args[:detected_languages] if args.key?(:detected_languages)
6963
6965
  @header_rows = args[:header_rows] if args.key?(:header_rows)
6964
6966
  @layout = args[:layout] if args.key?(:layout)
6967
+ @provenance = args[:provenance] if args.key?(:provenance)
6965
6968
  end
6966
6969
  end
6967
6970
 
@@ -7320,24 +7323,19 @@ module Google
7320
7323
  # @return [String]
7321
7324
  attr_accessor :display_name
7322
7325
 
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
7326
  # Defines the a list of enum values.
7329
7327
  # Corresponds to the JSON property `enumValues`
7330
7328
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues]
7331
7329
  attr_accessor :enum_values
7332
7330
 
7333
7331
  # 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. -
7332
+ # Common Type'. Besides that we use the following naming conventions: - *use `
7333
+ # snake_casing`* - name matching is case-sensitive - Maximum 64 characters. -
7336
7334
  # Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (
7337
7335
  # 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.
7336
+ # ascii character) - The `/` is sometimes used to denote a property of a type.
7337
+ # For example `line_item/amount`. This convention is deprecated, but will still
7338
+ # be honored for backward compatibility.
7341
7339
  # Corresponds to the JSON property `name`
7342
7340
  # @return [String]
7343
7341
  attr_accessor :name
@@ -7355,7 +7353,6 @@ module Google
7355
7353
  def update!(**args)
7356
7354
  @base_types = args[:base_types] if args.key?(:base_types)
7357
7355
  @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
7356
  @enum_values = args[:enum_values] if args.key?(:enum_values)
7360
7357
  @name = args[:name] if args.key?(:name)
7361
7358
  @properties = args[:properties] if args.key?(:properties)
@@ -7396,11 +7393,6 @@ module Google
7396
7393
  # @return [String]
7397
7394
  attr_accessor :occurrence_type
7398
7395
 
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
7396
  # A reference to the value type of the property. This type is subject to the
7405
7397
  # same conventions as the `Entity.base_types` field.
7406
7398
  # Corresponds to the JSON property `valueType`
@@ -7415,7 +7407,6 @@ module Google
7415
7407
  def update!(**args)
7416
7408
  @name = args[:name] if args.key?(:name)
7417
7409
  @occurrence_type = args[:occurrence_type] if args.key?(:occurrence_type)
7418
- @property_metadata = args[:property_metadata] if args.key?(:property_metadata)
7419
7410
  @value_type = args[:value_type] if args.key?(:value_type)
7420
7411
  end
7421
7412
  end
@@ -7601,7 +7592,7 @@ module Google
7601
7592
  # @return [Google::Apis::DocumentaiV1beta3::GoogleTypeColor]
7602
7593
  attr_accessor :color
7603
7594
 
7604
- # Font family such as "Arial", "Times New Roman". https://www.w3schools.com/
7595
+ # Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/
7605
7596
  # cssref/pr_font_font-family.asp
7606
7597
  # Corresponds to the JSON property `fontFamily`
7607
7598
  # @return [String]
@@ -7807,25 +7798,304 @@ module Google
7807
7798
  end
7808
7799
  end
7809
7800
 
7810
- # Metadata about an entity type.
7811
- class GoogleCloudDocumentaiV1beta3EntityTypeMetadata
7801
+ # Metadata of the EvaluateProcessorVersion method.
7802
+ class GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata
7812
7803
  include Google::Apis::Core::Hashable
7813
7804
 
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
7805
+ # The common metadata for long running operations.
7806
+ # Corresponds to the JSON property `commonMetadata`
7807
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
7808
+ attr_accessor :common_metadata
7818
7809
 
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
7810
+ def initialize(**args)
7811
+ update!(**args)
7812
+ end
7823
7813
 
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
7814
+ # Update properties of this object
7815
+ def update!(**args)
7816
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
7817
+ end
7818
+ end
7819
+
7820
+ # Evaluates the given ProcessorVersion against the supplied documents.
7821
+ class GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionRequest
7822
+ include Google::Apis::Core::Hashable
7823
+
7824
+ # The common config to specify a set of documents used as input.
7825
+ # Corresponds to the JSON property `evaluationDocuments`
7826
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig]
7827
+ attr_accessor :evaluation_documents
7828
+
7829
+ def initialize(**args)
7830
+ update!(**args)
7831
+ end
7832
+
7833
+ # Update properties of this object
7834
+ def update!(**args)
7835
+ @evaluation_documents = args[:evaluation_documents] if args.key?(:evaluation_documents)
7836
+ end
7837
+ end
7838
+
7839
+ # Metadata of the EvaluateProcessorVersion method.
7840
+ class GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse
7841
+ include Google::Apis::Core::Hashable
7842
+
7843
+ # The resource name of the created evaluation.
7844
+ # Corresponds to the JSON property `evaluation`
7845
+ # @return [String]
7846
+ attr_accessor :evaluation
7847
+
7848
+ def initialize(**args)
7849
+ update!(**args)
7850
+ end
7851
+
7852
+ # Update properties of this object
7853
+ def update!(**args)
7854
+ @evaluation = args[:evaluation] if args.key?(:evaluation)
7855
+ end
7856
+ end
7857
+
7858
+ # An evaluation of a ProcessorVersion's performance.
7859
+ class GoogleCloudDocumentaiV1beta3Evaluation
7860
+ include Google::Apis::Core::Hashable
7861
+
7862
+ # Metrics across multiple confidence levels.
7863
+ # Corresponds to the JSON property `allEntitiesMetrics`
7864
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EvaluationMultiConfidenceMetrics]
7865
+ attr_accessor :all_entities_metrics
7866
+
7867
+ # The time that the evaluation was created.
7868
+ # Corresponds to the JSON property `createTime`
7869
+ # @return [String]
7870
+ attr_accessor :create_time
7871
+
7872
+ # Evaluation counters for the documents that were used.
7873
+ # Corresponds to the JSON property `documentCounters`
7874
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EvaluationCounters]
7875
+ attr_accessor :document_counters
7876
+
7877
+ # Metrics across confidence levels, for different entities.
7878
+ # Corresponds to the JSON property `entityMetrics`
7879
+ # @return [Hash<String,Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EvaluationMultiConfidenceMetrics>]
7880
+ attr_accessor :entity_metrics
7881
+
7882
+ # The KMS key name used for encryption.
7883
+ # Corresponds to the JSON property `kmsKeyName`
7884
+ # @return [String]
7885
+ attr_accessor :kms_key_name
7886
+
7887
+ # The KMS key version with which data is encrypted.
7888
+ # Corresponds to the JSON property `kmsKeyVersionName`
7889
+ # @return [String]
7890
+ attr_accessor :kms_key_version_name
7891
+
7892
+ # The resource name of the evaluation. Format: `projects/`project`/locations/`
7893
+ # location`/processors/`processor`/processorVersions/`processor_version`/
7894
+ # evaluations/`evaluation``
7895
+ # Corresponds to the JSON property `name`
7896
+ # @return [String]
7897
+ attr_accessor :name
7898
+
7899
+ def initialize(**args)
7900
+ update!(**args)
7901
+ end
7902
+
7903
+ # Update properties of this object
7904
+ def update!(**args)
7905
+ @all_entities_metrics = args[:all_entities_metrics] if args.key?(:all_entities_metrics)
7906
+ @create_time = args[:create_time] if args.key?(:create_time)
7907
+ @document_counters = args[:document_counters] if args.key?(:document_counters)
7908
+ @entity_metrics = args[:entity_metrics] if args.key?(:entity_metrics)
7909
+ @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
7910
+ @kms_key_version_name = args[:kms_key_version_name] if args.key?(:kms_key_version_name)
7911
+ @name = args[:name] if args.key?(:name)
7912
+ end
7913
+ end
7914
+
7915
+ # Evaluations metrics, at a specific confidence level.
7916
+ class GoogleCloudDocumentaiV1beta3EvaluationConfidenceLevelMetrics
7917
+ include Google::Apis::Core::Hashable
7918
+
7919
+ # The confidence level.
7920
+ # Corresponds to the JSON property `confidenceLevel`
7921
+ # @return [Float]
7922
+ attr_accessor :confidence_level
7923
+
7924
+ # Evaluation metrics, either in aggregate or about a specific entity.
7925
+ # Corresponds to the JSON property `metrics`
7926
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EvaluationMetrics]
7927
+ attr_accessor :metrics
7928
+
7929
+ def initialize(**args)
7930
+ update!(**args)
7931
+ end
7932
+
7933
+ # Update properties of this object
7934
+ def update!(**args)
7935
+ @confidence_level = args[:confidence_level] if args.key?(:confidence_level)
7936
+ @metrics = args[:metrics] if args.key?(:metrics)
7937
+ end
7938
+ end
7939
+
7940
+ # Evaluation counters for the documents that were used.
7941
+ class GoogleCloudDocumentaiV1beta3EvaluationCounters
7942
+ include Google::Apis::Core::Hashable
7943
+
7944
+ # How many documents were used in the evaluation.
7945
+ # Corresponds to the JSON property `evaluatedDocumentsCount`
7946
+ # @return [Fixnum]
7947
+ attr_accessor :evaluated_documents_count
7948
+
7949
+ # How many documents were not included in the evaluation as Document AI failed
7950
+ # to process them.
7951
+ # Corresponds to the JSON property `failedDocumentsCount`
7952
+ # @return [Fixnum]
7953
+ attr_accessor :failed_documents_count
7954
+
7955
+ # How many documents were sent for evaluation.
7956
+ # Corresponds to the JSON property `inputDocumentsCount`
7957
+ # @return [Fixnum]
7958
+ attr_accessor :input_documents_count
7959
+
7960
+ # How many documents were not included in the evaluation as they didn't pass
7961
+ # validation.
7962
+ # Corresponds to the JSON property `invalidDocumentsCount`
7963
+ # @return [Fixnum]
7964
+ attr_accessor :invalid_documents_count
7965
+
7966
+ def initialize(**args)
7967
+ update!(**args)
7968
+ end
7969
+
7970
+ # Update properties of this object
7971
+ def update!(**args)
7972
+ @evaluated_documents_count = args[:evaluated_documents_count] if args.key?(:evaluated_documents_count)
7973
+ @failed_documents_count = args[:failed_documents_count] if args.key?(:failed_documents_count)
7974
+ @input_documents_count = args[:input_documents_count] if args.key?(:input_documents_count)
7975
+ @invalid_documents_count = args[:invalid_documents_count] if args.key?(:invalid_documents_count)
7976
+ end
7977
+ end
7978
+
7979
+ # Evaluation metrics, either in aggregate or about a specific entity.
7980
+ class GoogleCloudDocumentaiV1beta3EvaluationMetrics
7981
+ include Google::Apis::Core::Hashable
7982
+
7983
+ # The calculated f1 score.
7984
+ # Corresponds to the JSON property `f1Score`
7985
+ # @return [Float]
7986
+ attr_accessor :f1_score
7987
+
7988
+ # The amount of false negatives.
7989
+ # Corresponds to the JSON property `falseNegativesCount`
7990
+ # @return [Fixnum]
7991
+ attr_accessor :false_negatives_count
7992
+
7993
+ # The amount of false positives.
7994
+ # Corresponds to the JSON property `falsePositivesCount`
7995
+ # @return [Fixnum]
7996
+ attr_accessor :false_positives_count
7997
+
7998
+ # The amount of documents with a ground truth occurrence.
7999
+ # Corresponds to the JSON property `groundTruthDocumentCount`
8000
+ # @return [Fixnum]
8001
+ attr_accessor :ground_truth_document_count
8002
+
8003
+ # The amount of occurrences in ground truth documents.
8004
+ # Corresponds to the JSON property `groundTruthOccurrencesCount`
8005
+ # @return [Fixnum]
8006
+ attr_accessor :ground_truth_occurrences_count
8007
+
8008
+ # The calculated precision.
8009
+ # Corresponds to the JSON property `precision`
8010
+ # @return [Float]
8011
+ attr_accessor :precision
8012
+
8013
+ # The amount of documents with a predicted occurrence.
8014
+ # Corresponds to the JSON property `predictedDocumentCount`
8015
+ # @return [Fixnum]
8016
+ attr_accessor :predicted_document_count
8017
+
8018
+ # The amount of occurrences in predicted documents.
8019
+ # Corresponds to the JSON property `predictedOccurrencesCount`
8020
+ # @return [Fixnum]
8021
+ attr_accessor :predicted_occurrences_count
8022
+
8023
+ # The calculated recall.
8024
+ # Corresponds to the JSON property `recall`
8025
+ # @return [Float]
8026
+ attr_accessor :recall
8027
+
8028
+ # The amount of documents that had an occurrence of this label.
8029
+ # Corresponds to the JSON property `totalDocumentsCount`
8030
+ # @return [Fixnum]
8031
+ attr_accessor :total_documents_count
8032
+
8033
+ # The amount of true positives.
8034
+ # Corresponds to the JSON property `truePositivesCount`
8035
+ # @return [Fixnum]
8036
+ attr_accessor :true_positives_count
8037
+
8038
+ def initialize(**args)
8039
+ update!(**args)
8040
+ end
8041
+
8042
+ # Update properties of this object
8043
+ def update!(**args)
8044
+ @f1_score = args[:f1_score] if args.key?(:f1_score)
8045
+ @false_negatives_count = args[:false_negatives_count] if args.key?(:false_negatives_count)
8046
+ @false_positives_count = args[:false_positives_count] if args.key?(:false_positives_count)
8047
+ @ground_truth_document_count = args[:ground_truth_document_count] if args.key?(:ground_truth_document_count)
8048
+ @ground_truth_occurrences_count = args[:ground_truth_occurrences_count] if args.key?(:ground_truth_occurrences_count)
8049
+ @precision = args[:precision] if args.key?(:precision)
8050
+ @predicted_document_count = args[:predicted_document_count] if args.key?(:predicted_document_count)
8051
+ @predicted_occurrences_count = args[:predicted_occurrences_count] if args.key?(:predicted_occurrences_count)
8052
+ @recall = args[:recall] if args.key?(:recall)
8053
+ @total_documents_count = args[:total_documents_count] if args.key?(:total_documents_count)
8054
+ @true_positives_count = args[:true_positives_count] if args.key?(:true_positives_count)
8055
+ end
8056
+ end
8057
+
8058
+ # Metrics across multiple confidence levels.
8059
+ class GoogleCloudDocumentaiV1beta3EvaluationMultiConfidenceMetrics
8060
+ include Google::Apis::Core::Hashable
8061
+
8062
+ # The calculated area under the precision recall curve (AUPRC), computed by
8063
+ # integrating over all confidence thresholds.
8064
+ # Corresponds to the JSON property `auprc`
8065
+ # @return [Float]
8066
+ attr_accessor :auprc
8067
+
8068
+ # The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only.
8069
+ # Corresponds to the JSON property `auprcExact`
8070
+ # @return [Float]
8071
+ attr_accessor :auprc_exact
8072
+
8073
+ # Metrics across confidence levels with fuzzy matching enabled.
8074
+ # Corresponds to the JSON property `confidenceLevelMetrics`
8075
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EvaluationConfidenceLevelMetrics>]
8076
+ attr_accessor :confidence_level_metrics
8077
+
8078
+ # Metrics across confidence levels with only exact matching.
8079
+ # Corresponds to the JSON property `confidenceLevelMetricsExact`
8080
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EvaluationConfidenceLevelMetrics>]
8081
+ attr_accessor :confidence_level_metrics_exact
8082
+
8083
+ # The Estimated Calibration Error (ECE) of the confidence of the predicted
8084
+ # entities.
8085
+ # Corresponds to the JSON property `estimatedCalibrationError`
8086
+ # @return [Float]
8087
+ attr_accessor :estimated_calibration_error
8088
+
8089
+ # The ECE for the predicted entities with fuzzy matching disabled, i.e., exact
8090
+ # matching only.
8091
+ # Corresponds to the JSON property `estimatedCalibrationErrorExact`
8092
+ # @return [Float]
8093
+ attr_accessor :estimated_calibration_error_exact
8094
+
8095
+ # The metrics type for the label.
8096
+ # Corresponds to the JSON property `metricsType`
8097
+ # @return [String]
8098
+ attr_accessor :metrics_type
7829
8099
 
7830
8100
  def initialize(**args)
7831
8101
  update!(**args)
@@ -7833,9 +8103,13 @@ module Google
7833
8103
 
7834
8104
  # Update properties of this object
7835
8105
  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)
8106
+ @auprc = args[:auprc] if args.key?(:auprc)
8107
+ @auprc_exact = args[:auprc_exact] if args.key?(:auprc_exact)
8108
+ @confidence_level_metrics = args[:confidence_level_metrics] if args.key?(:confidence_level_metrics)
8109
+ @confidence_level_metrics_exact = args[:confidence_level_metrics_exact] if args.key?(:confidence_level_metrics_exact)
8110
+ @estimated_calibration_error = args[:estimated_calibration_error] if args.key?(:estimated_calibration_error)
8111
+ @estimated_calibration_error_exact = args[:estimated_calibration_error_exact] if args.key?(:estimated_calibration_error_exact)
8112
+ @metrics_type = args[:metrics_type] if args.key?(:metrics_type)
7839
8113
  end
7840
8114
  end
7841
8115
 
@@ -7921,26 +8195,6 @@ module Google
7921
8195
  end
7922
8196
  end
7923
8197
 
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
8198
  # The status of human review on a processed document.
7945
8199
  class GoogleCloudDocumentaiV1beta3HumanReviewStatus
7946
8200
  include Google::Apis::Core::Hashable
@@ -7975,20 +8229,20 @@ module Google
7975
8229
  end
7976
8230
  end
7977
8231
 
7978
- # Metadata for Human Review config.
7979
- class GoogleCloudDocumentaiV1beta3HumanReviewValidationMetadata
8232
+ # The response from ListEvaluations.
8233
+ class GoogleCloudDocumentaiV1beta3ListEvaluationsResponse
7980
8234
  include Google::Apis::Core::Hashable
7981
8235
 
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
8236
+ # The evaluations requested.
8237
+ # Corresponds to the JSON property `evaluations`
8238
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Evaluation>]
8239
+ attr_accessor :evaluations
7986
8240
 
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
8241
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
8242
+ # field is omitted, there are no subsequent pages.
8243
+ # Corresponds to the JSON property `nextPageToken`
8244
+ # @return [String]
8245
+ attr_accessor :next_page_token
7992
8246
 
7993
8247
  def initialize(**args)
7994
8248
  update!(**args)
@@ -7996,8 +8250,8 @@ module Google
7996
8250
 
7997
8251
  # Update properties of this object
7998
8252
  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)
8253
+ @evaluations = args[:evaluations] if args.key?(:evaluations)
8254
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
8001
8255
  end
8002
8256
  end
8003
8257
 
@@ -8102,6 +8356,46 @@ module Google
8102
8356
  end
8103
8357
  end
8104
8358
 
8359
+ # Config for Document OCR.
8360
+ class GoogleCloudDocumentaiV1beta3OcrConfig
8361
+ include Google::Apis::Core::Hashable
8362
+
8363
+ # Enables special handling for PDFs with existing text information. Results in
8364
+ # better text extraction quality in such PDF inputs.
8365
+ # Corresponds to the JSON property `enableNativePdfParsing`
8366
+ # @return [Boolean]
8367
+ attr_accessor :enable_native_pdf_parsing
8368
+ alias_method :enable_native_pdf_parsing?, :enable_native_pdf_parsing
8369
+
8370
+ def initialize(**args)
8371
+ update!(**args)
8372
+ end
8373
+
8374
+ # Update properties of this object
8375
+ def update!(**args)
8376
+ @enable_native_pdf_parsing = args[:enable_native_pdf_parsing] if args.key?(:enable_native_pdf_parsing)
8377
+ end
8378
+ end
8379
+
8380
+ # Options for Process API
8381
+ class GoogleCloudDocumentaiV1beta3ProcessOptions
8382
+ include Google::Apis::Core::Hashable
8383
+
8384
+ # Config for Document OCR.
8385
+ # Corresponds to the JSON property `ocrConfig`
8386
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3OcrConfig]
8387
+ attr_accessor :ocr_config
8388
+
8389
+ def initialize(**args)
8390
+ update!(**args)
8391
+ end
8392
+
8393
+ # Update properties of this object
8394
+ def update!(**args)
8395
+ @ocr_config = args[:ocr_config] if args.key?(:ocr_config)
8396
+ end
8397
+ end
8398
+
8105
8399
  # Request message for the process document method.
8106
8400
  class GoogleCloudDocumentaiV1beta3ProcessRequest
8107
8401
  include Google::Apis::Core::Hashable
@@ -8114,7 +8408,9 @@ module Google
8114
8408
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document]
8115
8409
  attr_accessor :document
8116
8410
 
8117
- # Specifies which fields to include in ProcessResponse's document.
8411
+ # Specifies which fields to include in ProcessResponse's document. Only supports
8412
+ # top level document and pages field so it must be in the form of ``
8413
+ # document_field_name`` or `pages.`page_field_name``.
8118
8414
  # Corresponds to the JSON property `fieldMask`
8119
8415
  # @return [String]
8120
8416
  attr_accessor :field_mask
@@ -8127,6 +8423,11 @@ module Google
8127
8423
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document]
8128
8424
  attr_accessor :inline_document
8129
8425
 
8426
+ # Options for Process API
8427
+ # Corresponds to the JSON property `processOptions`
8428
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessOptions]
8429
+ attr_accessor :process_options
8430
+
8130
8431
  # Payload message of raw document content (bytes).
8131
8432
  # Corresponds to the JSON property `rawDocument`
8132
8433
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3RawDocument]
@@ -8148,6 +8449,7 @@ module Google
8148
8449
  @document = args[:document] if args.key?(:document)
8149
8450
  @field_mask = args[:field_mask] if args.key?(:field_mask)
8150
8451
  @inline_document = args[:inline_document] if args.key?(:inline_document)
8452
+ @process_options = args[:process_options] if args.key?(:process_options)
8151
8453
  @raw_document = args[:raw_document] if args.key?(:raw_document)
8152
8454
  @skip_human_review = args[:skip_human_review] if args.key?(:skip_human_review)
8153
8455
  end
@@ -8233,8 +8535,8 @@ module Google
8233
8535
  # @return [String]
8234
8536
  attr_accessor :state
8235
8537
 
8236
- # The processor type, e.g., OCR_PROCESSOR, INVOICE_PROCESSOR, etc. To get a list
8237
- # of processors types, see FetchProcessorTypes.
8538
+ # The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc. To get a
8539
+ # list of processors types, see FetchProcessorTypes.
8238
8540
  # Corresponds to the JSON property `type`
8239
8541
  # @return [String]
8240
8542
  attr_accessor :type
@@ -8283,13 +8585,18 @@ module Google
8283
8585
  # @return [String]
8284
8586
  attr_accessor :launch_stage
8285
8587
 
8286
- # The resource name of the processor type. Format: projects/`project`/
8287
- # processorTypes/`processor_type`
8588
+ # The resource name of the processor type. Format: `projects/`project`/
8589
+ # processorTypes/`processor_type``
8288
8590
  # Corresponds to the JSON property `name`
8289
8591
  # @return [String]
8290
8592
  attr_accessor :name
8291
8593
 
8292
- # The type of the processor, e.g., "invoice_parsing".
8594
+ # A set of Cloud Storage URIs of sample documents for this processor.
8595
+ # Corresponds to the JSON property `sampleDocumentUris`
8596
+ # @return [Array<String>]
8597
+ attr_accessor :sample_document_uris
8598
+
8599
+ # The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc.
8293
8600
  # Corresponds to the JSON property `type`
8294
8601
  # @return [String]
8295
8602
  attr_accessor :type
@@ -8305,6 +8612,7 @@ module Google
8305
8612
  @category = args[:category] if args.key?(:category)
8306
8613
  @launch_stage = args[:launch_stage] if args.key?(:launch_stage)
8307
8614
  @name = args[:name] if args.key?(:name)
8615
+ @sample_document_uris = args[:sample_document_uris] if args.key?(:sample_document_uris)
8308
8616
  @type = args[:type] if args.key?(:type)
8309
8617
  end
8310
8618
  end
@@ -8351,6 +8659,11 @@ module Google
8351
8659
  # @return [String]
8352
8660
  attr_accessor :display_name
8353
8661
 
8662
+ # The schema defines the output of the processed document by a processor.
8663
+ # Corresponds to the JSON property `documentSchema`
8664
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentSchema]
8665
+ attr_accessor :document_schema
8666
+
8354
8667
  # Denotes that this ProcessorVersion is managed by google.
8355
8668
  # Corresponds to the JSON property `googleManaged`
8356
8669
  # @return [Boolean]
@@ -8388,6 +8701,7 @@ module Google
8388
8701
  @create_time = args[:create_time] if args.key?(:create_time)
8389
8702
  @deprecation_info = args[:deprecation_info] if args.key?(:deprecation_info)
8390
8703
  @display_name = args[:display_name] if args.key?(:display_name)
8704
+ @document_schema = args[:document_schema] if args.key?(:document_schema)
8391
8705
  @google_managed = args[:google_managed] if args.key?(:google_managed)
8392
8706
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
8393
8707
  @kms_key_version_name = args[:kms_key_version_name] if args.key?(:kms_key_version_name)
@@ -8421,38 +8735,6 @@ module Google
8421
8735
  end
8422
8736
  end
8423
8737
 
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
8738
  # Payload message of raw document content (bytes).
8457
8739
  class GoogleCloudDocumentaiV1beta3RawDocument
8458
8740
  include Google::Apis::Core::Hashable
@@ -8463,7 +8745,7 @@ module Google
8463
8745
  # @return [String]
8464
8746
  attr_accessor :content
8465
8747
 
8466
- # An IANA MIME type (RFC6838) indicating the nature and format of the [content].
8748
+ # An IANA MIME type (RFC6838) indicating the nature and format of the content.
8467
8749
  # Corresponds to the JSON property `mimeType`
8468
8750
  # @return [String]
8469
8751
  attr_accessor :mime_type
@@ -8664,6 +8946,167 @@ module Google
8664
8946
  end
8665
8947
  end
8666
8948
 
8949
+ # The metadata that represents a processor version being created.
8950
+ class GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata
8951
+ include Google::Apis::Core::Hashable
8952
+
8953
+ # The common metadata for long running operations.
8954
+ # Corresponds to the JSON property `commonMetadata`
8955
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
8956
+ attr_accessor :common_metadata
8957
+
8958
+ # The dataset validation information. This includes any and all errors with
8959
+ # documents and the dataset.
8960
+ # Corresponds to the JSON property `testDatasetValidation`
8961
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation]
8962
+ attr_accessor :test_dataset_validation
8963
+
8964
+ # The dataset validation information. This includes any and all errors with
8965
+ # documents and the dataset.
8966
+ # Corresponds to the JSON property `trainingDatasetValidation`
8967
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation]
8968
+ attr_accessor :training_dataset_validation
8969
+
8970
+ def initialize(**args)
8971
+ update!(**args)
8972
+ end
8973
+
8974
+ # Update properties of this object
8975
+ def update!(**args)
8976
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
8977
+ @test_dataset_validation = args[:test_dataset_validation] if args.key?(:test_dataset_validation)
8978
+ @training_dataset_validation = args[:training_dataset_validation] if args.key?(:training_dataset_validation)
8979
+ end
8980
+ end
8981
+
8982
+ # The dataset validation information. This includes any and all errors with
8983
+ # documents and the dataset.
8984
+ class GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation
8985
+ include Google::Apis::Core::Hashable
8986
+
8987
+ # The total number of dataset errors.
8988
+ # Corresponds to the JSON property `datasetErrorCount`
8989
+ # @return [Fixnum]
8990
+ attr_accessor :dataset_error_count
8991
+
8992
+ # Error information for the dataset as a whole. A maximum of 10 dataset errors
8993
+ # will be returned. A single dataset error is terminal for training.
8994
+ # Corresponds to the JSON property `datasetErrors`
8995
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleRpcStatus>]
8996
+ attr_accessor :dataset_errors
8997
+
8998
+ # The total number of document errors.
8999
+ # Corresponds to the JSON property `documentErrorCount`
9000
+ # @return [Fixnum]
9001
+ attr_accessor :document_error_count
9002
+
9003
+ # Error information pertaining to specific documents. A maximum of 10 document
9004
+ # errors will be returned. Any document with errors will not be used throughout
9005
+ # training.
9006
+ # Corresponds to the JSON property `documentErrors`
9007
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleRpcStatus>]
9008
+ attr_accessor :document_errors
9009
+
9010
+ def initialize(**args)
9011
+ update!(**args)
9012
+ end
9013
+
9014
+ # Update properties of this object
9015
+ def update!(**args)
9016
+ @dataset_error_count = args[:dataset_error_count] if args.key?(:dataset_error_count)
9017
+ @dataset_errors = args[:dataset_errors] if args.key?(:dataset_errors)
9018
+ @document_error_count = args[:document_error_count] if args.key?(:document_error_count)
9019
+ @document_errors = args[:document_errors] if args.key?(:document_errors)
9020
+ end
9021
+ end
9022
+
9023
+ # Request message for the create processor version method.
9024
+ class GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequest
9025
+ include Google::Apis::Core::Hashable
9026
+
9027
+ # Optional. The processor version to use as a base for training. This processor
9028
+ # version must be a child of `parent`. Format: `projects/`project`/locations/`
9029
+ # location`/processors/`processor`/processorVersions/`processorVersion``.
9030
+ # Corresponds to the JSON property `baseProcessorVersion`
9031
+ # @return [String]
9032
+ attr_accessor :base_processor_version
9033
+
9034
+ # The schema defines the output of the processed document by a processor.
9035
+ # Corresponds to the JSON property `documentSchema`
9036
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentSchema]
9037
+ attr_accessor :document_schema
9038
+
9039
+ # The input data used to train a new `ProcessorVersion`.
9040
+ # Corresponds to the JSON property `inputData`
9041
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestInputData]
9042
+ attr_accessor :input_data
9043
+
9044
+ # A processor version is an implementation of a processor. Each processor can
9045
+ # have multiple versions, pre-trained by Google internally or up-trained by the
9046
+ # customer. At a time, a processor can only have one default version version. So
9047
+ # the processor's behavior (when processing documents) is defined by a default
9048
+ # version
9049
+ # Corresponds to the JSON property `processorVersion`
9050
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessorVersion]
9051
+ attr_accessor :processor_version
9052
+
9053
+ def initialize(**args)
9054
+ update!(**args)
9055
+ end
9056
+
9057
+ # Update properties of this object
9058
+ def update!(**args)
9059
+ @base_processor_version = args[:base_processor_version] if args.key?(:base_processor_version)
9060
+ @document_schema = args[:document_schema] if args.key?(:document_schema)
9061
+ @input_data = args[:input_data] if args.key?(:input_data)
9062
+ @processor_version = args[:processor_version] if args.key?(:processor_version)
9063
+ end
9064
+ end
9065
+
9066
+ # The input data used to train a new `ProcessorVersion`.
9067
+ class GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestInputData
9068
+ include Google::Apis::Core::Hashable
9069
+
9070
+ # The common config to specify a set of documents used as input.
9071
+ # Corresponds to the JSON property `testDocuments`
9072
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig]
9073
+ attr_accessor :test_documents
9074
+
9075
+ # The common config to specify a set of documents used as input.
9076
+ # Corresponds to the JSON property `trainingDocuments`
9077
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig]
9078
+ attr_accessor :training_documents
9079
+
9080
+ def initialize(**args)
9081
+ update!(**args)
9082
+ end
9083
+
9084
+ # Update properties of this object
9085
+ def update!(**args)
9086
+ @test_documents = args[:test_documents] if args.key?(:test_documents)
9087
+ @training_documents = args[:training_documents] if args.key?(:training_documents)
9088
+ end
9089
+ end
9090
+
9091
+ # The response for the TrainProcessorVersion method.
9092
+ class GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse
9093
+ include Google::Apis::Core::Hashable
9094
+
9095
+ # The resource name of the processor version produced by training.
9096
+ # Corresponds to the JSON property `processorVersion`
9097
+ # @return [String]
9098
+ attr_accessor :processor_version
9099
+
9100
+ def initialize(**args)
9101
+ update!(**args)
9102
+ end
9103
+
9104
+ # Update properties of this object
9105
+ def update!(**args)
9106
+ @processor_version = args[:processor_version] if args.key?(:processor_version)
9107
+ end
9108
+ end
9109
+
8667
9110
  # The long running operation metadata for the undeploy processor version method.
8668
9111
  class GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata
8669
9112
  include Google::Apis::Core::Hashable