google-apis-documentai_v1 0.52.0 → 0.54.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::DocumentaiV1::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
@@ -1134,26 +1133,28 @@ module Google
1134
1133
  class GoogleCloudDocumentaiV1Barcode
1135
1134
  include Google::Apis::Core::Hashable
1136
1135
 
1137
- # Format of a barcode. The supported formats are: CODE_128: Code 128 type.
1138
- # CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type.
1139
- # DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8:
1140
- # EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type.
1141
- # PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type.
1136
+ # Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. -
1137
+ # `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type.
1138
+ # - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13
1139
+ # type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A
1140
+ # type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code
1141
+ # type. - `DATABAR`: GS1 DataBar code type.
1142
1142
  # Corresponds to the JSON property `format`
1143
1143
  # @return [String]
1144
1144
  attr_accessor :format
1145
1145
 
1146
- # Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://
1147
- # www.google.com;;'.
1146
+ # Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https:/
1147
+ # /www.google.com;;'`.
1148
1148
  # Corresponds to the JSON property `rawValue`
1149
1149
  # @return [String]
1150
1150
  attr_accessor :raw_value
1151
1151
 
1152
1152
  # Value format describes the format of the value that a barcode encodes. The
1153
- # supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address.
1154
- # ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS
1155
- # message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-
1156
- # localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license.
1153
+ # supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email
1154
+ # address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`:
1155
+ # Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `
1156
+ # WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`:
1157
+ # Calendar event. - `DRIVER_LICENSE`: Driver's license.
1157
1158
  # Corresponds to the JSON property `valueFormat`
1158
1159
  # @return [String]
1159
1160
  attr_accessor :value_format
@@ -1593,14 +1594,14 @@ module Google
1593
1594
  # @return [String]
1594
1595
  attr_accessor :text
1595
1596
 
1596
- # Placeholder. A list of text corrections made to [Document.text]. This is
1597
- # usually used for annotating corrections to OCR mistakes. Text changes for a
1598
- # given revision may not overlap with each other.
1597
+ # Placeholder. A list of text corrections made to Document.text. This is usually
1598
+ # used for annotating corrections to OCR mistakes. Text changes for a given
1599
+ # revision may not overlap with each other.
1599
1600
  # Corresponds to the JSON property `textChanges`
1600
1601
  # @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentTextChange>]
1601
1602
  attr_accessor :text_changes
1602
1603
 
1603
- # Placeholder. Styles for the Document.text.
1604
+ # Styles for the Document.text.
1604
1605
  # Corresponds to the JSON property `textStyles`
1605
1606
  # @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentStyle>]
1606
1607
  attr_accessor :text_styles
@@ -1640,7 +1641,7 @@ module Google
1640
1641
  class GoogleCloudDocumentaiV1DocumentEntity
1641
1642
  include Google::Apis::Core::Hashable
1642
1643
 
1643
- # Optional. Confidence of detected Schema entity. Range [0, 1].
1644
+ # Optional. Confidence of detected Schema entity. Range `[0, 1]`.
1644
1645
  # Corresponds to the JSON property `confidence`
1645
1646
  # @return [Float]
1646
1647
  attr_accessor :confidence
@@ -1793,8 +1794,8 @@ module Google
1793
1794
  # Optional. An optional field to store a normalized string. For some entity
1794
1795
  # types, one of respective `structured_value` fields may also be populated. Also
1795
1796
  # not all the types of `structured_value` will be normalized. For example, some
1796
- # processors may not generate float or int normalized text by default. Below are
1797
- # sample formats mapped to structured values. - Money/Currency type (`
1797
+ # processors may not generate `float` or `integer` normalized text by default.
1798
+ # Below are sample formats mapped to structured values. - Money/Currency type (`
1798
1799
  # money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in
1799
1800
  # the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO
1800
1801
  # 8601 text format.
@@ -1886,6 +1887,11 @@ module Google
1886
1887
  # @return [String]
1887
1888
  attr_accessor :gcs_uri
1888
1889
 
1890
+ # The sharding config for the output document.
1891
+ # Corresponds to the JSON property `shardingConfig`
1892
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig]
1893
+ attr_accessor :sharding_config
1894
+
1889
1895
  def initialize(**args)
1890
1896
  update!(**args)
1891
1897
  end
@@ -1894,6 +1900,32 @@ module Google
1894
1900
  def update!(**args)
1895
1901
  @field_mask = args[:field_mask] if args.key?(:field_mask)
1896
1902
  @gcs_uri = args[:gcs_uri] if args.key?(:gcs_uri)
1903
+ @sharding_config = args[:sharding_config] if args.key?(:sharding_config)
1904
+ end
1905
+ end
1906
+
1907
+ # The sharding config for the output document.
1908
+ class GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig
1909
+ include Google::Apis::Core::Hashable
1910
+
1911
+ # The number of overlapping pages between consecutive shards.
1912
+ # Corresponds to the JSON property `pagesOverlap`
1913
+ # @return [Fixnum]
1914
+ attr_accessor :pages_overlap
1915
+
1916
+ # The number of pages per shard.
1917
+ # Corresponds to the JSON property `pagesPerShard`
1918
+ # @return [Fixnum]
1919
+ attr_accessor :pages_per_shard
1920
+
1921
+ def initialize(**args)
1922
+ update!(**args)
1923
+ end
1924
+
1925
+ # Update properties of this object
1926
+ def update!(**args)
1927
+ @pages_overlap = args[:pages_overlap] if args.key?(:pages_overlap)
1928
+ @pages_per_shard = args[:pages_per_shard] if args.key?(:pages_per_shard)
1897
1929
  end
