google-apis-documentai_v1 0.51.0 → 0.53.0
Sign up to get free protection for your applications and to get access to all the features.
@@ -1134,26 +1134,28 @@ module Google
|
|
1134
1134
|
class GoogleCloudDocumentaiV1Barcode
|
1135
1135
|
include Google::Apis::Core::Hashable
|
1136
1136
|
|
1137
|
-
# Format of a barcode. The supported formats are: CODE_128
|
1138
|
-
# CODE_39
|
1139
|
-
# DATA_MATRIX
|
1140
|
-
# EAN-8 type. QR_CODE
|
1141
|
-
#
|
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
|
1140
|
+
# type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A
|
1141
|
+
# type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code
|
1142
|
+
# type. - `DATABAR`: GS1 DataBar code type.
|
1142
1143
|
# Corresponds to the JSON property `format`
|
1143
1144
|
# @return [String]
|
1144
1145
|
attr_accessor :format
|
1145
1146
|
|
1146
|
-
# Raw value encoded in the barcode. For example
|
1147
|
-
# www.google.com;;'
|
1147
|
+
# Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https:/
|
1148
|
+
# /www.google.com;;'`.
|
1148
1149
|
# Corresponds to the JSON property `rawValue`
|
1149
1150
|
# @return [String]
|
1150
1151
|
attr_accessor :raw_value
|
1151
1152
|
|
1152
1153
|
# Value format describes the format of the value that a barcode encodes. The
|
1153
|
-
# supported formats are: CONTACT_INFO
|
1154
|
-
# ISBN
|
1155
|
-
# message. TEXT
|
1156
|
-
#
|
1154
|
+
# supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email
|
1155
|
+
# address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`:
|
1156
|
+
# Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `
|
1157
|
+
# WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`:
|
1158
|
+
# Calendar event. - `DRIVER_LICENSE`: Driver's license.
|
1157
1159
|
# Corresponds to the JSON property `valueFormat`
|
1158
1160
|
# @return [String]
|
1159
1161
|
attr_accessor :value_format
|
@@ -1593,14 +1595,14 @@ module Google
|
|
1593
1595
|
# @return [String]
|
1594
1596
|
attr_accessor :text
|
1595
1597
|
|
1596
|
-
# Placeholder. A list of text corrections made to
|
1597
|
-
#
|
1598
|
-
#
|
1598
|
+
# Placeholder. A list of text corrections made to Document.text. This is usually
|
1599
|
+
# used for annotating corrections to OCR mistakes. Text changes for a given
|
1600
|
+
# revision may not overlap with each other.
|
1599
1601
|
# Corresponds to the JSON property `textChanges`
|
1600
1602
|
# @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentTextChange>]
|
1601
1603
|
attr_accessor :text_changes
|
1602
1604
|
|
1603
|
-
#
|
1605
|
+
# Styles for the Document.text.
|
1604
1606
|
# Corresponds to the JSON property `textStyles`
|
1605
1607
|
# @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentStyle>]
|
1606
1608
|
attr_accessor :text_styles
|
@@ -1640,7 +1642,7 @@ module Google
|
|
1640
1642
|
class GoogleCloudDocumentaiV1DocumentEntity
|
1641
1643
|
include Google::Apis::Core::Hashable
|
1642
1644
|
|
1643
|
-
# Optional. Confidence of detected Schema entity. Range [0, 1]
|
1645
|
+
# Optional. Confidence of detected Schema entity. Range `[0, 1]`.
|
1644
1646
|
# Corresponds to the JSON property `confidence`
|
1645
1647
|
# @return [Float]
|
1646
1648
|
attr_accessor :confidence
|
@@ -1793,8 +1795,8 @@ module Google
|
|
1793
1795
|
# Optional. An optional field to store a normalized string. For some entity
|
1794
1796
|
# types, one of respective `structured_value` fields may also be populated. Also
|
1795
1797
|
# not all the types of `structured_value` will be normalized. For example, some
|
1796
|
-
# processors may not generate float or
|
1797
|
-
# sample formats mapped to structured values. - Money/Currency type (`
|
1798
|
+
# processors may not generate `float` or `integer` normalized text by default.
|
1799
|
+
# Below are sample formats mapped to structured values. - Money/Currency type (`
|
1798
1800
|
# money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in
|
1799
1801
|
# the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO
|
1800
1802
|
# 8601 text format.
|
@@ -1886,6 +1888,11 @@ module Google
|
|
1886
1888
|
# @return [String]
|
1887
1889
|
attr_accessor :gcs_uri
|
1888
1890
|
|
1891
|
+
# The sharding config for the output document.
|
1892
|
+
# Corresponds to the JSON property `shardingConfig`
|
1893
|
+
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig]
|
1894
|
+
attr_accessor :sharding_config
|
1895
|
+
|
1889
1896
|
def initialize(**args)
|
1890
1897
|
update!(**args)
|
1891
1898
|
end
|
@@ -1894,6 +1901,32 @@ module Google
|
|
1894
1901
|
def update!(**args)
|
1895
1902
|
@field_mask = args[:field_mask] if args.key?(:field_mask)
|
1896
1903
|
@gcs_uri = args[:gcs_uri] if args.key?(:gcs_uri)
|
1904
|
+
@sharding_config = args[:sharding_config] if args.key?(:sharding_config)
|
1905
|
+
end
|
1906
|
+
end
|
1907
|
+
|
1908
|
+
# The sharding config for the output document.
|
1909
|
+
class GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig
|
1910
|
+
include Google::Apis::Core::Hashable
|
1911
|
+
|
1912
|
+
# The number of overlapping pages between consecutive shards.
|
1913
|
+
# Corresponds to the JSON property `pagesOverlap`
|
1914
|
+
# @return [Fixnum]
|
1915
|
+
attr_accessor :pages_overlap
|
1916
|
+
|
1917
|
+
# The number of pages per shard.
|
1918
|
+
# Corresponds to the JSON property `pagesPerShard`
|
1919
|
+
# @return [Fixnum]
|
1920
|
+
attr_accessor :pages_per_shard
|
1921
|
+
|
1922
|
+
def initialize(**args)
|
1923
|
+
update!(**args)
|
1924
|
+
end
|
1925
|
+
|
1926
|
+
# Update properties of this object
|
1927
|
+
def update!(**args)
|
1928
|
+
@pages_overlap = args[:pages_overlap] if args.key?(:pages_overlap)
|
1929
|
+
@pages_per_shard = args[:pages_per_shard] if args.key?(:pages_per_shard)
|
1897
1930
|
end
|
1898
1931
|
end
|
1899
1932
|
|
@@ -2050,7 +2083,7 @@ module Google
|
|
2050
2083
|
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BoundingPoly]
|
2051
2084
|
attr_accessor :bounding_poly
|
2052
2085
|
|
2053
|
-
# Optional. Confidence of detected page element, if applicable. Range [0, 1]
|
2086
|
+
# Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
|
2054
2087
|
# Corresponds to the JSON property `confidence`
|
2055
2088
|
# @return [Float]
|
2056
2089
|
attr_accessor :confidence
|
@@ -2065,10 +2098,10 @@ module Google
|
|
2065
2098
|
# @return [String]
|
2066
2099
|
attr_accessor :layout_type
|
2067
2100
|
|
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
|
2070
|
-
# is the default 0
|
2071
|
-
# proto3#json.
|
2101
|
+
# Required. Index into the Document.pages element, for example using `Document.
|
2102
|
+
# pages` to locate the related page element. This field is skipped when its
|
2103
|
+
# value is the default `0`. See https://developers.google.com/protocol-buffers/
|
2104
|
+
# docs/proto3#json.
|
2072
2105
|
# Corresponds to the JSON property `page`
|
2073
2106
|
# @return [Fixnum]
|
2074
2107
|
attr_accessor :page
|
@@ -2149,12 +2182,12 @@ module Google
|
|
2149
2182
|
class GoogleCloudDocumentaiV1DocumentPageDetectedLanguage
|
2150
2183
|
include Google::Apis::Core::Hashable
|
2151
2184
|
|
2152
|
-
# Confidence of detected language. Range [0, 1]
|
2185
|
+
# Confidence of detected language. Range `[0, 1]`.
|
2153
2186
|
# Corresponds to the JSON property `confidence`
|
2154
2187
|
# @return [Float]
|
2155
2188
|
attr_accessor :confidence
|
2156
2189
|
|
2157
|
-
# The BCP-47 language code, such as
|
2190
|
+
# The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information,
|
2158
2191
|
# see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
|
2159
2192
|
# Corresponds to the JSON property `languageCode`
|
2160
2193
|
# @return [String]
|
@@ -2247,8 +2280,8 @@ module Google
|
|
2247
2280
|
attr_accessor :value_detected_languages
|
2248
2281
|
|
2249
2282
|
# 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
|
2283
|
+
# values are: - blank (this indicates the `field_value` is normal text) - `
|
2284
|
+
# unfilled_checkbox` - `filled_checkbox`
|
2252
2285
|
# Corresponds to the JSON property `valueType`
|
2253
2286
|
# @return [String]
|
2254
2287
|
attr_accessor :value_type
|
@@ -2317,7 +2350,7 @@ module Google
|
|
2317
2350
|
# @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect>]
|
2318
2351
|
attr_accessor :detected_defects
|
2319
2352
|
|
2320
|
-
# The overall quality score. Range [0, 1] where 1 is perfect quality.
|
2353
|
+
# The overall quality score. Range `[0, 1]` where 1 is perfect quality.
|
2321
2354
|
# Corresponds to the JSON property `qualityScore`
|
2322
2355
|
# @return [Float]
|
2323
2356
|
attr_accessor :quality_score
|
@@ -2337,16 +2370,16 @@ module Google
|
|
2337
2370
|
class GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect
|
2338
2371
|
include Google::Apis::Core::Hashable
|
2339
2372
|
|
2340
|
-
# Confidence of detected defect. Range [0, 1] where 1 indicates strong
|
2373
|
+
# Confidence of detected defect. Range `[0, 1]` where 1 indicates strong
|
2341
2374
|
# confidence of that the defect exists.
|
2342
2375
|
# Corresponds to the JSON property `confidence`
|
2343
2376
|
# @return [Float]
|
2344
2377
|
attr_accessor :confidence
|
2345
2378
|
|
2346
|
-
# Name of the defect type. Supported values are
|
2347
|
-
# quality/defect_noisy
|
2348
|
-
# defect_text_too_small
|
2349
|
-
# defect_text_cutoff
|
2379
|
+
# Name of the defect type. Supported values are: - `quality/defect_blurry` - `
|
2380
|
+
# quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `
|
2381
|
+
# quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/
|
2382
|
+
# defect_text_cutoff` - `quality/defect_glare`
|
2350
2383
|
# Corresponds to the JSON property `type`
|
2351
2384
|
# @return [String]
|
2352
2385
|
attr_accessor :type
|
@@ -2373,7 +2406,7 @@ module Google
|
|
2373
2406
|
|
2374
2407
|
# Confidence of the current Layout within context of the object this layout is
|
2375
2408
|
# for. e.g. confidence can be for a single token, a table, a visual element, etc.
|
2376
|
-
# depending on context. Range [0, 1]
|
2409
|
+
# depending on context. Range `[0, 1]`.
|
2377
2410
|
# Corresponds to the JSON property `confidence`
|
2378
2411
|
# @return [Float]
|
2379
2412
|
attr_accessor :confidence
|
@@ -2932,24 +2965,19 @@ module Google
|
|
2932
2965
|
# @return [String]
|
2933
2966
|
attr_accessor :display_name
|
2934
2967
|
|
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
2968
|
# Defines the a list of enum values.
|
2941
2969
|
# Corresponds to the JSON property `enumValues`
|
2942
2970
|
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues]
|
2943
2971
|
attr_accessor :enum_values
|
2944
2972
|
|
2945
2973
|
# 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
|
2974
|
+
# Common Type'. Besides that we use the following naming conventions: - *use `
|
2975
|
+
# snake_casing`* - name matching is case-sensitive - Maximum 64 characters. -
|
2948
2976
|
# Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (
|
2949
2977
|
# For backward compatibility internal infrastructure and tooling can handle any
|
2950
|
-
# ascii character) - The
|
2951
|
-
# For example line_item/amount
|
2952
|
-
# honored for backward compatibility.
|
2978
|
+
# ascii character) - The `/` is sometimes used to denote a property of a type.
|
2979
|
+
# For example `line_item/amount`. This convention is deprecated, but will still
|
2980
|
+
# be honored for backward compatibility.
|
2953
2981
|
# Corresponds to the JSON property `name`
|
2954
2982
|
# @return [String]
|
2955
2983
|
attr_accessor :name
|
@@ -2967,7 +2995,6 @@ module Google
|
|
2967
2995
|
def update!(**args)
|
2968
2996
|
@base_types = args[:base_types] if args.key?(:base_types)
|
2969
2997
|
@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
2998
|
@enum_values = args[:enum_values] if args.key?(:enum_values)
|
2972
2999
|
@name = args[:name] if args.key?(:name)
|
2973
3000
|
@properties = args[:properties] if args.key?(:properties)
|
@@ -3008,11 +3035,6 @@ module Google
|
|
3008
3035
|
# @return [String]
|
3009
3036
|
attr_accessor :occurrence_type
|
3010
3037
|
|
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
3038
|
# A reference to the value type of the property. This type is subject to the
|
3017
3039
|
# same conventions as the `Entity.base_types` field.
|
3018
3040
|
# Corresponds to the JSON property `valueType`
|
@@ -3027,7 +3049,6 @@ module Google
|
|
3027
3049
|
def update!(**args)
|
3028
3050
|
@name = args[:name] if args.key?(:name)
|
3029
3051
|
@occurrence_type = args[:occurrence_type] if args.key?(:occurrence_type)
|
3030
|
-
@property_metadata = args[:property_metadata] if args.key?(:property_metadata)
|
3031
3052
|
@value_type = args[:value_type] if args.key?(:value_type)
|
3032
3053
|
end
|
3033
3054
|
end
|
@@ -3213,7 +3234,7 @@ module Google
|
|
3213
3234
|
# @return [Google::Apis::DocumentaiV1::GoogleTypeColor]
|
3214
3235
|
attr_accessor :color
|
3215
3236
|
|
3216
|
-
# Font family such as
|
3237
|
+
# Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/
|
3217
3238
|
# cssref/pr_font_font-family.asp
|
3218
3239
|
# Corresponds to the JSON property `fontFamily`
|
3219
3240
|
# @return [String]
|
@@ -3419,45 +3440,6 @@ module Google
|
|
3419
3440
|
end
|
3420
3441
|
end
|
3421
3442
|
|
3422
|
-
# Metadata about an entity type.
|
3423
|
-
class GoogleCloudDocumentaiV1EntityTypeMetadata
|
3424
|
-
include Google::Apis::Core::Hashable
|
3425
|
-
|
3426
|
-
# Metadata for human review labeling config.
|
3427
|
-
# Corresponds to the JSON property `humanReviewLabelingMetadata`
|
3428
|
-
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1HumanReviewLabelingMetadata]
|
3429
|
-
attr_accessor :human_review_labeling_metadata
|
3430
|
-
|
3431
|
-
# Metadata for Human Review config.
|
3432
|
-
# Corresponds to the JSON property `humanReviewMetadata`
|
3433
|
-
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1HumanReviewValidationMetadata]
|
3434
|
-
attr_accessor :human_review_metadata
|
3435
|
-
|
3436
|
-
# Whether the entity type should be considered as "inactive".
|
3437
|
-
# Corresponds to the JSON property `inactive`
|
3438
|
-
# @return [Boolean]
|
3439
|
-
attr_accessor :inactive
|
3440
|
-
alias_method :inactive?, :inactive
|
3441
|
-
|
3442
|
-
# Metadata that specifies whether a label is editable and reasons why. These
|
3443
|
-
# fields are read-only. Changing these fields has no impact on the backend.
|
3444
|
-
# Corresponds to the JSON property `schemaMutabilityMetadata`
|
3445
|
-
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1SchemaMutabilityMetadata]
|
3446
|
-
attr_accessor :schema_mutability_metadata
|
3447
|
-
|
3448
|
-
def initialize(**args)
|
3449
|
-
update!(**args)
|
3450
|
-
end
|
3451
|
-
|
3452
|
-
# Update properties of this object
|
3453
|
-
def update!(**args)
|
3454
|
-
@human_review_labeling_metadata = args[:human_review_labeling_metadata] if args.key?(:human_review_labeling_metadata)
|
3455
|
-
@human_review_metadata = args[:human_review_metadata] if args.key?(:human_review_metadata)
|
3456
|
-
@inactive = args[:inactive] if args.key?(:inactive)
|
3457
|
-
@schema_mutability_metadata = args[:schema_mutability_metadata] if args.key?(:schema_mutability_metadata)
|
3458
|
-
end
|
3459
|
-
end
|
3460
|
-
|
3461
3443
|
# Response message for fetch processor types.
|
3462
3444
|
class GoogleCloudDocumentaiV1FetchProcessorTypesResponse
|
3463
3445
|
include Google::Apis::Core::Hashable
|
@@ -3540,26 +3522,6 @@ module Google
|
|
3540
3522
|
end
|
3541
3523
|
end
|
3542
3524
|
|
3543
|
-
# Metadata for human review labeling config.
|
3544
|
-
class GoogleCloudDocumentaiV1HumanReviewLabelingMetadata
|
3545
|
-
include Google::Apis::Core::Hashable
|
3546
|
-
|
3547
|
-
# Whether to enable normalization editing.
|
3548
|
-
# Corresponds to the JSON property `enableNormalizationEditing`
|
3549
|
-
# @return [Boolean]
|
3550
|
-
attr_accessor :enable_normalization_editing
|
3551
|
-
alias_method :enable_normalization_editing?, :enable_normalization_editing
|
3552
|
-
|
3553
|
-
def initialize(**args)
|
3554
|
-
update!(**args)
|
3555
|
-
end
|
3556
|
-
|
3557
|
-
# Update properties of this object
|
3558
|
-
def update!(**args)
|
3559
|
-
@enable_normalization_editing = args[:enable_normalization_editing] if args.key?(:enable_normalization_editing)
|
3560
|
-
end
|
3561
|
-
end
|
3562
|
-
|
3563
3525
|
# The status of human review on a processed document.
|
3564
3526
|
class GoogleCloudDocumentaiV1HumanReviewStatus
|
3565
3527
|
include Google::Apis::Core::Hashable
|
@@ -3594,32 +3556,6 @@ module Google
|
|
3594
3556
|
end
|
3595
3557
|
end
|
3596
3558
|
|
3597
|
-
# Metadata for Human Review config.
|
3598
|
-
class GoogleCloudDocumentaiV1HumanReviewValidationMetadata
|
3599
|
-
include Google::Apis::Core::Hashable
|
3600
|
-
|
3601
|
-
# The confidence threshold if human review validation is enabled.
|
3602
|
-
# Corresponds to the JSON property `confidenceThreshold`
|
3603
|
-
# @return [Float]
|
3604
|
-
attr_accessor :confidence_threshold
|
3605
|
-
|
3606
|
-
# Whether to enable human review validation.
|
3607
|
-
# Corresponds to the JSON property `enableValidation`
|
3608
|
-
# @return [Boolean]
|
3609
|
-
attr_accessor :enable_validation
|
3610
|
-
alias_method :enable_validation?, :enable_validation
|
3611
|
-
|
3612
|
-
def initialize(**args)
|
3613
|
-
update!(**args)
|
3614
|
-
end
|
3615
|
-
|
3616
|
-
# Update properties of this object
|
3617
|
-
def update!(**args)
|
3618
|
-
@confidence_threshold = args[:confidence_threshold] if args.key?(:confidence_threshold)
|
3619
|
-
@enable_validation = args[:enable_validation] if args.key?(:enable_validation)
|
3620
|
-
end
|
3621
|
-
end
|
3622
|
-
|
3623
3559
|
# Response message for list processor types.
|
3624
3560
|
class GoogleCloudDocumentaiV1ListProcessorTypesResponse
|
3625
3561
|
include Google::Apis::Core::Hashable
|
@@ -3836,8 +3772,8 @@ module Google
|
|
3836
3772
|
# @return [String]
|
3837
3773
|
attr_accessor :state
|
3838
3774
|
|
3839
|
-
# The processor type, e.g., OCR_PROCESSOR
|
3840
|
-
# of processors types, see FetchProcessorTypes.
|
3775
|
+
# The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc. To get a
|
3776
|
+
# list of processors types, see FetchProcessorTypes.
|
3841
3777
|
# Corresponds to the JSON property `type`
|
3842
3778
|
# @return [String]
|
3843
3779
|
attr_accessor :type
|
@@ -3886,13 +3822,18 @@ module Google
|
|
3886
3822
|
# @return [String]
|
3887
3823
|
attr_accessor :launch_stage
|
3888
3824
|
|
3889
|
-
# The resource name of the processor type. Format: projects/`project`/
|
3890
|
-
# processorTypes/`processor_type
|
3825
|
+
# The resource name of the processor type. Format: `projects/`project`/
|
3826
|
+
# processorTypes/`processor_type``
|
3891
3827
|
# Corresponds to the JSON property `name`
|
3892
3828
|
# @return [String]
|
3893
3829
|
attr_accessor :name
|
3894
3830
|
|
3895
|
-
#
|
3831
|
+
# A set of Cloud Storage URIs of sample documents for this processor.
|
3832
|
+
# Corresponds to the JSON property `sampleDocumentUris`
|
3833
|
+
# @return [Array<String>]
|
3834
|
+
attr_accessor :sample_document_uris
|
3835
|
+
|
3836
|
+
# The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc.
|
3896
3837
|
# Corresponds to the JSON property `type`
|
3897
3838
|
# @return [String]
|
3898
3839
|
attr_accessor :type
|
@@ -3908,6 +3849,7 @@ module Google
|
|
3908
3849
|
@category = args[:category] if args.key?(:category)
|
3909
3850
|
@launch_stage = args[:launch_stage] if args.key?(:launch_stage)
|
3910
3851
|
@name = args[:name] if args.key?(:name)
|
3852
|
+
@sample_document_uris = args[:sample_document_uris] if args.key?(:sample_document_uris)
|
3911
3853
|
@type = args[:type] if args.key?(:type)
|
3912
3854
|
end
|
3913
3855
|
end
|
@@ -3954,6 +3896,11 @@ module Google
|
|
3954
3896
|
# @return [String]
|
3955
3897
|
attr_accessor :display_name
|
3956
3898
|
|
3899
|
+
# The schema defines the output of the processed document by a processor.
|
3900
|
+
# Corresponds to the JSON property `documentSchema`
|
3901
|
+
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchema]
|
3902
|
+
attr_accessor :document_schema
|
3903
|
+
|
3957
3904
|
# Denotes that this ProcessorVersion is managed by google.
|
3958
3905
|
# Corresponds to the JSON property `googleManaged`
|
3959
3906
|
# @return [Boolean]
|
@@ -3991,6 +3938,7 @@ module Google
|
|
3991
3938
|
@create_time = args[:create_time] if args.key?(:create_time)
|
3992
3939
|
@deprecation_info = args[:deprecation_info] if args.key?(:deprecation_info)
|
3993
3940
|
@display_name = args[:display_name] if args.key?(:display_name)
|
3941
|
+
@document_schema = args[:document_schema] if args.key?(:document_schema)
|
3994
3942
|
@google_managed = args[:google_managed] if args.key?(:google_managed)
|
3995
3943
|
@kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
|
3996
3944
|
@kms_key_version_name = args[:kms_key_version_name] if args.key?(:kms_key_version_name)
|
@@ -4024,45 +3972,6 @@ module Google
|
|
4024
3972
|
end
|
4025
3973
|
end
|
4026
3974
|
|
4027
|
-
# Metadata about a property.
|
4028
|
-
class GoogleCloudDocumentaiV1PropertyMetadata
|
4029
|
-
include Google::Apis::Core::Hashable
|
4030
|
-
|
4031
|
-
# Metadata for human review labeling config.
|
4032
|
-
# Corresponds to the JSON property `humanReviewLabelingMetadata`
|
4033
|
-
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1HumanReviewLabelingMetadata]
|
4034
|
-
attr_accessor :human_review_labeling_metadata
|
4035
|
-
|
4036
|
-
# Metadata for Human Review config.
|
4037
|
-
# Corresponds to the JSON property `humanReviewMetadata`
|
4038
|
-
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1HumanReviewValidationMetadata]
|
4039
|
-
attr_accessor :human_review_metadata
|
4040
|
-
|
4041
|
-
# Whether the property should be considered as "inactive".
|
4042
|
-
# Corresponds to the JSON property `inactive`
|
4043
|
-
# @return [Boolean]
|
4044
|
-
attr_accessor :inactive
|
4045
|
-
alias_method :inactive?, :inactive
|
4046
|
-
|
4047
|
-
# Metadata that specifies whether a label is editable and reasons why. These
|
4048
|
-
# fields are read-only. Changing these fields has no impact on the backend.
|
4049
|
-
# Corresponds to the JSON property `schemaMutabilityMetadata`
|
4050
|
-
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1SchemaMutabilityMetadata]
|
4051
|
-
attr_accessor :schema_mutability_metadata
|
4052
|
-
|
4053
|
-
def initialize(**args)
|
4054
|
-
update!(**args)
|
4055
|
-
end
|
4056
|
-
|
4057
|
-
# Update properties of this object
|
4058
|
-
def update!(**args)
|
4059
|
-
@human_review_labeling_metadata = args[:human_review_labeling_metadata] if args.key?(:human_review_labeling_metadata)
|
4060
|
-
@human_review_metadata = args[:human_review_metadata] if args.key?(:human_review_metadata)
|
4061
|
-
@inactive = args[:inactive] if args.key?(:inactive)
|
4062
|
-
@schema_mutability_metadata = args[:schema_mutability_metadata] if args.key?(:schema_mutability_metadata)
|
4063
|
-
end
|
4064
|
-
end
|
4065
|
-
|
4066
3975
|
# Payload message of raw document content (bytes).
|
4067
3976
|
class GoogleCloudDocumentaiV1RawDocument
|
4068
3977
|
include Google::Apis::Core::Hashable
|
@@ -4073,7 +3982,7 @@ module Google
|
|
4073
3982
|
# @return [String]
|
4074
3983
|
attr_accessor :content
|
4075
3984
|
|
4076
|
-
# An IANA MIME type (RFC6838) indicating the nature and format of the
|
3985
|
+
# An IANA MIME type (RFC6838) indicating the nature and format of the content.
|
4077
3986
|
# Corresponds to the JSON property `mimeType`
|
4078
3987
|
# @return [String]
|
4079
3988
|
attr_accessor :mime_type
|
@@ -4187,35 +4096,6 @@ module Google
|
|
4187
4096
|
end
|
4188
4097
|
end
|
4189
4098
|
|
4190
|
-
# Metadata that specifies whether a label is editable and reasons why. These
|
4191
|
-
# fields are read-only. Changing these fields has no impact on the backend.
|
4192
|
-
class GoogleCloudDocumentaiV1SchemaMutabilityMetadata
|
4193
|
-
include Google::Apis::Core::Hashable
|
4194
|
-
|
4195
|
-
# Explicit flag that controls whether the label is editable.
|
4196
|
-
# Corresponds to the JSON property `editable`
|
4197
|
-
# @return [Boolean]
|
4198
|
-
attr_accessor :editable
|
4199
|
-
alias_method :editable?, :editable
|
4200
|
-
|
4201
|
-
# Full resource name of processor versions that contain this label. e.g. `
|
4202
|
-
# projects/`project`/locations/`location`/processors/`processor`/
|
4203
|
-
# processorVersions/`processorVersion``
|
4204
|
-
# Corresponds to the JSON property `processorVersions`
|
4205
|
-
# @return [Array<String>]
|
4206
|
-
attr_accessor :processor_versions
|
4207
|
-
|
4208
|
-
def initialize(**args)
|
4209
|
-
update!(**args)
|
4210
|
-
end
|
4211
|
-
|
4212
|
-
# Update properties of this object
|
4213
|
-
def update!(**args)
|
4214
|
-
@editable = args[:editable] if args.key?(:editable)
|
4215
|
-
@processor_versions = args[:processor_versions] if args.key?(:processor_versions)
|
4216
|
-
end
|
4217
|
-
end
|
4218
|
-
|
4219
4099
|
# The long running operation metadata for set default processor version method.
|
4220
4100
|
class GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata
|
4221
4101
|
include Google::Apis::Core::Hashable
|
@@ -4406,26 +4286,28 @@ module Google
|
|
4406
4286
|
class GoogleCloudDocumentaiV1beta1Barcode
|
4407
4287
|
include Google::Apis::Core::Hashable
|
4408
4288
|
|
4409
|
-
# Format of a barcode. The supported formats are: CODE_128
|
4410
|
-
# CODE_39
|
4411
|
-
# DATA_MATRIX
|
4412
|
-
# EAN-8 type. QR_CODE
|
4413
|
-
#
|
4289
|
+
# Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. -
|
4290
|
+
# `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type.
|
4291
|
+
# - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13
|
4292
|
+
# type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A
|
4293
|
+
# type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code
|
4294
|
+
# type. - `DATABAR`: GS1 DataBar code type.
|
4414
4295
|
# Corresponds to the JSON property `format`
|
4415
4296
|
# @return [String]
|
4416
4297
|
attr_accessor :format
|
4417
4298
|
|
4418
|
-
# Raw value encoded in the barcode. For example
|
4419
|
-
# www.google.com;;'
|
4299
|
+
# Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https:/
|
4300
|
+
# /www.google.com;;'`.
|
4420
4301
|
# Corresponds to the JSON property `rawValue`
|
4421
4302
|
# @return [String]
|
4422
4303
|
attr_accessor :raw_value
|
4423
4304
|
|
4424
4305
|
# Value format describes the format of the value that a barcode encodes. The
|
4425
|
-
# supported formats are: CONTACT_INFO
|
4426
|
-
# ISBN
|
4427
|
-
# message. TEXT
|
4428
|
-
#
|
4306
|
+
# supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email
|
4307
|
+
# address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`:
|
4308
|
+
# Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `
|
4309
|
+
# WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`:
|
4310
|
+
# Calendar event. - `DRIVER_LICENSE`: Driver's license.
|
4429
4311
|
# Corresponds to the JSON property `valueFormat`
|
4430
4312
|
# @return [String]
|
4431
4313
|
attr_accessor :value_format
|
@@ -4551,14 +4433,14 @@ module Google
|
|
4551
4433
|
# @return [String]
|
4552
4434
|
attr_accessor :text
|
4553
4435
|
|
4554
|
-
# Placeholder. A list of text corrections made to
|
4555
|
-
#
|
4556
|
-
#
|
4436
|
+
# Placeholder. A list of text corrections made to Document.text. This is usually
|
4437
|
+
# used for annotating corrections to OCR mistakes. Text changes for a given
|
4438
|
+
# revision may not overlap with each other.
|
4557
4439
|
# Corresponds to the JSON property `textChanges`
|
4558
4440
|
# @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentTextChange>]
|
4559
4441
|
attr_accessor :text_changes
|
4560
4442
|
|
4561
|
-
#
|
4443
|
+
# Styles for the Document.text.
|
4562
4444
|
# Corresponds to the JSON property `textStyles`
|
4563
4445
|
# @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentStyle>]
|
4564
4446
|
attr_accessor :text_styles
|
@@ -4598,7 +4480,7 @@ module Google
|
|
4598
4480
|
class GoogleCloudDocumentaiV1beta1DocumentEntity
|
4599
4481
|
include Google::Apis::Core::Hashable
|
4600
4482
|
|
4601
|
-
# Optional. Confidence of detected Schema entity. Range [0, 1]
|
4483
|
+
# Optional. Confidence of detected Schema entity. Range `[0, 1]`.
|
4602
4484
|
# Corresponds to the JSON property `confidence`
|
4603
4485
|
# @return [Float]
|
4604
4486
|
attr_accessor :confidence
|
@@ -4751,8 +4633,8 @@ module Google
|
|
4751
4633
|
# Optional. An optional field to store a normalized string. For some entity
|
4752
4634
|
# types, one of respective `structured_value` fields may also be populated. Also
|
4753
4635
|
# not all the types of `structured_value` will be normalized. For example, some
|
4754
|
-
# processors may not generate float or
|
4755
|
-
# sample formats mapped to structured values. - Money/Currency type (`
|
4636
|
+
# processors may not generate `float` or `integer` normalized text by default.
|
4637
|
+
# Below are sample formats mapped to structured values. - Money/Currency type (`
|
4756
4638
|
# money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in
|
4757
4639
|
# the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO
|
4758
4640
|
# 8601 text format.
|
@@ -4961,7 +4843,7 @@ module Google
|
|
4961
4843
|
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1BoundingPoly]
|
4962
4844
|
attr_accessor :bounding_poly
|
4963
4845
|
|
4964
|
-
# Optional. Confidence of detected page element, if applicable. Range [0, 1]
|
4846
|
+
# Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
|
4965
4847
|
# Corresponds to the JSON property `confidence`
|
4966
4848
|
# @return [Float]
|
4967
4849
|
attr_accessor :confidence
|
@@ -4976,10 +4858,10 @@ module Google
|
|
4976
4858
|
# @return [String]
|
4977
4859
|
attr_accessor :layout_type
|
4978
4860
|
|
4979
|
-
# Required. Index into the Document.pages element, for example using Document.
|
4980
|
-
# pages to locate the related page element. This field is skipped when its
|
4981
|
-
# is the default 0
|
4982
|
-
# proto3#json.
|
4861
|
+
# Required. Index into the Document.pages element, for example using `Document.
|
4862
|
+
# pages` to locate the related page element. This field is skipped when its
|
4863
|
+
# value is the default `0`. See https://developers.google.com/protocol-buffers/
|
4864
|
+
# docs/proto3#json.
|
4983
4865
|
# Corresponds to the JSON property `page`
|
4984
4866
|
# @return [Fixnum]
|
4985
4867
|
attr_accessor :page
|
@@ -5060,12 +4942,12 @@ module Google
|
|
5060
4942
|
class GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage
|
5061
4943
|
include Google::Apis::Core::Hashable
|
5062
4944
|
|
5063
|
-
# Confidence of detected language. Range [0, 1]
|
4945
|
+
# Confidence of detected language. Range `[0, 1]`.
|
5064
4946
|
# Corresponds to the JSON property `confidence`
|
5065
4947
|
# @return [Float]
|
5066
4948
|
attr_accessor :confidence
|
5067
4949
|
|
5068
|
-
# The BCP-47 language code, such as
|
4950
|
+
# The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information,
|
5069
4951
|
# see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
|
5070
4952
|
# Corresponds to the JSON property `languageCode`
|
5071
4953
|
# @return [String]
|
@@ -5158,8 +5040,8 @@ module Google
|
|
5158
5040
|
attr_accessor :value_detected_languages
|
5159
5041
|
|
5160
5042
|
# If the value is non-textual, this field represents the type. Current valid
|
5161
|
-
# values are: - blank (this indicates the field_value is normal text) -
|
5162
|
-
# unfilled_checkbox
|
5043
|
+
# values are: - blank (this indicates the `field_value` is normal text) - `
|
5044
|
+
# unfilled_checkbox` - `filled_checkbox`
|
5163
5045
|
# Corresponds to the JSON property `valueType`
|
5164
5046
|
# @return [String]
|
5165
5047
|
attr_accessor :value_type
|
@@ -5228,7 +5110,7 @@ module Google
|
|
5228
5110
|
# @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect>]
|
5229
5111
|
attr_accessor :detected_defects
|
5230
5112
|
|
5231
|
-
# The overall quality score. Range [0, 1] where 1 is perfect quality.
|
5113
|
+
# The overall quality score. Range `[0, 1]` where 1 is perfect quality.
|
5232
5114
|
# Corresponds to the JSON property `qualityScore`
|
5233
5115
|
# @return [Float]
|
5234
5116
|
attr_accessor :quality_score
|
@@ -5248,16 +5130,16 @@ module Google
|
|
5248
5130
|
class GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect
|
5249
5131
|
include Google::Apis::Core::Hashable
|
5250
5132
|
|
5251
|
-
# Confidence of detected defect. Range [0, 1] where 1 indicates strong
|
5133
|
+
# Confidence of detected defect. Range `[0, 1]` where 1 indicates strong
|
5252
5134
|
# confidence of that the defect exists.
|
5253
5135
|
# Corresponds to the JSON property `confidence`
|
5254
5136
|
# @return [Float]
|
5255
5137
|
attr_accessor :confidence
|
5256
5138
|
|
5257
|
-
# Name of the defect type. Supported values are
|
5258
|
-
# quality/defect_noisy
|
5259
|
-
# defect_text_too_small
|
5260
|
-
# defect_text_cutoff
|
5139
|
+
# Name of the defect type. Supported values are: - `quality/defect_blurry` - `
|
5140
|
+
# quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `
|
5141
|
+
# quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/
|
5142
|
+
# defect_text_cutoff` - `quality/defect_glare`
|
5261
5143
|
# Corresponds to the JSON property `type`
|
5262
5144
|
# @return [String]
|
5263
5145
|
attr_accessor :type
|
@@ -5284,7 +5166,7 @@ module Google
|
|
5284
5166
|
|
5285
5167
|
# Confidence of the current Layout within context of the object this layout is
|
5286
5168
|
# for. e.g. confidence can be for a single token, a table, a visual element, etc.
|
5287
|
-
# depending on context. Range [0, 1]
|
5169
|
+
# depending on context. Range `[0, 1]`.
|
5288
5170
|
# Corresponds to the JSON property `confidence`
|
5289
5171
|
# @return [Float]
|
5290
5172
|
attr_accessor :confidence
|
@@ -5925,7 +5807,7 @@ module Google
|
|
5925
5807
|
# @return [Google::Apis::DocumentaiV1::GoogleTypeColor]
|
5926
5808
|
attr_accessor :color
|
5927
5809
|
|
5928
|
-
# Font family such as
|
5810
|
+
# Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/
|
5929
5811
|
# cssref/pr_font_font-family.asp
|
5930
5812
|
# Corresponds to the JSON property `fontFamily`
|
5931
5813
|
# @return [String]
|
@@ -6302,26 +6184,28 @@ module Google
|
|
6302
6184
|
class GoogleCloudDocumentaiV1beta2Barcode
|
6303
6185
|
include Google::Apis::Core::Hashable
|
6304
6186
|
|
6305
|
-
# Format of a barcode. The supported formats are: CODE_128
|
6306
|
-
# CODE_39
|
6307
|
-
# DATA_MATRIX
|
6308
|
-
# EAN-8 type. QR_CODE
|
6309
|
-
#
|
6187
|
+
# Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. -
|
6188
|
+
# `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type.
|
6189
|
+
# - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13
|
6190
|
+
# type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A
|
6191
|
+
# type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code
|
6192
|
+
# type. - `DATABAR`: GS1 DataBar code type.
|
6310
6193
|
# Corresponds to the JSON property `format`
|
6311
6194
|
# @return [String]
|
6312
6195
|
attr_accessor :format
|
6313
6196
|
|
6314
|
-
# Raw value encoded in the barcode. For example
|
6315
|
-
# www.google.com;;'
|
6197
|
+
# Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https:/
|
6198
|
+
# /www.google.com;;'`.
|
6316
6199
|
# Corresponds to the JSON property `rawValue`
|
6317
6200
|
# @return [String]
|
6318
6201
|
attr_accessor :raw_value
|
6319
6202
|
|
6320
6203
|
# Value format describes the format of the value that a barcode encodes. The
|
6321
|
-
# supported formats are: CONTACT_INFO
|
6322
|
-
# ISBN
|
6323
|
-
# message. TEXT
|
6324
|
-
#
|
6204
|
+
# supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email
|
6205
|
+
# address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`:
|
6206
|
+
# Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `
|
6207
|
+
# WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`:
|
6208
|
+
# Calendar event. - `DRIVER_LICENSE`: Driver's license.
|
6325
6209
|
# Corresponds to the JSON property `valueFormat`
|
6326
6210
|
# @return [String]
|
6327
6211
|
attr_accessor :value_format
|
@@ -6452,14 +6336,14 @@ module Google
|
|
6452
6336
|
# @return [String]
|
6453
6337
|
attr_accessor :text
|
6454
6338
|
|
6455
|
-
# Placeholder. A list of text corrections made to
|
6456
|
-
#
|
6457
|
-
#
|
6339
|
+
# Placeholder. A list of text corrections made to Document.text. This is usually
|
6340
|
+
# used for annotating corrections to OCR mistakes. Text changes for a given
|
6341
|
+
# revision may not overlap with each other.
|
6458
6342
|
# Corresponds to the JSON property `textChanges`
|
6459
6343
|
# @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentTextChange>]
|
6460
6344
|
attr_accessor :text_changes
|
6461
6345
|
|
6462
|
-
#
|
6346
|
+
# Styles for the Document.text.
|
6463
6347
|
# Corresponds to the JSON property `textStyles`
|
6464
6348
|
# @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentStyle>]
|
6465
6349
|
attr_accessor :text_styles
|
@@ -6500,7 +6384,7 @@ module Google
|
|
6500
6384
|
class GoogleCloudDocumentaiV1beta2DocumentEntity
|
6501
6385
|
include Google::Apis::Core::Hashable
|
6502
6386
|
|
6503
|
-
# Optional. Confidence of detected Schema entity. Range [0, 1]
|
6387
|
+
# Optional. Confidence of detected Schema entity. Range `[0, 1]`.
|
6504
6388
|
# Corresponds to the JSON property `confidence`
|
6505
6389
|
# @return [Float]
|
6506
6390
|
attr_accessor :confidence
|
@@ -6653,8 +6537,8 @@ module Google
|
|
6653
6537
|
# Optional. An optional field to store a normalized string. For some entity
|
6654
6538
|
# types, one of respective `structured_value` fields may also be populated. Also
|
6655
6539
|
# not all the types of `structured_value` will be normalized. For example, some
|
6656
|
-
# processors may not generate float or
|
6657
|
-
# sample formats mapped to structured values. - Money/Currency type (`
|
6540
|
+
# processors may not generate `float` or `integer` normalized text by default.
|
6541
|
+
# Below are sample formats mapped to structured values. - Money/Currency type (`
|
6658
6542
|
# money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in
|
6659
6543
|
# the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO
|
6660
6544
|
# 8601 text format.
|
@@ -6900,7 +6784,7 @@ module Google
|
|
6900
6784
|
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2BoundingPoly]
|
6901
6785
|
attr_accessor :bounding_poly
|
6902
6786
|
|
6903
|
-
# Optional. Confidence of detected page element, if applicable. Range [0, 1]
|
6787
|
+
# Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
|
6904
6788
|
# Corresponds to the JSON property `confidence`
|
6905
6789
|
# @return [Float]
|
6906
6790
|
attr_accessor :confidence
|
@@ -6915,10 +6799,10 @@ module Google
|
|
6915
6799
|
# @return [String]
|
6916
6800
|
attr_accessor :layout_type
|
6917
6801
|
|
6918
|
-
# Required. Index into the Document.pages element, for example using Document.
|
6919
|
-
# pages to locate the related page element. This field is skipped when its
|
6920
|
-
# is the default 0
|
6921
|
-
# proto3#json.
|
6802
|
+
# Required. Index into the Document.pages element, for example using `Document.
|
6803
|
+
# pages` to locate the related page element. This field is skipped when its
|
6804
|
+
# value is the default `0`. See https://developers.google.com/protocol-buffers/
|
6805
|
+
# docs/proto3#json.
|
6922
6806
|
# Corresponds to the JSON property `page`
|
6923
6807
|
# @return [Fixnum]
|
6924
6808
|
attr_accessor :page
|
@@ -6999,12 +6883,12 @@ module Google
|
|
6999
6883
|
class GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage
|
7000
6884
|
include Google::Apis::Core::Hashable
|
7001
6885
|
|
7002
|
-
# Confidence of detected language. Range [0, 1]
|
6886
|
+
# Confidence of detected language. Range `[0, 1]`.
|
7003
6887
|
# Corresponds to the JSON property `confidence`
|
7004
6888
|
# @return [Float]
|
7005
6889
|
attr_accessor :confidence
|
7006
6890
|
|
7007
|
-
# The BCP-47 language code, such as
|
6891
|
+
# The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information,
|
7008
6892
|
# see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
|
7009
6893
|
# Corresponds to the JSON property `languageCode`
|
7010
6894
|
# @return [String]
|
@@ -7097,8 +6981,8 @@ module Google
|
|
7097
6981
|
attr_accessor :value_detected_languages
|
7098
6982
|
|
7099
6983
|
# If the value is non-textual, this field represents the type. Current valid
|
7100
|
-
# values are: - blank (this indicates the field_value is normal text) -
|
7101
|
-
# unfilled_checkbox
|
6984
|
+
# values are: - blank (this indicates the `field_value` is normal text) - `
|
6985
|
+
# unfilled_checkbox` - `filled_checkbox`
|
7102
6986
|
# Corresponds to the JSON property `valueType`
|
7103
6987
|
# @return [String]
|
7104
6988
|
attr_accessor :value_type
|
@@ -7167,7 +7051,7 @@ module Google
|
|
7167
7051
|
# @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect>]
|
7168
7052
|
attr_accessor :detected_defects
|
7169
7053
|
|
7170
|
-
# The overall quality score. Range [0, 1] where 1 is perfect quality.
|
7054
|
+
# The overall quality score. Range `[0, 1]` where 1 is perfect quality.
|
7171
7055
|
# Corresponds to the JSON property `qualityScore`
|
7172
7056
|
# @return [Float]
|
7173
7057
|
attr_accessor :quality_score
|
@@ -7187,16 +7071,16 @@ module Google
|
|
7187
7071
|
class GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect
|
7188
7072
|
include Google::Apis::Core::Hashable
|
7189
7073
|
|
7190
|
-
# Confidence of detected defect. Range [0, 1] where 1 indicates strong
|
7074
|
+
# Confidence of detected defect. Range `[0, 1]` where 1 indicates strong
|
7191
7075
|
# confidence of that the defect exists.
|
7192
7076
|
# Corresponds to the JSON property `confidence`
|
7193
7077
|
# @return [Float]
|
7194
7078
|
attr_accessor :confidence
|
7195
7079
|
|
7196
|
-
# Name of the defect type. Supported values are
|
7197
|
-
# quality/defect_noisy
|
7198
|
-
# defect_text_too_small
|
7199
|
-
# defect_text_cutoff
|
7080
|
+
# Name of the defect type. Supported values are: - `quality/defect_blurry` - `
|
7081
|
+
# quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `
|
7082
|
+
# quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/
|
7083
|
+
# defect_text_cutoff` - `quality/defect_glare`
|
7200
7084
|
# Corresponds to the JSON property `type`
|
7201
7085
|
# @return [String]
|
7202
7086
|
attr_accessor :type
|
@@ -7223,7 +7107,7 @@ module Google
|
|
7223
7107
|
|
7224
7108
|
# Confidence of the current Layout within context of the object this layout is
|
7225
7109
|
# for. e.g. confidence can be for a single token, a table, a visual element, etc.
|
7226
|
-
# depending on context. Range [0, 1]
|
7110
|
+
# depending on context. Range `[0, 1]`.
|
7227
7111
|
# Corresponds to the JSON property `confidence`
|
7228
7112
|
# @return [Float]
|
7229
7113
|
attr_accessor :confidence
|
@@ -7864,7 +7748,7 @@ module Google
|
|
7864
7748
|
# @return [Google::Apis::DocumentaiV1::GoogleTypeColor]
|
7865
7749
|
attr_accessor :color
|
7866
7750
|
|
7867
|
-
# Font family such as
|
7751
|
+
# Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/
|
7868
7752
|
# cssref/pr_font_font-family.asp
|
7869
7753
|
# Corresponds to the JSON property `fontFamily`
|
7870
7754
|
# @return [String]
|
@@ -8538,6 +8422,44 @@ module Google
|
|
8538
8422
|
end
|
8539
8423
|
end
|
8540
8424
|
|
8425
|
+
# Metadata of the EvaluateProcessorVersion method.
|
8426
|
+
class GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata
|
8427
|
+
include Google::Apis::Core::Hashable
|
8428
|
+
|
8429
|
+
# The common metadata for long running operations.
|
8430
|
+
# Corresponds to the JSON property `commonMetadata`
|
8431
|
+
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
|
8432
|
+
attr_accessor :common_metadata
|
8433
|
+
|
8434
|
+
def initialize(**args)
|
8435
|
+
update!(**args)
|
8436
|
+
end
|
8437
|
+
|
8438
|
+
# Update properties of this object
|
8439
|
+
def update!(**args)
|
8440
|
+
@common_metadata = args[:common_metadata] if args.key?(:common_metadata)
|
8441
|
+
end
|
8442
|
+
end
|
8443
|
+
|
8444
|
+
# Metadata of the EvaluateProcessorVersion method.
|
8445
|
+
class GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse
|
8446
|
+
include Google::Apis::Core::Hashable
|
8447
|
+
|
8448
|
+
# The resource name of the created evaluation.
|
8449
|
+
# Corresponds to the JSON property `evaluation`
|
8450
|
+
# @return [String]
|
8451
|
+
attr_accessor :evaluation
|
8452
|
+
|
8453
|
+
def initialize(**args)
|
8454
|
+
update!(**args)
|
8455
|
+
end
|
8456
|
+
|
8457
|
+
# Update properties of this object
|
8458
|
+
def update!(**args)
|
8459
|
+
@evaluation = args[:evaluation] if args.key?(:evaluation)
|
8460
|
+
end
|
8461
|
+
end
|
8462
|
+
|
8541
8463
|
# The status of human review on a processed document.
|
8542
8464
|
class GoogleCloudDocumentaiV1beta3HumanReviewStatus
|
8543
8465
|
include Google::Apis::Core::Hashable
|
@@ -8686,6 +8608,99 @@ module Google
|
|
8686
8608
|
end
|
8687
8609
|
end
|
8688
8610
|
|
8611
|
+
# The metadata that represents a processor version being created.
|
8612
|
+
class GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata
|
8613
|
+
include Google::Apis::Core::Hashable
|
8614
|
+
|
8615
|
+
# The common metadata for long running operations.
|
8616
|
+
# Corresponds to the JSON property `commonMetadata`
|
8617
|
+
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
|
8618
|
+
attr_accessor :common_metadata
|
8619
|
+
|
8620
|
+
# The dataset validation information. This includes any and all errors with
|
8621
|
+
# documents and the dataset.
|
8622
|
+
# Corresponds to the JSON property `testDatasetValidation`
|
8623
|
+
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation]
|
8624
|
+
attr_accessor :test_dataset_validation
|
8625
|
+
|
8626
|
+
# The dataset validation information. This includes any and all errors with
|
8627
|
+
# documents and the dataset.
|
8628
|
+
# Corresponds to the JSON property `trainingDatasetValidation`
|
8629
|
+
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation]
|
8630
|
+
attr_accessor :training_dataset_validation
|
8631
|
+
|
8632
|
+
def initialize(**args)
|
8633
|
+
update!(**args)
|
8634
|
+
end
|
8635
|
+
|
8636
|
+
# Update properties of this object
|
8637
|
+
def update!(**args)
|
8638
|
+
@common_metadata = args[:common_metadata] if args.key?(:common_metadata)
|
8639
|
+
@test_dataset_validation = args[:test_dataset_validation] if args.key?(:test_dataset_validation)
|
8640
|
+
@training_dataset_validation = args[:training_dataset_validation] if args.key?(:training_dataset_validation)
|
8641
|
+
end
|
8642
|
+
end
|
8643
|
+
|
8644
|
+
# The dataset validation information. This includes any and all errors with
|
8645
|
+
# documents and the dataset.
|
8646
|
+
class GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation
|
8647
|
+
include Google::Apis::Core::Hashable
|
8648
|
+
|
8649
|
+
# The total number of dataset errors.
|
8650
|
+
# Corresponds to the JSON property `datasetErrorCount`
|
8651
|
+
# @return [Fixnum]
|
8652
|
+
attr_accessor :dataset_error_count
|
8653
|
+
|
8654
|
+
# Error information for the dataset as a whole. A maximum of 10 dataset errors
|
8655
|
+
# will be returned. A single dataset error is terminal for training.
|
8656
|
+
# Corresponds to the JSON property `datasetErrors`
|
8657
|
+
# @return [Array<Google::Apis::DocumentaiV1::GoogleRpcStatus>]
|
8658
|
+
attr_accessor :dataset_errors
|
8659
|
+
|
8660
|
+
# The total number of document errors.
|
8661
|
+
# Corresponds to the JSON property `documentErrorCount`
|
8662
|
+
# @return [Fixnum]
|
8663
|
+
attr_accessor :document_error_count
|
8664
|
+
|
8665
|
+
# Error information pertaining to specific documents. A maximum of 10 document
|
8666
|
+
# errors will be returned. Any document with errors will not be used throughout
|
8667
|
+
# training.
|
8668
|
+
# Corresponds to the JSON property `documentErrors`
|
8669
|
+
# @return [Array<Google::Apis::DocumentaiV1::GoogleRpcStatus>]
|
8670
|
+
attr_accessor :document_errors
|
8671
|
+
|
8672
|
+
def initialize(**args)
|
8673
|
+
update!(**args)
|
8674
|
+
end
|
8675
|
+
|
8676
|
+
# Update properties of this object
|
8677
|
+
def update!(**args)
|
8678
|
+
@dataset_error_count = args[:dataset_error_count] if args.key?(:dataset_error_count)
|
8679
|
+
@dataset_errors = args[:dataset_errors] if args.key?(:dataset_errors)
|
8680
|
+
@document_error_count = args[:document_error_count] if args.key?(:document_error_count)
|
8681
|
+
@document_errors = args[:document_errors] if args.key?(:document_errors)
|
8682
|
+
end
|
8683
|
+
end
|
8684
|
+
|
8685
|
+
# The response for the TrainProcessorVersion method.
|
8686
|
+
class GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse
|
8687
|
+
include Google::Apis::Core::Hashable
|
8688
|
+
|
8689
|
+
# The resource name of the processor version produced by training.
|
8690
|
+
# Corresponds to the JSON property `processorVersion`
|
8691
|
+
# @return [String]
|
8692
|
+
attr_accessor :processor_version
|
8693
|
+
|
8694
|
+
def initialize(**args)
|
8695
|
+
update!(**args)
|
8696
|
+
end
|
8697
|
+
|
8698
|
+
# Update properties of this object
|
8699
|
+
def update!(**args)
|
8700
|
+
@processor_version = args[:processor_version] if args.key?(:processor_version)
|
8701
|
+
end
|
8702
|
+
end
|
8703
|
+
|
8689
8704
|
# The long running operation metadata for the undeploy processor version method.
|
8690
8705
|
class GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata
|
8691
8706
|
include Google::Apis::Core::Hashable
|