google-apis-documentai_v1beta3 0.9.0 → 0.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/lib/google/apis/documentai_v1beta3/classes.rb +373 -0
- data/lib/google/apis/documentai_v1beta3/gem_version.rb +2 -2
- data/lib/google/apis/documentai_v1beta3/representations.rb +150 -0
- data/lib/google/apis/documentai_v1beta3/service.rb +205 -1
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1aa25fad55cc0c214c32a60e65f850828ce9bd516e4d3cf9bc2dafe5503390a5
|
4
|
+
data.tar.gz: 18265cd85a0099179545556f326e59eaffbc08b5b11ddcc74f6fa78ab569a81f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bd6d06dbc86fed7b70d864f20e65cefd22de8d9d25d83f39cb46625e98676ed905887523221df94f25f065f1da3b0de89e370eccb696853093fd294980836c7a
|
7
|
+
data.tar.gz: 7e79fd04b1269c067cae5abc43947691c49ab1bd9c816a20e95b2933d7c869f15d8ac20d001edaf674449670c0670a0ba87f9645592964cba7e43194f1a63387
|
data/CHANGELOG.md
CHANGED
@@ -341,12 +341,22 @@ module Google
|
|
341
341
|
class GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation
|
342
342
|
include Google::Apis::Core::Hashable
|
343
343
|
|
344
|
+
# The total number of dataset errors.
|
345
|
+
# Corresponds to the JSON property `datasetErrorCount`
|
346
|
+
# @return [Fixnum]
|
347
|
+
attr_accessor :dataset_error_count
|
348
|
+
|
344
349
|
# Error information for the dataset as a whole. A maximum of 10 dataset errors
|
345
350
|
# will be returned. A single dataset error is terminal for training.
|
346
351
|
# Corresponds to the JSON property `datasetErrors`
|
347
352
|
# @return [Array<Google::Apis::DocumentaiV1beta3::GoogleRpcStatus>]
|
348
353
|
attr_accessor :dataset_errors
|
349
354
|
|
355
|
+
# The total number of document errors.
|
356
|
+
# Corresponds to the JSON property `documentErrorCount`
|
357
|
+
# @return [Fixnum]
|
358
|
+
attr_accessor :document_error_count
|
359
|
+
|
350
360
|
# Error information pertaining to specific documents. A maximum of 10 document
|
351
361
|
# errors will be returned. Any document with errors will not be used throughout
|
352
362
|
# training.
|
@@ -360,7 +370,9 @@ module Google
|
|
360
370
|
|
361
371
|
# Update properties of this object
|
362
372
|
def update!(**args)
|
373
|
+
@dataset_error_count = args[:dataset_error_count] if args.key?(:dataset_error_count)
|
363
374
|
@dataset_errors = args[:dataset_errors] if args.key?(:dataset_errors)
|
375
|
+
@document_error_count = args[:document_error_count] if args.key?(:document_error_count)
|
364
376
|
@document_errors = args[:document_errors] if args.key?(:document_errors)
|
365
377
|
end
|
366
378
|
end
|
@@ -1146,6 +1158,11 @@ module Google
|
|
1146
1158
|
# @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1BoundingPoly]
|
1147
1159
|
attr_accessor :bounding_poly
|
1148
1160
|
|
1161
|
+
# Optional. Confidence of detected page element, if applicable. Range [0, 1].
|
1162
|
+
# Corresponds to the JSON property `confidence`
|
1163
|
+
# @return [Float]
|
1164
|
+
attr_accessor :confidence
|
1165
|
+
|
1149
1166
|
# Optional. Deprecated. Use PageRef.bounding_poly instead.
|
1150
1167
|
# Corresponds to the JSON property `layoutId`
|
1151
1168
|
# @return [String]
|
@@ -1169,6 +1186,7 @@ module Google
|
|
1169
1186
|
# Update properties of this object
|
1170
1187
|
def update!(**args)
|
1171
1188
|
@bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly)
|
1189
|
+
@confidence = args[:confidence] if args.key?(:confidence)
|
1172
1190
|
@layout_id = args[:layout_id] if args.key?(:layout_id)
|
1173
1191
|
@layout_type = args[:layout_type] if args.key?(:layout_type)
|
1174
1192
|
@page = args[:page] if args.key?(:page)
|
@@ -1723,6 +1741,12 @@ module Google
|
|
1723
1741
|
# @return [Fixnum]
|
1724
1742
|
attr_accessor :id
|
1725
1743
|
|
1744
|
+
# The index of the parent revisions corresponding collection of items (eg. list
|
1745
|
+
# of entities, properties within entities, etc.)
|
1746
|
+
# Corresponds to the JSON property `index`
|
1747
|
+
# @return [Fixnum]
|
1748
|
+
attr_accessor :index
|
1749
|
+
|
1726
1750
|
# The index of the [Document.revisions] identifying the parent revision.
|
1727
1751
|
# Corresponds to the JSON property `revision`
|
1728
1752
|
# @return [Fixnum]
|
@@ -1735,6 +1759,7 @@ module Google
|
|
1735
1759
|
# Update properties of this object
|
1736
1760
|
def update!(**args)
|
1737
1761
|
@id = args[:id] if args.key?(:id)
|
1762
|
+
@index = args[:index] if args.key?(:index)
|
1738
1763
|
@revision = args[:revision] if args.key?(:revision)
|
1739
1764
|
end
|
1740
1765
|
end
|
@@ -2841,6 +2866,11 @@ module Google
|
|
2841
2866
|
# @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2BoundingPoly]
|
2842
2867
|
attr_accessor :bounding_poly
|
2843
2868
|
|
2869
|
+
# Optional. Confidence of detected page element, if applicable. Range [0, 1].
|
2870
|
+
# Corresponds to the JSON property `confidence`
|
2871
|
+
# @return [Float]
|
2872
|
+
attr_accessor :confidence
|
2873
|
+
|
2844
2874
|
# Optional. Deprecated. Use PageRef.bounding_poly instead.
|
2845
2875
|
# Corresponds to the JSON property `layoutId`
|
2846
2876
|
# @return [String]
|
@@ -2864,6 +2894,7 @@ module Google
|
|
2864
2894
|
# Update properties of this object
|
2865
2895
|
def update!(**args)
|
2866
2896
|
@bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly)
|
2897
|
+
@confidence = args[:confidence] if args.key?(:confidence)
|
2867
2898
|
@layout_id = args[:layout_id] if args.key?(:layout_id)
|
2868
2899
|
@layout_type = args[:layout_type] if args.key?(:layout_type)
|
2869
2900
|
@page = args[:page] if args.key?(:page)
|
@@ -3418,6 +3449,12 @@ module Google
|
|
3418
3449
|
# @return [Fixnum]
|
3419
3450
|
attr_accessor :id
|
3420
3451
|
|
3452
|
+
# The index of the parent revisions corresponding collection of items (eg. list
|
3453
|
+
# of entities, properties within entities, etc.)
|
3454
|
+
# Corresponds to the JSON property `index`
|
3455
|
+
# @return [Fixnum]
|
3456
|
+
attr_accessor :index
|
3457
|
+
|
3421
3458
|
# The index of the [Document.revisions] identifying the parent revision.
|
3422
3459
|
# Corresponds to the JSON property `revision`
|
3423
3460
|
# @return [Fixnum]
|
@@ -3430,6 +3467,7 @@ module Google
|
|
3430
3467
|
# Update properties of this object
|
3431
3468
|
def update!(**args)
|
3432
3469
|
@id = args[:id] if args.key?(:id)
|
3470
|
+
@index = args[:index] if args.key?(:index)
|
3433
3471
|
@revision = args[:revision] if args.key?(:revision)
|
3434
3472
|
end
|
3435
3473
|
end
|
@@ -4315,6 +4353,19 @@ module Google
|
|
4315
4353
|
end
|
4316
4354
|
end
|
4317
4355
|
|
4356
|
+
# Request message for the disable processor method.
|
4357
|
+
class GoogleCloudDocumentaiV1beta3DisableProcessorRequest
|
4358
|
+
include Google::Apis::Core::Hashable
|
4359
|
+
|
4360
|
+
def initialize(**args)
|
4361
|
+
update!(**args)
|
4362
|
+
end
|
4363
|
+
|
4364
|
+
# Update properties of this object
|
4365
|
+
def update!(**args)
|
4366
|
+
end
|
4367
|
+
end
|
4368
|
+
|
4318
4369
|
# Document represents the canonical document resource in Document Understanding
|
4319
4370
|
# AI. It is an interchange format that provides insights into documents and
|
4320
4371
|
# allows for collaboration between users and Document Understanding AI to
|
@@ -4788,6 +4839,11 @@ module Google
|
|
4788
4839
|
# @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BoundingPoly]
|
4789
4840
|
attr_accessor :bounding_poly
|
4790
4841
|
|
4842
|
+
# Optional. Confidence of detected page element, if applicable. Range [0, 1].
|
4843
|
+
# Corresponds to the JSON property `confidence`
|
4844
|
+
# @return [Float]
|
4845
|
+
attr_accessor :confidence
|
4846
|
+
|
4791
4847
|
# Optional. Deprecated. Use PageRef.bounding_poly instead.
|
4792
4848
|
# Corresponds to the JSON property `layoutId`
|
4793
4849
|
# @return [String]
|
@@ -4811,6 +4867,7 @@ module Google
|
|
4811
4867
|
# Update properties of this object
|
4812
4868
|
def update!(**args)
|
4813
4869
|
@bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly)
|
4870
|
+
@confidence = args[:confidence] if args.key?(:confidence)
|
4814
4871
|
@layout_id = args[:layout_id] if args.key?(:layout_id)
|
4815
4872
|
@layout_type = args[:layout_type] if args.key?(:layout_type)
|
4816
4873
|
@page = args[:page] if args.key?(:page)
|
@@ -5365,6 +5422,12 @@ module Google
|
|
5365
5422
|
# @return [Fixnum]
|
5366
5423
|
attr_accessor :id
|
5367
5424
|
|
5425
|
+
# The index of the parent revisions corresponding collection of items (eg. list
|
5426
|
+
# of entities, properties within entities, etc.)
|
5427
|
+
# Corresponds to the JSON property `index`
|
5428
|
+
# @return [Fixnum]
|
5429
|
+
attr_accessor :index
|
5430
|
+
|
5368
5431
|
# The index of the [Document.revisions] identifying the parent revision.
|
5369
5432
|
# Corresponds to the JSON property `revision`
|
5370
5433
|
# @return [Fixnum]
|
@@ -5377,6 +5440,7 @@ module Google
|
|
5377
5440
|
# Update properties of this object
|
5378
5441
|
def update!(**args)
|
5379
5442
|
@id = args[:id] if args.key?(:id)
|
5443
|
+
@index = args[:index] if args.key?(:index)
|
5380
5444
|
@revision = args[:revision] if args.key?(:revision)
|
5381
5445
|
end
|
5382
5446
|
end
|
@@ -5748,6 +5812,38 @@ module Google
|
|
5748
5812
|
end
|
5749
5813
|
end
|
5750
5814
|
|
5815
|
+
# Request message for the enable processor method.
|
5816
|
+
class GoogleCloudDocumentaiV1beta3EnableProcessorRequest
|
5817
|
+
include Google::Apis::Core::Hashable
|
5818
|
+
|
5819
|
+
def initialize(**args)
|
5820
|
+
update!(**args)
|
5821
|
+
end
|
5822
|
+
|
5823
|
+
# Update properties of this object
|
5824
|
+
def update!(**args)
|
5825
|
+
end
|
5826
|
+
end
|
5827
|
+
|
5828
|
+
# Response message for fetch processor types.
|
5829
|
+
class GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse
|
5830
|
+
include Google::Apis::Core::Hashable
|
5831
|
+
|
5832
|
+
# The list of processor types.
|
5833
|
+
# Corresponds to the JSON property `processorTypes`
|
5834
|
+
# @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessorType>]
|
5835
|
+
attr_accessor :processor_types
|
5836
|
+
|
5837
|
+
def initialize(**args)
|
5838
|
+
update!(**args)
|
5839
|
+
end
|
5840
|
+
|
5841
|
+
# Update properties of this object
|
5842
|
+
def update!(**args)
|
5843
|
+
@processor_types = args[:processor_types] if args.key?(:processor_types)
|
5844
|
+
end
|
5845
|
+
end
|
5846
|
+
|
5751
5847
|
# Specifies a document stored on Cloud Storage.
|
5752
5848
|
class GoogleCloudDocumentaiV1beta3GcsDocument
|
5753
5849
|
include Google::Apis::Core::Hashable
|
@@ -5845,6 +5941,31 @@ module Google
|
|
5845
5941
|
end
|
5846
5942
|
end
|
5847
5943
|
|
5944
|
+
# Response message for list processors.
|
5945
|
+
class GoogleCloudDocumentaiV1beta3ListProcessorsResponse
|
5946
|
+
include Google::Apis::Core::Hashable
|
5947
|
+
|
5948
|
+
# Points to the next processor, otherwise empty.
|
5949
|
+
# Corresponds to the JSON property `nextPageToken`
|
5950
|
+
# @return [String]
|
5951
|
+
attr_accessor :next_page_token
|
5952
|
+
|
5953
|
+
# The list of processors.
|
5954
|
+
# Corresponds to the JSON property `processors`
|
5955
|
+
# @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor>]
|
5956
|
+
attr_accessor :processors
|
5957
|
+
|
5958
|
+
def initialize(**args)
|
5959
|
+
update!(**args)
|
5960
|
+
end
|
5961
|
+
|
5962
|
+
# Update properties of this object
|
5963
|
+
def update!(**args)
|
5964
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
5965
|
+
@processors = args[:processors] if args.key?(:processors)
|
5966
|
+
end
|
5967
|
+
end
|
5968
|
+
|
5848
5969
|
# A vertex represents a 2D point in the image. NOTE: the normalized vertex
|
5849
5970
|
# coordinates are relative to the original image and range from 0 to 1.
|
5850
5971
|
class GoogleCloudDocumentaiV1beta3NormalizedVertex
|
@@ -5953,6 +6074,158 @@ module Google
|
|
5953
6074
|
end
|
5954
6075
|
end
|
5955
6076
|
|
6077
|
+
# The first-class citizen for DAI. Each processor defines how to extract
|
6078
|
+
# structural information from a document.
|
6079
|
+
class GoogleCloudDocumentaiV1beta3Processor
|
6080
|
+
include Google::Apis::Core::Hashable
|
6081
|
+
|
6082
|
+
# The time the processor was created.
|
6083
|
+
# Corresponds to the JSON property `createTime`
|
6084
|
+
# @return [String]
|
6085
|
+
attr_accessor :create_time
|
6086
|
+
|
6087
|
+
# The default processor version.
|
6088
|
+
# Corresponds to the JSON property `defaultProcessorVersion`
|
6089
|
+
# @return [String]
|
6090
|
+
attr_accessor :default_processor_version
|
6091
|
+
|
6092
|
+
# The display name of the processor.
|
6093
|
+
# Corresponds to the JSON property `displayName`
|
6094
|
+
# @return [String]
|
6095
|
+
attr_accessor :display_name
|
6096
|
+
|
6097
|
+
# The KMS key used for encryption/decryption in CMEK scenarios. See https://
|
6098
|
+
# cloud.google.com/security-key-management.
|
6099
|
+
# Corresponds to the JSON property `kmsKeyName`
|
6100
|
+
# @return [String]
|
6101
|
+
attr_accessor :kms_key_name
|
6102
|
+
|
6103
|
+
# Output only. Immutable. The resource name of the processor. Format: projects/`
|
6104
|
+
# project`/locations/`location`/processors/`processor`
|
6105
|
+
# Corresponds to the JSON property `name`
|
6106
|
+
# @return [String]
|
6107
|
+
attr_accessor :name
|
6108
|
+
|
6109
|
+
# Output only. Immutable. The http endpoint that can be called to invoke
|
6110
|
+
# processing.
|
6111
|
+
# Corresponds to the JSON property `processEndpoint`
|
6112
|
+
# @return [String]
|
6113
|
+
attr_accessor :process_endpoint
|
6114
|
+
|
6115
|
+
# Output only. The state of the processor.
|
6116
|
+
# Corresponds to the JSON property `state`
|
6117
|
+
# @return [String]
|
6118
|
+
attr_accessor :state
|
6119
|
+
|
6120
|
+
# The processor type, e.g., INVOICE_PARSING, W2_PARSING, etc.
|
6121
|
+
# Corresponds to the JSON property `type`
|
6122
|
+
# @return [String]
|
6123
|
+
attr_accessor :type
|
6124
|
+
|
6125
|
+
def initialize(**args)
|
6126
|
+
update!(**args)
|
6127
|
+
end
|
6128
|
+
|
6129
|
+
# Update properties of this object
|
6130
|
+
def update!(**args)
|
6131
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
6132
|
+
@default_processor_version = args[:default_processor_version] if args.key?(:default_processor_version)
|
6133
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
6134
|
+
@kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
|
6135
|
+
@name = args[:name] if args.key?(:name)
|
6136
|
+
@process_endpoint = args[:process_endpoint] if args.key?(:process_endpoint)
|
6137
|
+
@state = args[:state] if args.key?(:state)
|
6138
|
+
@type = args[:type] if args.key?(:type)
|
6139
|
+
end
|
6140
|
+
end
|
6141
|
+
|
6142
|
+
# A processor type is responsible for performing a certain document
|
6143
|
+
# understanding task on a certain type of document. All processor types are
|
6144
|
+
# created by the documentai service internally. User will only list all
|
6145
|
+
# available processor types via UI. For different users (projects), the
|
6146
|
+
# available processor types may be different since we'll expose the access of
|
6147
|
+
# some types via EAP whitelisting. We make the ProcessorType a resource under
|
6148
|
+
# location so we have a unified API and keep the possibility that UI will load
|
6149
|
+
# different available processor types from different regions. But for alpha the
|
6150
|
+
# behavior is that the user will always get the union of all available processor
|
6151
|
+
# types among all regions no matter which regionalized endpoint is called, and
|
6152
|
+
# then we use the 'available_locations' field to show under which regions a
|
6153
|
+
# processor type is available. For example, users can call either the 'US' or '
|
6154
|
+
# EU' endpoint to feach processor types. In the return, we will have an 'invoice
|
6155
|
+
# parsing' processor with 'available_locations' field only containing 'US'. So
|
6156
|
+
# the user can try to create an 'invoice parsing' processor under the location '
|
6157
|
+
# US'. Such attempt of creating under the location 'EU' will fail. Next ID: 7.
|
6158
|
+
class GoogleCloudDocumentaiV1beta3ProcessorType
|
6159
|
+
include Google::Apis::Core::Hashable
|
6160
|
+
|
6161
|
+
# Whether the processor type allows creation. If yes, user can create a
|
6162
|
+
# processor of this processor type. Otherwise, user needs to require for
|
6163
|
+
# whitelisting.
|
6164
|
+
# Corresponds to the JSON property `allowCreation`
|
6165
|
+
# @return [Boolean]
|
6166
|
+
attr_accessor :allow_creation
|
6167
|
+
alias_method :allow_creation?, :allow_creation
|
6168
|
+
|
6169
|
+
# The locations in which this processor is available.
|
6170
|
+
# Corresponds to the JSON property `availableLocations`
|
6171
|
+
# @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo>]
|
6172
|
+
attr_accessor :available_locations
|
6173
|
+
|
6174
|
+
# The processor category, used by UI to group processor types.
|
6175
|
+
# Corresponds to the JSON property `category`
|
6176
|
+
# @return [String]
|
6177
|
+
attr_accessor :category
|
6178
|
+
|
6179
|
+
# The resource name of the processor type. Format: projects/`project`/
|
6180
|
+
# processorTypes/`processor_type`
|
6181
|
+
# Corresponds to the JSON property `name`
|
6182
|
+
# @return [String]
|
6183
|
+
attr_accessor :name
|
6184
|
+
|
6185
|
+
# The schema defines the output of the processed document by a processor.
|
6186
|
+
# Corresponds to the JSON property `schema`
|
6187
|
+
# @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Schema]
|
6188
|
+
attr_accessor :schema
|
6189
|
+
|
6190
|
+
# The type of the processor, e.g, "invoice_parsing".
|
6191
|
+
# Corresponds to the JSON property `type`
|
6192
|
+
# @return [String]
|
6193
|
+
attr_accessor :type
|
6194
|
+
|
6195
|
+
def initialize(**args)
|
6196
|
+
update!(**args)
|
6197
|
+
end
|
6198
|
+
|
6199
|
+
# Update properties of this object
|
6200
|
+
def update!(**args)
|
6201
|
+
@allow_creation = args[:allow_creation] if args.key?(:allow_creation)
|
6202
|
+
@available_locations = args[:available_locations] if args.key?(:available_locations)
|
6203
|
+
@category = args[:category] if args.key?(:category)
|
6204
|
+
@name = args[:name] if args.key?(:name)
|
6205
|
+
@schema = args[:schema] if args.key?(:schema)
|
6206
|
+
@type = args[:type] if args.key?(:type)
|
6207
|
+
end
|
6208
|
+
end
|
6209
|
+
|
6210
|
+
# The location information about where the processor is available.
|
6211
|
+
class GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo
|
6212
|
+
include Google::Apis::Core::Hashable
|
6213
|
+
|
6214
|
+
# The location id, currently must be one of [us, eu].
|
6215
|
+
# Corresponds to the JSON property `locationId`
|
6216
|
+
# @return [String]
|
6217
|
+
attr_accessor :location_id
|
6218
|
+
|
6219
|
+
def initialize(**args)
|
6220
|
+
update!(**args)
|
6221
|
+
end
|
6222
|
+
|
6223
|
+
# Update properties of this object
|
6224
|
+
def update!(**args)
|
6225
|
+
@location_id = args[:location_id] if args.key?(:location_id)
|
6226
|
+
end
|
6227
|
+
end
|
6228
|
+
|
5956
6229
|
# Payload message of raw document content (bytes).
|
5957
6230
|
class GoogleCloudDocumentaiV1beta3RawDocument
|
5958
6231
|
include Google::Apis::Core::Hashable
|
@@ -6073,6 +6346,106 @@ module Google
|
|
6073
6346
|
end
|
6074
6347
|
end
|
6075
6348
|
|
6349
|
+
# The schema defines the output of the processed document by a processor.
|
6350
|
+
class GoogleCloudDocumentaiV1beta3Schema
|
6351
|
+
include Google::Apis::Core::Hashable
|
6352
|
+
|
6353
|
+
# Description of the schema.
|
6354
|
+
# Corresponds to the JSON property `description`
|
6355
|
+
# @return [String]
|
6356
|
+
attr_accessor :description
|
6357
|
+
|
6358
|
+
# Display name to show to users.
|
6359
|
+
# Corresponds to the JSON property `displayName`
|
6360
|
+
# @return [String]
|
6361
|
+
attr_accessor :display_name
|
6362
|
+
|
6363
|
+
# Entity types of the schema.
|
6364
|
+
# Corresponds to the JSON property `entityTypes`
|
6365
|
+
# @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaEntityType>]
|
6366
|
+
attr_accessor :entity_types
|
6367
|
+
|
6368
|
+
def initialize(**args)
|
6369
|
+
update!(**args)
|
6370
|
+
end
|
6371
|
+
|
6372
|
+
# Update properties of this object
|
6373
|
+
def update!(**args)
|
6374
|
+
@description = args[:description] if args.key?(:description)
|
6375
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
6376
|
+
@entity_types = args[:entity_types] if args.key?(:entity_types)
|
6377
|
+
end
|
6378
|
+
end
|
6379
|
+
|
6380
|
+
# EntityType is the wrapper of a label of the corresponding model with detailed
|
6381
|
+
# attributes and limitations for entity-based processors. Multiple types can
|
6382
|
+
# also compose a dependency tree to represent nested types.
|
6383
|
+
class GoogleCloudDocumentaiV1beta3SchemaEntityType
|
6384
|
+
include Google::Apis::Core::Hashable
|
6385
|
+
|
6386
|
+
# Type of the entity. It must be one of the following: `document` - the entity
|
6387
|
+
# represents a classification of a logical document. `object` - if the entity
|
6388
|
+
# has properties it is likely an object (or or a document.) `datetime` - the
|
6389
|
+
# entity is a date or time value. `money` - the entity represents a money value
|
6390
|
+
# amount. `number` - the entity is a number - integer or floating point. `string`
|
6391
|
+
# - the entity is a string value. `boolean` - the entity is a boolean value. `
|
6392
|
+
# address` - the entity is a location address.
|
6393
|
+
# Corresponds to the JSON property `baseType`
|
6394
|
+
# @return [String]
|
6395
|
+
attr_accessor :base_type
|
6396
|
+
|
6397
|
+
# Description of the entity type.
|
6398
|
+
# Corresponds to the JSON property `description`
|
6399
|
+
# @return [String]
|
6400
|
+
attr_accessor :description
|
6401
|
+
|
6402
|
+
# For some entity types there are only a few possible values. They can be
|
6403
|
+
# specified here.
|
6404
|
+
# Corresponds to the JSON property `enumValues`
|
6405
|
+
# @return [Array<String>]
|
6406
|
+
attr_accessor :enum_values
|
6407
|
+
|
6408
|
+
# Occurrence type limits the number of times an entity type appears in the
|
6409
|
+
# document.
|
6410
|
+
# Corresponds to the JSON property `occurrenceType`
|
6411
|
+
# @return [String]
|
6412
|
+
attr_accessor :occurrence_type
|
6413
|
+
|
6414
|
+
# Describing the nested structure of an entity. An EntityType may consist of
|
6415
|
+
# several other EntityTypes. For example, in a document there can be an
|
6416
|
+
# EntityType 'ID', which consists of EntityType 'name' and 'address', with
|
6417
|
+
# corresponding attributes, such as TEXT for both types and ONCE for occurrence
|
6418
|
+
# types.
|
6419
|
+
# Corresponds to the JSON property `properties`
|
6420
|
+
# @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaEntityType>]
|
6421
|
+
attr_accessor :properties
|
6422
|
+
|
6423
|
+
# Source of this entity type.
|
6424
|
+
# Corresponds to the JSON property `source`
|
6425
|
+
# @return [String]
|
6426
|
+
attr_accessor :source
|
6427
|
+
|
6428
|
+
# Name of the type. It must be unique within the set of same level types.
|
6429
|
+
# Corresponds to the JSON property `type`
|
6430
|
+
# @return [String]
|
6431
|
+
attr_accessor :type
|
6432
|
+
|
6433
|
+
def initialize(**args)
|
6434
|
+
update!(**args)
|
6435
|
+
end
|
6436
|
+
|
6437
|
+
# Update properties of this object
|
6438
|
+
def update!(**args)
|
6439
|
+
@base_type = args[:base_type] if args.key?(:base_type)
|
6440
|
+
@description = args[:description] if args.key?(:description)
|
6441
|
+
@enum_values = args[:enum_values] if args.key?(:enum_values)
|
6442
|
+
@occurrence_type = args[:occurrence_type] if args.key?(:occurrence_type)
|
6443
|
+
@properties = args[:properties] if args.key?(:properties)
|
6444
|
+
@source = args[:source] if args.key?(:source)
|
6445
|
+
@type = args[:type] if args.key?(:type)
|
6446
|
+
end
|
6447
|
+
end
|
6448
|
+
|
6076
6449
|
# A vertex represents a 2D point in the image. NOTE: the vertex coordinates are
|
6077
6450
|
# in the same scale as the original image.
|
6078
6451
|
class GoogleCloudDocumentaiV1beta3Vertex
|
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module DocumentaiV1beta3
|
18
18
|
# Version of the google-apis-documentai_v1beta3 gem
|
19
|
-
GEM_VERSION = "0.
|
19
|
+
GEM_VERSION = "0.10.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
22
|
GENERATOR_VERSION = "0.2.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20210507"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -760,6 +760,12 @@ module Google
|
|
760
760
|
include Google::Apis::Core::JsonObjectSupport
|
761
761
|
end
|
762
762
|
|
763
|
+
class GoogleCloudDocumentaiV1beta3DisableProcessorRequest
|
764
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
765
|
+
|
766
|
+
include Google::Apis::Core::JsonObjectSupport
|
767
|
+
end
|
768
|
+
|
763
769
|
class GoogleCloudDocumentaiV1beta3Document
|
764
770
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
765
771
|
|
@@ -964,6 +970,18 @@ module Google
|
|
964
970
|
include Google::Apis::Core::JsonObjectSupport
|
965
971
|
end
|
966
972
|
|
973
|
+
class GoogleCloudDocumentaiV1beta3EnableProcessorRequest
|
974
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
975
|
+
|
976
|
+
include Google::Apis::Core::JsonObjectSupport
|
977
|
+
end
|
978
|
+
|
979
|
+
class GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse
|
980
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
981
|
+
|
982
|
+
include Google::Apis::Core::JsonObjectSupport
|
983
|
+
end
|
984
|
+
|
967
985
|
class GoogleCloudDocumentaiV1beta3GcsDocument
|
968
986
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
969
987
|
|
@@ -988,6 +1006,12 @@ module Google
|
|
988
1006
|
include Google::Apis::Core::JsonObjectSupport
|
989
1007
|
end
|
990
1008
|
|
1009
|
+
class GoogleCloudDocumentaiV1beta3ListProcessorsResponse
|
1010
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1011
|
+
|
1012
|
+
include Google::Apis::Core::JsonObjectSupport
|
1013
|
+
end
|
1014
|
+
|
991
1015
|
class GoogleCloudDocumentaiV1beta3NormalizedVertex
|
992
1016
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
993
1017
|
|
@@ -1006,6 +1030,24 @@ module Google
|
|
1006
1030
|
include Google::Apis::Core::JsonObjectSupport
|
1007
1031
|
end
|
1008
1032
|
|
1033
|
+
class GoogleCloudDocumentaiV1beta3Processor
|
1034
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1035
|
+
|
1036
|
+
include Google::Apis::Core::JsonObjectSupport
|
1037
|
+
end
|
1038
|
+
|
1039
|
+
class GoogleCloudDocumentaiV1beta3ProcessorType
|
1040
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1041
|
+
|
1042
|
+
include Google::Apis::Core::JsonObjectSupport
|
1043
|
+
end
|
1044
|
+
|
1045
|
+
class GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo
|
1046
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1047
|
+
|
1048
|
+
include Google::Apis::Core::JsonObjectSupport
|
1049
|
+
end
|
1050
|
+
|
1009
1051
|
class GoogleCloudDocumentaiV1beta3RawDocument
|
1010
1052
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1011
1053
|
|
@@ -1030,6 +1072,18 @@ module Google
|
|
1030
1072
|
include Google::Apis::Core::JsonObjectSupport
|
1031
1073
|
end
|
1032
1074
|
|
1075
|
+
class GoogleCloudDocumentaiV1beta3Schema
|
1076
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1077
|
+
|
1078
|
+
include Google::Apis::Core::JsonObjectSupport
|
1079
|
+
end
|
1080
|
+
|
1081
|
+
class GoogleCloudDocumentaiV1beta3SchemaEntityType
|
1082
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1083
|
+
|
1084
|
+
include Google::Apis::Core::JsonObjectSupport
|
1085
|
+
end
|
1086
|
+
|
1033
1087
|
class GoogleCloudDocumentaiV1beta3Vertex
|
1034
1088
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1035
1089
|
|
@@ -1230,8 +1284,10 @@ module Google
|
|
1230
1284
|
class GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation
|
1231
1285
|
# @private
|
1232
1286
|
class Representation < Google::Apis::Core::JsonRepresentation
|
1287
|
+
property :dataset_error_count, as: 'datasetErrorCount'
|
1233
1288
|
collection :dataset_errors, as: 'datasetErrors', class: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus::Representation
|
1234
1289
|
|
1290
|
+
property :document_error_count, as: 'documentErrorCount'
|
1235
1291
|
collection :document_errors, as: 'documentErrors', class: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus::Representation
|
1236
1292
|
|
1237
1293
|
end
|
@@ -1473,6 +1529,7 @@ module Google
|
|
1473
1529
|
class Representation < Google::Apis::Core::JsonRepresentation
|
1474
1530
|
property :bounding_poly, as: 'boundingPoly', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1BoundingPoly, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1BoundingPoly::Representation
|
1475
1531
|
|
1532
|
+
property :confidence, as: 'confidence'
|
1476
1533
|
property :layout_id, as: 'layoutId'
|
1477
1534
|
property :layout_type, as: 'layoutType'
|
1478
1535
|
property :page, :numeric_string => true, as: 'page'
|
@@ -1660,6 +1717,7 @@ module Google
|
|
1660
1717
|
# @private
|
1661
1718
|
class Representation < Google::Apis::Core::JsonRepresentation
|
1662
1719
|
property :id, as: 'id'
|
1720
|
+
property :index, as: 'index'
|
1663
1721
|
property :revision, as: 'revision'
|
1664
1722
|
end
|
1665
1723
|
end
|
@@ -1961,6 +2019,7 @@ module Google
|
|
1961
2019
|
class Representation < Google::Apis::Core::JsonRepresentation
|
1962
2020
|
property :bounding_poly, as: 'boundingPoly', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2BoundingPoly, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2BoundingPoly::Representation
|
1963
2021
|
|
2022
|
+
property :confidence, as: 'confidence'
|
1964
2023
|
property :layout_id, as: 'layoutId'
|
1965
2024
|
property :layout_type, as: 'layoutType'
|
1966
2025
|
property :page, :numeric_string => true, as: 'page'
|
@@ -2148,6 +2207,7 @@ module Google
|
|
2148
2207
|
# @private
|
2149
2208
|
class Representation < Google::Apis::Core::JsonRepresentation
|
2150
2209
|
property :id, as: 'id'
|
2210
|
+
property :index, as: 'index'
|
2151
2211
|
property :revision, as: 'revision'
|
2152
2212
|
end
|
2153
2213
|
end
|
@@ -2395,6 +2455,12 @@ module Google
|
|
2395
2455
|
end
|
2396
2456
|
end
|
2397
2457
|
|
2458
|
+
class GoogleCloudDocumentaiV1beta3DisableProcessorRequest
|
2459
|
+
# @private
|
2460
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2461
|
+
end
|
2462
|
+
end
|
2463
|
+
|
2398
2464
|
class GoogleCloudDocumentaiV1beta3Document
|
2399
2465
|
# @private
|
2400
2466
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -2527,6 +2593,7 @@ module Google
|
|
2527
2593
|
class Representation < Google::Apis::Core::JsonRepresentation
|
2528
2594
|
property :bounding_poly, as: 'boundingPoly', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BoundingPoly, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BoundingPoly::Representation
|
2529
2595
|
|
2596
|
+
property :confidence, as: 'confidence'
|
2530
2597
|
property :layout_id, as: 'layoutId'
|
2531
2598
|
property :layout_type, as: 'layoutType'
|
2532
2599
|
property :page, :numeric_string => true, as: 'page'
|
@@ -2714,6 +2781,7 @@ module Google
|
|
2714
2781
|
# @private
|
2715
2782
|
class Representation < Google::Apis::Core::JsonRepresentation
|
2716
2783
|
property :id, as: 'id'
|
2784
|
+
property :index, as: 'index'
|
2717
2785
|
property :revision, as: 'revision'
|
2718
2786
|
end
|
2719
2787
|
end
|
@@ -2801,6 +2869,20 @@ module Google
|
|
2801
2869
|
end
|
2802
2870
|
end
|
2803
2871
|
|
2872
|
+
class GoogleCloudDocumentaiV1beta3EnableProcessorRequest
|
2873
|
+
# @private
|
2874
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2875
|
+
end
|
2876
|
+
end
|
2877
|
+
|
2878
|
+
class GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse
|
2879
|
+
# @private
|
2880
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2881
|
+
collection :processor_types, as: 'processorTypes', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessorType, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessorType::Representation
|
2882
|
+
|
2883
|
+
end
|
2884
|
+
end
|
2885
|
+
|
2804
2886
|
class GoogleCloudDocumentaiV1beta3GcsDocument
|
2805
2887
|
# @private
|
2806
2888
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -2833,6 +2915,15 @@ module Google
|
|
2833
2915
|
end
|
2834
2916
|
end
|
2835
2917
|
|
2918
|
+
class GoogleCloudDocumentaiV1beta3ListProcessorsResponse
|
2919
|
+
# @private
|
2920
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2921
|
+
property :next_page_token, as: 'nextPageToken'
|
2922
|
+
collection :processors, as: 'processors', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor::Representation
|
2923
|
+
|
2924
|
+
end
|
2925
|
+
end
|
2926
|
+
|
2836
2927
|
class GoogleCloudDocumentaiV1beta3NormalizedVertex
|
2837
2928
|
# @private
|
2838
2929
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -2865,6 +2956,41 @@ module Google
|
|
2865
2956
|
end
|
2866
2957
|
end
|
2867
2958
|
|
2959
|
+
class GoogleCloudDocumentaiV1beta3Processor
|
2960
|
+
# @private
|
2961
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2962
|
+
property :create_time, as: 'createTime'
|
2963
|
+
property :default_processor_version, as: 'defaultProcessorVersion'
|
2964
|
+
property :display_name, as: 'displayName'
|
2965
|
+
property :kms_key_name, as: 'kmsKeyName'
|
2966
|
+
property :name, as: 'name'
|
2967
|
+
property :process_endpoint, as: 'processEndpoint'
|
2968
|
+
property :state, as: 'state'
|
2969
|
+
property :type, as: 'type'
|
2970
|
+
end
|
2971
|
+
end
|
2972
|
+
|
2973
|
+
class GoogleCloudDocumentaiV1beta3ProcessorType
|
2974
|
+
# @private
|
2975
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2976
|
+
property :allow_creation, as: 'allowCreation'
|
2977
|
+
collection :available_locations, as: 'availableLocations', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo::Representation
|
2978
|
+
|
2979
|
+
property :category, as: 'category'
|
2980
|
+
property :name, as: 'name'
|
2981
|
+
property :schema, as: 'schema', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Schema, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Schema::Representation
|
2982
|
+
|
2983
|
+
property :type, as: 'type'
|
2984
|
+
end
|
2985
|
+
end
|
2986
|
+
|
2987
|
+
class GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo
|
2988
|
+
# @private
|
2989
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2990
|
+
property :location_id, as: 'locationId'
|
2991
|
+
end
|
2992
|
+
end
|
2993
|
+
|
2868
2994
|
class GoogleCloudDocumentaiV1beta3RawDocument
|
2869
2995
|
# @private
|
2870
2996
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -2902,6 +3028,30 @@ module Google
|
|
2902
3028
|
end
|
2903
3029
|
end
|
2904
3030
|
|
3031
|
+
class GoogleCloudDocumentaiV1beta3Schema
|
3032
|
+
# @private
|
3033
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
3034
|
+
property :description, as: 'description'
|
3035
|
+
property :display_name, as: 'displayName'
|
3036
|
+
collection :entity_types, as: 'entityTypes', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaEntityType, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaEntityType::Representation
|
3037
|
+
|
3038
|
+
end
|
3039
|
+
end
|
3040
|
+
|
3041
|
+
class GoogleCloudDocumentaiV1beta3SchemaEntityType
|
3042
|
+
# @private
|
3043
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
3044
|
+
property :base_type, as: 'baseType'
|
3045
|
+
property :description, as: 'description'
|
3046
|
+
collection :enum_values, as: 'enumValues'
|
3047
|
+
property :occurrence_type, as: 'occurrenceType'
|
3048
|
+
collection :properties, as: 'properties', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaEntityType, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaEntityType::Representation
|
3049
|
+
|
3050
|
+
property :source, as: 'source'
|
3051
|
+
property :type, as: 'type'
|
3052
|
+
end
|
3053
|
+
end
|
3054
|
+
|
2905
3055
|
class GoogleCloudDocumentaiV1beta3Vertex
|
2906
3056
|
# @private
|
2907
3057
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -51,6 +51,38 @@ module Google
|
|
51
51
|
@batch_path = 'batch'
|
52
52
|
end
|
53
53
|
|
54
|
+
# Fetches processor types.
|
55
|
+
# @param [String] parent
|
56
|
+
# Required. The project of processor type to list. The available processor types
|
57
|
+
# may depend on the whitelisting on projects. Format: projects/`project`/
|
58
|
+
# locations/`location`
|
59
|
+
# @param [String] fields
|
60
|
+
# Selector specifying which fields to include in a partial response.
|
61
|
+
# @param [String] quota_user
|
62
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
63
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
64
|
+
# @param [Google::Apis::RequestOptions] options
|
65
|
+
# Request-specific options
|
66
|
+
#
|
67
|
+
# @yield [result, err] Result & error if block supplied
|
68
|
+
# @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse] parsed result object
|
69
|
+
# @yieldparam err [StandardError] error object if request failed
|
70
|
+
#
|
71
|
+
# @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse]
|
72
|
+
#
|
73
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
74
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
75
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
76
|
+
def fetch_project_location_processor_types(parent, fields: nil, quota_user: nil, options: nil, &block)
|
77
|
+
command = make_simple_command(:get, 'v1beta3/{+parent}:fetchProcessorTypes', options)
|
78
|
+
command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse::Representation
|
79
|
+
command.response_class = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse
|
80
|
+
command.params['parent'] = parent unless parent.nil?
|
81
|
+
command.query['fields'] = fields unless fields.nil?
|
82
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
83
|
+
execute_or_queue_command(command, &block)
|
84
|
+
end
|
85
|
+
|
54
86
|
# Gets information about a location.
|
55
87
|
# @param [String] name
|
56
88
|
# Resource name for the location.
|
@@ -89,7 +121,7 @@ module Google
|
|
89
121
|
# accepts strings like "displayName=tokyo", and is documented in more detail in [
|
90
122
|
# AIP-160](https://google.aip.dev/160).
|
91
123
|
# @param [Fixnum] page_size
|
92
|
-
# The maximum number of results to return. If not set, the service
|
124
|
+
# The maximum number of results to return. If not set, the service selects a
|
93
125
|
# default.
|
94
126
|
# @param [String] page_token
|
95
127
|
# A page token received from the `next_page_token` field in the response. Send
|
@@ -192,6 +224,178 @@ module Google
|
|
192
224
|
execute_or_queue_command(command, &block)
|
193
225
|
end
|
194
226
|
|
227
|
+
# Creates a processor from the type processor that the user chose. The processor
|
228
|
+
# will be at "ENABLED" state by default after its creation.
|
229
|
+
# @param [String] parent
|
230
|
+
# Required. The parent (project and location) under which to create the
|
231
|
+
# processor. Format: projects/`project`/locations/`location`
|
232
|
+
# @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor] google_cloud_documentai_v1beta3_processor_object
|
233
|
+
# @param [String] fields
|
234
|
+
# Selector specifying which fields to include in a partial response.
|
235
|
+
# @param [String] quota_user
|
236
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
237
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
238
|
+
# @param [Google::Apis::RequestOptions] options
|
239
|
+
# Request-specific options
|
240
|
+
#
|
241
|
+
# @yield [result, err] Result & error if block supplied
|
242
|
+
# @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor] parsed result object
|
243
|
+
# @yieldparam err [StandardError] error object if request failed
|
244
|
+
#
|
245
|
+
# @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor]
|
246
|
+
#
|
247
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
248
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
249
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
250
|
+
def create_project_location_processor(parent, google_cloud_documentai_v1beta3_processor_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
251
|
+
command = make_simple_command(:post, 'v1beta3/{+parent}/processors', options)
|
252
|
+
command.request_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor::Representation
|
253
|
+
command.request_object = google_cloud_documentai_v1beta3_processor_object
|
254
|
+
command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor::Representation
|
255
|
+
command.response_class = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor
|
256
|
+
command.params['parent'] = parent unless parent.nil?
|
257
|
+
command.query['fields'] = fields unless fields.nil?
|
258
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
259
|
+
execute_or_queue_command(command, &block)
|
260
|
+
end
|
261
|
+
|
262
|
+
# Deletes the processor, unloads all deployed model artifacts if it was enabled
|
263
|
+
# and then deletes all artifacts associated with this processor.
|
264
|
+
# @param [String] name
|
265
|
+
# Required. The processor resource name to be deleted.
|
266
|
+
# @param [String] fields
|
267
|
+
# Selector specifying which fields to include in a partial response.
|
268
|
+
# @param [String] quota_user
|
269
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
270
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
271
|
+
# @param [Google::Apis::RequestOptions] options
|
272
|
+
# Request-specific options
|
273
|
+
#
|
274
|
+
# @yield [result, err] Result & error if block supplied
|
275
|
+
# @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation] parsed result object
|
276
|
+
# @yieldparam err [StandardError] error object if request failed
|
277
|
+
#
|
278
|
+
# @return [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation]
|
279
|
+
#
|
280
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
281
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
282
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
283
|
+
def delete_project_location_processor(name, fields: nil, quota_user: nil, options: nil, &block)
|
284
|
+
command = make_simple_command(:delete, 'v1beta3/{+name}', options)
|
285
|
+
command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation::Representation
|
286
|
+
command.response_class = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation
|
287
|
+
command.params['name'] = name unless name.nil?
|
288
|
+
command.query['fields'] = fields unless fields.nil?
|
289
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
290
|
+
execute_or_queue_command(command, &block)
|
291
|
+
end
|
292
|
+
|
293
|
+
# Disables a processor
|
294
|
+
# @param [String] name
|
295
|
+
# Required. The processor resource name to be disabled.
|
296
|
+
# @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DisableProcessorRequest] google_cloud_documentai_v1beta3_disable_processor_request_object
|
297
|
+
# @param [String] fields
|
298
|
+
# Selector specifying which fields to include in a partial response.
|
299
|
+
# @param [String] quota_user
|
300
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
301
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
302
|
+
# @param [Google::Apis::RequestOptions] options
|
303
|
+
# Request-specific options
|
304
|
+
#
|
305
|
+
# @yield [result, err] Result & error if block supplied
|
306
|
+
# @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation] parsed result object
|
307
|
+
# @yieldparam err [StandardError] error object if request failed
|
308
|
+
#
|
309
|
+
# @return [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation]
|
310
|
+
#
|
311
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
312
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
313
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
314
|
+
def disable_project_location_processor(name, google_cloud_documentai_v1beta3_disable_processor_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
315
|
+
command = make_simple_command(:post, 'v1beta3/{+name}:disable', options)
|
316
|
+
command.request_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DisableProcessorRequest::Representation
|
317
|
+
command.request_object = google_cloud_documentai_v1beta3_disable_processor_request_object
|
318
|
+
command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation::Representation
|
319
|
+
command.response_class = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation
|
320
|
+
command.params['name'] = name unless name.nil?
|
321
|
+
command.query['fields'] = fields unless fields.nil?
|
322
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
323
|
+
execute_or_queue_command(command, &block)
|
324
|
+
end
|
325
|
+
|
326
|
+
# Enables a processor
|
327
|
+
# @param [String] name
|
328
|
+
# Required. The processor resource name to be enabled.
|
329
|
+
# @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EnableProcessorRequest] google_cloud_documentai_v1beta3_enable_processor_request_object
|
330
|
+
# @param [String] fields
|
331
|
+
# Selector specifying which fields to include in a partial response.
|
332
|
+
# @param [String] quota_user
|
333
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
334
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
335
|
+
# @param [Google::Apis::RequestOptions] options
|
336
|
+
# Request-specific options
|
337
|
+
#
|
338
|
+
# @yield [result, err] Result & error if block supplied
|
339
|
+
# @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation] parsed result object
|
340
|
+
# @yieldparam err [StandardError] error object if request failed
|
341
|
+
#
|
342
|
+
# @return [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation]
|
343
|
+
#
|
344
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
345
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
346
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
347
|
+
def enable_project_location_processor(name, google_cloud_documentai_v1beta3_enable_processor_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
348
|
+
command = make_simple_command(:post, 'v1beta3/{+name}:enable', options)
|
349
|
+
command.request_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EnableProcessorRequest::Representation
|
350
|
+
command.request_object = google_cloud_documentai_v1beta3_enable_processor_request_object
|
351
|
+
command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation::Representation
|
352
|
+
command.response_class = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation
|
353
|
+
command.params['name'] = name unless name.nil?
|
354
|
+
command.query['fields'] = fields unless fields.nil?
|
355
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
356
|
+
execute_or_queue_command(command, &block)
|
357
|
+
end
|
358
|
+
|
359
|
+
# Lists all processors which belong to this project.
|
360
|
+
# @param [String] parent
|
361
|
+
# Required. The parent (project and location) which owns this collection of
|
362
|
+
# Processors. Format: projects/`project`/locations/`location`
|
363
|
+
# @param [Fixnum] page_size
|
364
|
+
# The maximum number of processors to return. If unspecified, at most 50
|
365
|
+
# processors will be returned. The maximum value is 100; values above 100 will
|
366
|
+
# be coerced to 100.
|
367
|
+
# @param [String] page_token
|
368
|
+
# We will return the processors sorted by creation time. The page token will
|
369
|
+
# point to the next processor.
|
370
|
+
# @param [String] fields
|
371
|
+
# Selector specifying which fields to include in a partial response.
|
372
|
+
# @param [String] quota_user
|
373
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
374
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
375
|
+
# @param [Google::Apis::RequestOptions] options
|
376
|
+
# Request-specific options
|
377
|
+
#
|
378
|
+
# @yield [result, err] Result & error if block supplied
|
379
|
+
# @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListProcessorsResponse] parsed result object
|
380
|
+
# @yieldparam err [StandardError] error object if request failed
|
381
|
+
#
|
382
|
+
# @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListProcessorsResponse]
|
383
|
+
#
|
384
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
385
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
386
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
387
|
+
def list_project_location_processors(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
388
|
+
command = make_simple_command(:get, 'v1beta3/{+parent}/processors', options)
|
389
|
+
command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListProcessorsResponse::Representation
|
390
|
+
command.response_class = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListProcessorsResponse
|
391
|
+
command.params['parent'] = parent unless parent.nil?
|
392
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
393
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
394
|
+
command.query['fields'] = fields unless fields.nil?
|
395
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
396
|
+
execute_or_queue_command(command, &block)
|
397
|
+
end
|
398
|
+
|
195
399
|
# Processes a single document.
|
196
400
|
# @param [String] name
|
197
401
|
# Required. The resource name of the Processor or ProcessorVersion to use for
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-documentai_v1beta3
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.10.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-
|
11
|
+
date: 2021-05-18 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: google-apis-core
|
@@ -52,7 +52,7 @@ licenses:
|
|
52
52
|
metadata:
|
53
53
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
54
54
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-documentai_v1beta3/CHANGELOG.md
|
55
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1beta3/v0.
|
55
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1beta3/v0.10.0
|
56
56
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-documentai_v1beta3
|
57
57
|
post_install_message:
|
58
58
|
rdoc_options: []
|
@@ -69,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
69
69
|
- !ruby/object:Gem::Version
|
70
70
|
version: '0'
|
71
71
|
requirements: []
|
72
|
-
rubygems_version: 3.2.
|
72
|
+
rubygems_version: 3.2.17
|
73
73
|
signing_key:
|
74
74
|
specification_version: 4
|
75
75
|
summary: Simple REST client for Cloud Document AI API V1beta3
|