1898
1930
  end
1899
1931
 
@@ -2050,7 +2082,7 @@ module Google
2050
2082
  # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BoundingPoly]
2051
2083
  attr_accessor :bounding_poly
2052
2084
 
2053
- # Optional. Confidence of detected page element, if applicable. Range [0, 1].
2085
+ # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
2054
2086
  # Corresponds to the JSON property `confidence`
2055
2087
  # @return [Float]
2056
2088
  attr_accessor :confidence
@@ -2065,10 +2097,10 @@ module Google
2065
2097
  # @return [String]
2066
2098
  attr_accessor :layout_type
2067
2099
 
2068
- # Required. Index into the Document.pages element, for example using Document.
2069
- # pages to locate the related page element. This field is skipped when its value
2070
- # is the default 0. See https://developers.google.com/protocol-buffers/docs/
2071
- # proto3#json.
2100
+ # Required. Index into the Document.pages element, for example using `Document.
2101
+ # pages` to locate the related page element. This field is skipped when its
2102
+ # value is the default `0`. See https://developers.google.com/protocol-buffers/
2103
+ # docs/proto3#json.
2072
2104
  # Corresponds to the JSON property `page`
2073
2105
  # @return [Fixnum]
2074
2106
  attr_accessor :page
@@ -2149,12 +2181,12 @@ module Google
2149
2181
  class GoogleCloudDocumentaiV1DocumentPageDetectedLanguage
2150
2182
  include Google::Apis::Core::Hashable
2151
2183
 
2152
- # Confidence of detected language. Range [0, 1].
2184
+ # Confidence of detected language. Range `[0, 1]`.
2153
2185
  # Corresponds to the JSON property `confidence`
2154
2186
  # @return [Float]
2155
2187
  attr_accessor :confidence
2156
2188
 
2157
- # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information,
2189
+ # The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information,
2158
2190
  # see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
2159
2191
  # Corresponds to the JSON property `languageCode`
2160
2192
  # @return [String]
@@ -2247,8 +2279,8 @@ module Google
2247
2279
  attr_accessor :value_detected_languages
2248
2280
 
2249
2281
  # If the value is non-textual, this field represents the type. Current valid
2250
- # values are: - blank (this indicates the field_value is normal text) - "
2251
- # unfilled_checkbox" - "filled_checkbox"
2282
+ # values are: - blank (this indicates the `field_value` is normal text) - `
2283
+ # unfilled_checkbox` - `filled_checkbox`
2252
2284
  # Corresponds to the JSON property `valueType`
2253
2285
  # @return [String]
2254
2286
  attr_accessor :value_type
@@ -2317,7 +2349,7 @@ module Google
2317
2349
  # @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect>]
2318
2350
  attr_accessor :detected_defects
2319
2351
 
2320
- # The overall quality score. Range [0, 1] where 1 is perfect quality.
2352
+ # The overall quality score. Range `[0, 1]` where 1 is perfect quality.
2321
2353
  # Corresponds to the JSON property `qualityScore`
2322
2354
  # @return [Float]
2323
2355
  attr_accessor :quality_score
@@ -2337,16 +2369,16 @@ module Google
2337
2369
  class GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect
2338
2370
  include Google::Apis::Core::Hashable
2339
2371
 
2340
- # Confidence of detected defect. Range [0, 1] where 1 indicates strong
2372
+ # Confidence of detected defect. Range `[0, 1]` where 1 indicates strong
2341
2373
  # confidence of that the defect exists.
2342
2374
  # Corresponds to the JSON property `confidence`
2343
2375
  # @return [Float]
2344
2376
  attr_accessor :confidence
2345
2377
 
2346
- # Name of the defect type. Supported values are "quality/defect_blurry", "
2347
- # quality/defect_noisy", "quality/defect_dark", "quality/defect_faint", "quality/
2348
- # defect_text_too_small", "quality/defect_document_cutoff", "quality/
2349
- # defect_text_cutoff", "quality/defect_glare"
2378
+ # Name of the defect type. Supported values are: - `quality/defect_blurry` - `
2379
+ # quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `
2380
+ # quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/
2381
+ # defect_text_cutoff` - `quality/defect_glare`
2350
2382
  # Corresponds to the JSON property `type`
2351
2383
  # @return [String]
2352
2384
  attr_accessor :type
@@ -2373,7 +2405,7 @@ module Google
2373
2405
 
2374
2406
  # Confidence of the current Layout within context of the object this layout is
2375
2407
  # for. e.g. confidence can be for a single token, a table, a visual element, etc.
2376
- # depending on context. Range [0, 1].
2408
+ # depending on context. Range `[0, 1]`.
2377
2409
  # Corresponds to the JSON property `confidence`
2378
2410
  # @return [Float]
2379
2411
  attr_accessor :confidence
@@ -2932,24 +2964,19 @@ module Google
2932
2964
  # @return [String]
2933
2965
  attr_accessor :display_name
2934
2966
 
2935
- # Metadata about an entity type.
2936
- # Corresponds to the JSON property `entityTypeMetadata`
2937
- # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EntityTypeMetadata]
2938
- attr_accessor :entity_type_metadata
2939
-
2940
2967
  # Defines the a list of enum values.
2941
2968
  # Corresponds to the JSON property `enumValues`
2942
2969
  # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues]
2943
2970
  attr_accessor :enum_values
2944
2971
 
2945
2972
  # Name of the type. It must be unique within the schema file and cannot be a '
2946
- # Common Type'. Besides that we use the following naming conventions: - *use
2947
- # snake_casing* - name matching is case-insensitive - Maximum 64 characters. -
2973
+ # Common Type'. Besides that we use the following naming conventions: - *use `
2974
+ # snake_casing`* - name matching is case-sensitive - Maximum 64 characters. -
2948
2975
  # Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (
2949
2976
  # For backward compatibility internal infrastructure and tooling can handle any
2950
- # ascii character) - The '/' is sometimes used to denote a property of a type.
2951
- # For example line_item/amount. This convention is deprecated, but will still be
2952
- # honored for backward compatibility.
2977
+ # ascii character) - The `/` is sometimes used to denote a property of a type.
2978
+ # For example `line_item/amount`. This convention is deprecated, but will still
2979
+ # be honored for backward compatibility.
2953
2980
  # Corresponds to the JSON property `name`
2954
2981
  # @return [String]
2955
2982
  attr_accessor :name
@@ -2967,7 +2994,6 @@ module Google
2967
2994
  def update!(**args)
2968
2995
  @base_types = args[:base_types] if args.key?(:base_types)
2969
2996
  @display_name = args[:display_name] if args.key?(:display_name)
2970
- @entity_type_metadata = args[:entity_type_metadata] if args.key?(:entity_type_metadata)
2971
2997
  @enum_values = args[:enum_values] if args.key?(:enum_values)
2972
2998
  @name = args[:name] if args.key?(:name)
2973
2999
  @properties = args[:properties] if args.key?(:properties)
@@ -3008,11 +3034,6 @@ module Google
3008
3034
  # @return [String]
3009
3035
  attr_accessor :occurrence_type
3010
3036
 
3011
- # Metadata about a property.
3012
- # Corresponds to the JSON property `propertyMetadata`
3013
- # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1PropertyMetadata]
3014
- attr_accessor :property_metadata
3015
-
3016
3037
  # A reference to the value type of the property. This type is subject to the
3017
3038
  # same conventions as the `Entity.base_types` field.
3018
3039
  # Corresponds to the JSON property `valueType`
@@ -3027,7 +3048,6 @@ module Google
3027
3048
  def update!(**args)
3028
3049
  @name = args[:name] if args.key?(:name)
3029
3050
  @occurrence_type = args[:occurrence_type] if args.key?(:occurrence_type)
3030
- @property_metadata = args[:property_metadata] if args.key?(:property_metadata)
3031
3051
  @value_type = args[:value_type] if args.key?(:value_type)
3032
3052
  end
3033
3053
  end
@@ -3213,7 +3233,7 @@ module Google
3213
3233
  # @return [Google::Apis::DocumentaiV1::GoogleTypeColor]
3214
3234
  attr_accessor :color
3215
3235
 
3216
- # Font family such as "Arial", "Times New Roman". https://www.w3schools.com/
3236
+ # Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/
3217
3237
  # cssref/pr_font_font-family.asp
3218
3238
  # Corresponds to the JSON property `fontFamily`
3219
3239
  # @return [String]
@@ -3419,26 +3439,6 @@ module Google
3419
3439
  end
3420
3440
  end
3421
3441
 
3422
- # Metadata about an entity type.
3423
- class GoogleCloudDocumentaiV1EntityTypeMetadata
3424
- include Google::Apis::Core::Hashable
3425
-
3426
- # Whether the entity type should be considered as "inactive".
3427
- # Corresponds to the JSON property `inactive`
3428
- # @return [Boolean]
3429
- attr_accessor :inactive
3430
- alias_method :inactive?, :inactive
3431
-
3432
- def initialize(**args)
3433
- update!(**args)
3434
- end
3435
-
3436
- # Update properties of this object
3437
- def update!(**args)
3438
- @inactive = args[:inactive] if args.key?(:inactive)
3439
- end
3440
- end
3441
-
3442
3442
  # Response message for fetch processor types.
3443
3443
  class GoogleCloudDocumentaiV1FetchProcessorTypesResponse
3444
3444
  include Google::Apis::Core::Hashable
@@ -3771,8 +3771,8 @@ module Google
3771
3771
  # @return [String]
3772
3772
  attr_accessor :state
3773
3773
 
3774
- # The processor type, e.g., OCR_PROCESSOR, INVOICE_PROCESSOR, etc. To get a list
3775
- # of processors types, see FetchProcessorTypes.
3774
+ # The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc. To get a
3775
+ # list of processors types, see FetchProcessorTypes.
3776
3776
  # Corresponds to the JSON property `type`
3777
3777
  # @return [String]
3778
3778
  attr_accessor :type
@@ -3821,13 +3821,18 @@ module Google
3821
3821
  # @return [String]
3822
3822
  attr_accessor :launch_stage
3823
3823
 
3824
- # The resource name of the processor type. Format: projects/`project`/
3825
- # processorTypes/`processor_type`
3824
+ # The resource name of the processor type. Format: `projects/`project`/
3825
+ # processorTypes/`processor_type``
3826
3826
  # Corresponds to the JSON property `name`
3827
3827
  # @return [String]
3828
3828
  attr_accessor :name
3829
3829
 
3830
- # The type of the processor, e.g., "invoice_parsing".
3830
+ # A set of Cloud Storage URIs of sample documents for this processor.
3831
+ # Corresponds to the JSON property `sampleDocumentUris`
3832
+ # @return [Array<String>]
3833
+ attr_accessor :sample_document_uris
3834
+
3835
+ # The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc.
3831
3836
  # Corresponds to the JSON property `type`
3832
3837
  # @return [String]
3833
3838
  attr_accessor :type
@@ -3843,6 +3848,7 @@ module Google
3843
3848
  @category = args[:category] if args.key?(:category)
3844
3849
  @launch_stage = args[:launch_stage] if args.key?(:launch_stage)
3845
3850
  @name = args[:name] if args.key?(:name)
3851
+ @sample_document_uris = args[:sample_document_uris] if args.key?(:sample_document_uris)
3846
3852
  @type = args[:type] if args.key?(:type)
3847
3853
  end
3848
3854
  end
@@ -3965,26 +3971,6 @@ module Google
3965
3971
  end
3966
3972
  end
3967
3973
 
3968
- # Metadata about a property.
3969
- class GoogleCloudDocumentaiV1PropertyMetadata
3970
- include Google::Apis::Core::Hashable
3971
-
3972
- # Whether the property should be considered as "inactive".
3973
- # Corresponds to the JSON property `inactive`
3974
- # @return [Boolean]
3975
- attr_accessor :inactive
3976
- alias_method :inactive?, :inactive
3977
-
3978
- def initialize(**args)
3979
- update!(**args)
3980
- end
3981
-
3982
- # Update properties of this object
3983
- def update!(**args)
3984
- @inactive = args[:inactive] if args.key?(:inactive)
3985
- end
3986
- end
3987
-
3988
3974
  # Payload message of raw document content (bytes).
3989
3975
  class GoogleCloudDocumentaiV1RawDocument
3990
3976
  include Google::Apis::Core::Hashable
@@ -3995,7 +3981,7 @@ module Google
3995
3981
  # @return [String]
3996
3982
  attr_accessor :content
3997
3983
 
3998
- # An IANA MIME type (RFC6838) indicating the nature and format of the [content].
3984
+ # An IANA MIME type (RFC6838) indicating the nature and format of the content.
3999
3985
  # Corresponds to the JSON property `mimeType`
4000
3986
  # @return [String]
4001
3987
  attr_accessor :mime_type
@@ -4233,92 +4219,32 @@ module Google
4233
4219
  end
4234
4220
  end
4235
4221
 
4236
- # The long running operation metadata for AnalyzeHitlData.
4237
- class GoogleCloudDocumentaiV1alpha1AnalyzeHitlDataMetadata
4238
- include Google::Apis::Core::Hashable
4239
-
4240
- # The common metadata for long running operations.
4241
- # Corresponds to the JSON property `commonMetadata`
4242
- # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1alpha1CommonOperationMetadata]
4243
- attr_accessor :common_metadata
4244
-
4245
- def initialize(**args)
4246
- update!(**args)
4247
- end
4248
-
4249
- # Update properties of this object
4250
- def update!(**args)
4251
- @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
4252
- end
4253
- end
4254
-
4255
- # The common metadata for long running operations.
4256
- class GoogleCloudDocumentaiV1alpha1CommonOperationMetadata
4257
- include Google::Apis::Core::Hashable
4258
-
4259
- # The creation time of the operation.
4260
- # Corresponds to the JSON property `createTime`
4261
- # @return [String]
4262
- attr_accessor :create_time
4263
-
4264
- # A related resource to this operation.
4265
- # Corresponds to the JSON property `resource`
4266
- # @return [String]
4267
- attr_accessor :resource
4268
-
4269
- # The state of the operation.
4270
- # Corresponds to the JSON property `state`
4271
- # @return [String]
4272
- attr_accessor :state
4273
-
4274
- # A message providing more details about the current state of processing.
4275
- # Corresponds to the JSON property `stateMessage`
4276
- # @return [String]
4277
- attr_accessor :state_message
4278
-
4279
- # The last update time of the operation.
4280
- # Corresponds to the JSON property `updateTime`
4281
- # @return [String]
4282
- attr_accessor :update_time
4283
-
4284
- def initialize(**args)
4285
- update!(**args)
4286
- end
4287
-
4288
- # Update properties of this object
4289
- def update!(**args)
4290
- @create_time = args[:create_time] if args.key?(:create_time)
4291
- @resource = args[:resource] if args.key?(:resource)
4292
- @state = args[:state] if args.key?(:state)
4293
- @state_message = args[:state_message] if args.key?(:state_message)
4294
- @update_time = args[:update_time] if args.key?(:update_time)
4295
- end
4296
- end
4297
-
4298
4222
  # Encodes the detailed information of a barcode.
4299
4223
  class GoogleCloudDocumentaiV1beta1Barcode
4300
4224
  include Google::Apis::Core::Hashable
4301
4225
 
4302
- # Format of a barcode. The supported formats are: CODE_128: Code 128 type.
4303
- # CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type.
4304
- # DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8:
4305
- # EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type.
4306
- # PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type.
4226
+ # Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. -
4227
+ # `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type.
4228
+ # - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13
4229
+ # type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A
4230
+ # type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code
4231
+ # type. - `DATABAR`: GS1 DataBar code type.
4307
4232
  # Corresponds to the JSON property `format`
4308
4233
  # @return [String]
4309
4234
  attr_accessor :format
4310
4235
 
4311
- # Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://
4312
- # www.google.com;;'.
4236
+ # Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https:/
4237
+ # /www.google.com;;'`.
4313
4238
  # Corresponds to the JSON property `rawValue`
4314
4239
  # @return [String]
4315
4240
  attr_accessor :raw_value
4316
4241
 
4317
4242
  # Value format describes the format of the value that a barcode encodes. The
4318
- # supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address.
4319
- # ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS
4320
- # message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-
4321
- # localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license.
4243
+ # supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email
4244
+ # address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`:
4245
+ # Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `
4246
+ # WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`:
4247
+ # Calendar event. - `DRIVER_LICENSE`: Driver's license.
4322
4248
  # Corresponds to the JSON property `valueFormat`
4323
4249
  # @return [String]
4324
4250
  attr_accessor :value_format
@@ -4444,14 +4370,14 @@ module Google
4444
4370
  # @return [String]
4445
4371
  attr_accessor :text
4446
4372
 
4447
- # Placeholder. A list of text corrections made to [Document.text]. This is
4448
- # usually used for annotating corrections to OCR mistakes. Text changes for a
4449
- # given revision may not overlap with each other.
4373
+ # Placeholder. A list of text corrections made to Document.text. This is usually
4374
+ # used for annotating corrections to OCR mistakes. Text changes for a given
4375
+ # revision may not overlap with each other.
4450
4376
  # Corresponds to the JSON property `textChanges`
4451
4377
  # @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentTextChange>]
4452
4378
  attr_accessor :text_changes
4453
4379
 
4454
- # Placeholder. Styles for the Document.text.
4380
+ # Styles for the Document.text.
4455
4381
  # Corresponds to the JSON property `textStyles`
4456
4382
  # @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentStyle>]
4457
4383
  attr_accessor :text_styles
@@ -4491,7 +4417,7 @@ module Google
4491
4417
  class GoogleCloudDocumentaiV1beta1DocumentEntity
4492
4418
  include Google::Apis::Core::Hashable
4493
4419
 
4494
- # Optional. Confidence of detected Schema entity. Range [0, 1].
4420
+ # Optional. Confidence of detected Schema entity. Range `[0, 1]`.
4495
4421
  # Corresponds to the JSON property `confidence`
4496
4422
  # @return [Float]
4497
4423
  attr_accessor :confidence
@@ -4644,8 +4570,8 @@ module Google
4644
4570
  # Optional. An optional field to store a normalized string. For some entity
4645
4571
  # types, one of respective `structured_value` fields may also be populated. Also
4646
4572
  # not all the types of `structured_value` will be normalized. For example, some
4647
- # processors may not generate float or int normalized text by default. Below are
4648
- # sample formats mapped to structured values. - Money/Currency type (`
4573
+ # processors may not generate `float` or `integer` normalized text by default.
4574
+ # Below are sample formats mapped to structured values. - Money/Currency type (`
4649
4575
  # money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in
4650
4576
  # the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO
4651
4577
  # 8601 text format.
@@ -4854,7 +4780,7 @@ module Google
4854
4780
  # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1BoundingPoly]
4855
4781
  attr_accessor :bounding_poly
4856
4782
 
4857
- # Optional. Confidence of detected page element, if applicable. Range [0, 1].
4783
+ # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
4858
4784
  # Corresponds to the JSON property `confidence`
4859
4785
  # @return [Float]
4860
4786
  attr_accessor :confidence
@@ -4869,10 +4795,10 @@ module Google
4869
4795
  # @return [String]
4870
4796
  attr_accessor :layout_type
4871
4797
 
4872
- # Required. Index into the Document.pages element, for example using Document.
4873
- # pages to locate the related page element. This field is skipped when its value
4874
- # is the default 0. See https://developers.google.com/protocol-buffers/docs/
4875
- # proto3#json.
4798
+ # Required. Index into the Document.pages element, for example using `Document.
4799
+ # pages` to locate the related page element. This field is skipped when its
4800
+ # value is the default `0`. See https://developers.google.com/protocol-buffers/
4801
+ # docs/proto3#json.
4876
4802
  # Corresponds to the JSON property `page`
4877
4803
  # @return [Fixnum]
4878
4804
  attr_accessor :page
@@ -4953,12 +4879,12 @@ module Google
4953
4879
  class GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage
4954
4880
  include Google::Apis::Core::Hashable
4955
4881
 
4956
- # Confidence of detected language. Range [0, 1].
4882
+ # Confidence of detected language. Range `[0, 1]`.
4957
4883
  # Corresponds to the JSON property `confidence`
4958
4884
  # @return [Float]
4959
4885
  attr_accessor :confidence
4960
4886
 
4961
- # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information,
4887
+ # The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information,
4962
4888
  # see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
4963
4889
  # Corresponds to the JSON property `languageCode`
4964
4890
  # @return [String]
@@ -5051,8 +4977,8 @@ module Google
5051
4977
  attr_accessor :value_detected_languages
5052
4978
 
5053
4979
  # If the value is non-textual, this field represents the type. Current valid
5054
- # values are: - blank (this indicates the field_value is normal text) - "
5055
- # unfilled_checkbox" - "filled_checkbox"
4980
+ # values are: - blank (this indicates the `field_value` is normal text) - `
4981
+ # unfilled_checkbox` - `filled_checkbox`
5056
4982
  # Corresponds to the JSON property `valueType`
5057
4983
  # @return [String]
5058
4984
  attr_accessor :value_type
@@ -5121,7 +5047,7 @@ module Google
5121
5047
  # @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect>]
5122
5048
  attr_accessor :detected_defects
5123
5049
 
5124
- # The overall quality score. Range [0, 1] where 1 is perfect quality.
5050
+ # The overall quality score. Range `[0, 1]` where 1 is perfect quality.
5125
5051
  # Corresponds to the JSON property `qualityScore`
5126
5052
  # @return [Float]
5127
5053
  attr_accessor :quality_score
@@ -5141,16 +5067,16 @@ module Google
5141
5067
  class GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect
5142
5068
  include Google::Apis::Core::Hashable
5143
5069
 
5144
- # Confidence of detected defect. Range [0, 1] where 1 indicates strong
5070
+ # Confidence of detected defect. Range `[0, 1]` where 1 indicates strong
5145
5071
  # confidence of that the defect exists.
5146
5072
  # Corresponds to the JSON property `confidence`
5147
5073
  # @return [Float]
5148
5074
  attr_accessor :confidence
5149
5075
 
5150
- # Name of the defect type. Supported values are "quality/defect_blurry", "
5151
- # quality/defect_noisy", "quality/defect_dark", "quality/defect_faint", "quality/
5152
- # defect_text_too_small", "quality/defect_document_cutoff", "quality/
5153
- # defect_text_cutoff", "quality/defect_glare"
5076
+ # Name of the defect type. Supported values are: - `quality/defect_blurry` - `
5077
+ # quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `
5078
+ # quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/
5079
+ # defect_text_cutoff` - `quality/defect_glare`
5154
5080
  # Corresponds to the JSON property `type`
5155
5081
  # @return [String]
5156
5082
  attr_accessor :type
@@ -5177,7 +5103,7 @@ module Google
5177
5103
 
5178
5104
  # Confidence of the current Layout within context of the object this layout is
5179
5105
  # for. e.g. confidence can be for a single token, a table, a visual element, etc.
5180
- # depending on context. Range [0, 1].
5106
+ # depending on context. Range `[0, 1]`.
5181
5107
  # Corresponds to the JSON property `confidence`
5182
5108
  # @return [Float]
5183
5109
  attr_accessor :confidence
@@ -5818,7 +5744,7 @@ module Google
5818
5744
  # @return [Google::Apis::DocumentaiV1::GoogleTypeColor]
5819
5745
  attr_accessor :color
5820
5746
 
5821
- # Font family such as "Arial", "Times New Roman". https://www.w3schools.com/
5747
+ # Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/
5822
5748
  # cssref/pr_font_font-family.asp
5823
5749
  # Corresponds to the JSON property `fontFamily`
5824
5750
  # @return [String]
@@ -6195,26 +6121,28 @@ module Google
6195
6121
  class GoogleCloudDocumentaiV1beta2Barcode
6196
6122
  include Google::Apis::Core::Hashable
6197
6123
 
6198
- # Format of a barcode. The supported formats are: CODE_128: Code 128 type.
6199
- # CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type.
6200
- # DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8:
6201
- # EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type.
6202
- # PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type.
6124
+ # Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. -
6125
+ # `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type.
6126
+ # - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13
6127
+ # type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A
6128
+ # type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code
6129
+ # type. - `DATABAR`: GS1 DataBar code type.
6203
6130
  # Corresponds to the JSON property `format`
6204
6131
  # @return [String]
6205
6132
  attr_accessor :format
6206
6133
 
6207
- # Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://
6208
- # www.google.com;;'.
6134
+ # Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https:/
6135
+ # /www.google.com;;'`.
6209
6136
  # Corresponds to the JSON property `rawValue`
6210
6137
  # @return [String]
6211
6138
  attr_accessor :raw_value
6212
6139
 
6213
6140
  # Value format describes the format of the value that a barcode encodes. The
6214
- # supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address.
6215
- # ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS
6216
- # message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-
6217
- # localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license.
6141
+ # supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email
6142
+ # address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`:
6143
+ # Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `
6144
+ # WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`:
6145
+ # Calendar event. - `DRIVER_LICENSE`: Driver's license.
6218
6146
  # Corresponds to the JSON property `valueFormat`
6219
6147
  # @return [String]
6220
6148
  attr_accessor :value_format
@@ -6345,14 +6273,14 @@ module Google
6345
6273
  # @return [String]
6346
6274
  attr_accessor :text
6347
6275
 
6348
- # Placeholder. A list of text corrections made to [Document.text]. This is
6349
- # usually used for annotating corrections to OCR mistakes. Text changes for a
6350
- # given revision may not overlap with each other.
6276
+ # Placeholder. A list of text corrections made to Document.text. This is usually
6277
+ # used for annotating corrections to OCR mistakes. Text changes for a given
6278
+ # revision may not overlap with each other.
6351
6279
  # Corresponds to the JSON property `textChanges`
6352
6280
  # @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentTextChange>]
6353
6281
  attr_accessor :text_changes
6354
6282
 
6355
- # Placeholder. Styles for the Document.text.
6283
+ # Styles for the Document.text.
6356
6284
  # Corresponds to the JSON property `textStyles`
6357
6285
  # @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentStyle>]
6358
6286
  attr_accessor :text_styles
@@ -6393,7 +6321,7 @@ module Google
6393
6321
  class GoogleCloudDocumentaiV1beta2DocumentEntity
6394
6322
  include Google::Apis::Core::Hashable
6395
6323
 
6396
- # Optional. Confidence of detected Schema entity. Range [0, 1].
6324
+ # Optional. Confidence of detected Schema entity. Range `[0, 1]`.
6397
6325
  # Corresponds to the JSON property `confidence`
6398
6326
  # @return [Float]
6399
6327
  attr_accessor :confidence
@@ -6546,8 +6474,8 @@ module Google
6546
6474
  # Optional. An optional field to store a normalized string. For some entity
6547
6475
  # types, one of respective `structured_value` fields may also be populated. Also
6548
6476
  # not all the types of `structured_value` will be normalized. For example, some
6549
- # processors may not generate float or int normalized text by default. Below are
6550
- # sample formats mapped to structured values. - Money/Currency type (`
6477
+ # processors may not generate `float` or `integer` normalized text by default.
6478
+ # Below are sample formats mapped to structured values. - Money/Currency type (`
6551
6479
  # money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in
6552
6480
  # the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO
6553
6481
  # 8601 text format.
@@ -6793,7 +6721,7 @@ module Google
6793
6721
  # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2BoundingPoly]
6794
6722
  attr_accessor :bounding_poly
6795
6723
 
6796
- # Optional. Confidence of detected page element, if applicable. Range [0, 1].
6724
+ # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
6797
6725
  # Corresponds to the JSON property `confidence`
6798
6726
  # @return [Float]
6799
6727
  attr_accessor :confidence
@@ -6808,10 +6736,10 @@ module Google
6808
6736
  # @return [String]
6809
6737
  attr_accessor :layout_type
6810
6738
 
6811
- # Required. Index into the Document.pages element, for example using Document.
6812
- # pages to locate the related page element. This field is skipped when its value
6813
- # is the default 0. See https://developers.google.com/protocol-buffers/docs/
6814
- # proto3#json.
6739
+ # Required. Index into the Document.pages element, for example using `Document.
6740
+ # pages` to locate the related page element. This field is skipped when its
6741
+ # value is the default `0`. See https://developers.google.com/protocol-buffers/
6742
+ # docs/proto3#json.
6815
6743
  # Corresponds to the JSON property `page`
6816
6744
  # @return [Fixnum]
6817
6745
  attr_accessor :page
@@ -6892,12 +6820,12 @@ module Google
6892
6820
  class GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage
6893
6821
  include Google::Apis::Core::Hashable
6894
6822
 
6895
- # Confidence of detected language. Range [0, 1].
6823
+ # Confidence of detected language. Range `[0, 1]`.
6896
6824
  # Corresponds to the JSON property `confidence`
6897
6825
  # @return [Float]
6898
6826
  attr_accessor :confidence
6899
6827
 
6900
- # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information,
6828
+ # The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information,
6901
6829
  # see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
6902
6830
  # Corresponds to the JSON property `languageCode`
6903
6831
  # @return [String]
@@ -6990,8 +6918,8 @@ module Google
6990
6918
  attr_accessor :value_detected_languages
6991
6919
 
6992
6920
  # If the value is non-textual, this field represents the type. Current valid
6993
- # values are: - blank (this indicates the field_value is normal text) - "
6994
- # unfilled_checkbox" - "filled_checkbox"
6921
+ # values are: - blank (this indicates the `field_value` is normal text) - `
6922
+ # unfilled_checkbox` - `filled_checkbox`
6995
6923
  # Corresponds to the JSON property `valueType`
6996
6924
  # @return [String]
6997
6925
  attr_accessor :value_type
@@ -7060,7 +6988,7 @@ module Google
7060
6988
  # @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect>]
7061
6989
  attr_accessor :detected_defects
7062
6990
 
7063
- # The overall quality score. Range [0, 1] where 1 is perfect quality.
6991
+ # The overall quality score. Range `[0, 1]` where 1 is perfect quality.
7064
6992
  # Corresponds to the JSON property `qualityScore`
7065
6993
  # @return [Float]
7066
6994
  attr_accessor :quality_score
@@ -7080,16 +7008,16 @@ module Google
7080
7008
  class GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect
7081
7009
  include Google::Apis::Core::Hashable
7082
7010
 
7083
- # Confidence of detected defect. Range [0, 1] where 1 indicates strong
7011
+ # Confidence of detected defect. Range `[0, 1]` where 1 indicates strong
7084
7012
  # confidence of that the defect exists.
7085
7013
  # Corresponds to the JSON property `confidence`
7086
7014
  # @return [Float]
7087
7015
  attr_accessor :confidence
7088
7016
 
7089
- # Name of the defect type. Supported values are "quality/defect_blurry", "
7090
- # quality/defect_noisy", "quality/defect_dark", "quality/defect_faint", "quality/
7091
- # defect_text_too_small", "quality/defect_document_cutoff", "quality/
7092
- # defect_text_cutoff", "quality/defect_glare"
7017
+ # Name of the defect type. Supported values are: - `quality/defect_blurry` - `
7018
+ # quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `
7019
+ # quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/
7020
+ # defect_text_cutoff` - `quality/defect_glare`
7093
7021
  # Corresponds to the JSON property `type`
7094
7022
  # @return [String]
7095
7023
  attr_accessor :type
@@ -7116,7 +7044,7 @@ module Google
7116
7044
 
7117
7045
  # Confidence of the current Layout within context of the object this layout is
7118
7046
  # for. e.g. confidence can be for a single token, a table, a visual element, etc.
7119
- # depending on context. Range [0, 1].
7047
+ # depending on context. Range `[0, 1]`.
7120
7048
  # Corresponds to the JSON property `confidence`
7121
7049
  # @return [Float]
7122
7050
  attr_accessor :confidence
@@ -7757,7 +7685,7 @@ module Google
7757
7685
  # @return [Google::Apis::DocumentaiV1::GoogleTypeColor]
7758
7686
  attr_accessor :color
7759
7687
 
7760
- # Font family such as "Arial", "Times New Roman". https://www.w3schools.com/
7688
+ # Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/
7761
7689
  # cssref/pr_font_font-family.asp
7762
7690
  # Corresponds to the JSON property `fontFamily`
7763
7691
  # @return [String]
@@ -8431,6 +8359,44 @@ module Google
8431
8359
  end
8432
8360
  end
8433
8361
 
8362
+ # Metadata of the EvaluateProcessorVersion method.
8363
+ class GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata
8364
+ include Google::Apis::Core::Hashable
8365
+
8366
+ # The common metadata for long running operations.
8367
+ # Corresponds to the JSON property `commonMetadata`
8368
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
8369
+ attr_accessor :common_metadata
8370
+
8371
+ def initialize(**args)
8372
+ update!(**args)
8373
+ end
8374
+
8375
+ # Update properties of this object
8376
+ def update!(**args)
8377
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
8378
+ end
8379
+ end
8380
+
8381
+ # Metadata of the EvaluateProcessorVersion method.
8382
+ class GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse
8383
+ include Google::Apis::Core::Hashable
8384
+
8385
+ # The resource name of the created evaluation.
8386
+ # Corresponds to the JSON property `evaluation`
8387
+ # @return [String]
8388
+ attr_accessor :evaluation
8389
+
8390
+ def initialize(**args)
8391
+ update!(**args)
8392
+ end
8393
+
8394
+ # Update properties of this object
8395
+ def update!(**args)
8396
+ @evaluation = args[:evaluation] if args.key?(:evaluation)
8397
+ end
8398
+ end
8399
+
8434
8400
  # The status of human review on a processed document.
8435
8401
  class GoogleCloudDocumentaiV1beta3HumanReviewStatus
8436
8402
  include Google::Apis::Core::Hashable
@@ -8579,6 +8545,99 @@ module Google
8579
8545
  end
8580
8546
  end
8581
8547
 
8548
+ # The metadata that represents a processor version being created.
8549
+ class GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata
8550
+ include Google::Apis::Core::Hashable
8551
+
8552
+ # The common metadata for long running operations.
8553
+ # Corresponds to the JSON property `commonMetadata`
8554
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
8555
+ attr_accessor :common_metadata
8556
+
8557
+ # The dataset validation information. This includes any and all errors with
8558
+ # documents and the dataset.
8559
+ # Corresponds to the JSON property `testDatasetValidation`
8560
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation]
8561
+ attr_accessor :test_dataset_validation
8562
+
8563
+ # The dataset validation information. This includes any and all errors with
8564
+ # documents and the dataset.
8565
+ # Corresponds to the JSON property `trainingDatasetValidation`
8566
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation]
8567
+ attr_accessor :training_dataset_validation
8568
+
8569
+ def initialize(**args)
8570
+ update!(**args)
8571
+ end
8572
+
8573
+ # Update properties of this object
8574
+ def update!(**args)
8575
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
8576
+ @test_dataset_validation = args[:test_dataset_validation] if args.key?(:test_dataset_validation)
8577
+ @training_dataset_validation = args[:training_dataset_validation] if args.key?(:training_dataset_validation)
8578
+ end
8579
+ end
8580
+
8581
+ # The dataset validation information. This includes any and all errors with
8582
+ # documents and the dataset.
8583
+ class GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation
8584
+ include Google::Apis::Core::Hashable
8585
+
8586
+ # The total number of dataset errors.
8587
+ # Corresponds to the JSON property `datasetErrorCount`
8588
+ # @return [Fixnum]
8589
+ attr_accessor :dataset_error_count
8590
+
8591
+ # Error information for the dataset as a whole. A maximum of 10 dataset errors
8592
+ # will be returned. A single dataset error is terminal for training.
8593
+ # Corresponds to the JSON property `datasetErrors`
8594
+ # @return [Array<Google::Apis::DocumentaiV1::GoogleRpcStatus>]
8595
+ attr_accessor :dataset_errors
8596
+
8597
+ # The total number of document errors.
8598
+ # Corresponds to the JSON property `documentErrorCount`
8599
+ # @return [Fixnum]
8600
+ attr_accessor :document_error_count
8601
+
8602
+ # Error information pertaining to specific documents. A maximum of 10 document
8603
+ # errors will be returned. Any document with errors will not be used throughout
8604
+ # training.
8605
+ # Corresponds to the JSON property `documentErrors`
8606
+ # @return [Array<Google::Apis::DocumentaiV1::GoogleRpcStatus>]
8607
+ attr_accessor :document_errors
8608
+
8609
+ def initialize(**args)
8610
+ update!(**args)
8611
+ end
8612
+
8613
+ # Update properties of this object
8614
+ def update!(**args)
8615
+ @dataset_error_count = args[:dataset_error_count] if args.key?(:dataset_error_count)
8616
+ @dataset_errors = args[:dataset_errors] if args.key?(:dataset_errors)
8617
+ @document_error_count = args[:document_error_count] if args.key?(:document_error_count)
8618
+ @document_errors = args[:document_errors] if args.key?(:document_errors)
8619
+ end
8620
+ end
8621
+
8622
+ # The response for the TrainProcessorVersion method.
8623
+ class GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse
8624
+ include Google::Apis::Core::Hashable
8625
+
8626
+ # The resource name of the processor version produced by training.
8627
+ # Corresponds to the JSON property `processorVersion`
8628
+ # @return [String]
8629
+ attr_accessor :processor_version
8630
+
8631
+ def initialize(**args)
8632
+ update!(**args)
8633
+ end
8634
+
8635
+ # Update properties of this object
8636
+ def update!(**args)
8637
+ @processor_version = args[:processor_version] if args.key?(:processor_version)
8638
+ end
8639
+ end
8640
+
8582
8641
  # The long running operation metadata for the undeploy processor version method.
8583
8642
  class GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata
8584
8643
  include Google::Apis::Core::Hashable