google-cloud-document_ai-v1beta3 0.37.0 → 0.39.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/README.md +31 -21
- data/lib/google/cloud/document_ai/v1beta3/document_processor_service/client.rb +68 -27
- data/lib/google/cloud/document_ai/v1beta3/document_processor_service/operations.rb +19 -15
- data/lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/client.rb +68 -27
- data/lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/operations.rb +50 -38
- data/lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/service_stub.rb +198 -140
- data/lib/google/cloud/document_ai/v1beta3/document_service/client.rb +39 -8
- data/lib/google/cloud/document_ai/v1beta3/document_service/operations.rb +19 -15
- data/lib/google/cloud/document_ai/v1beta3/document_service/rest/client.rb +39 -8
- data/lib/google/cloud/document_ai/v1beta3/document_service/rest/operations.rb +50 -38
- data/lib/google/cloud/document_ai/v1beta3/document_service/rest/service_stub.rb +70 -44
- data/lib/google/cloud/document_ai/v1beta3/version.rb +1 -1
- data/lib/google/cloud/documentai/v1beta3/dataset_pb.rb +1 -1
- data/proto_docs/google/api/client.rb +39 -0
- data/proto_docs/google/cloud/documentai/v1beta3/dataset.rb +20 -0
- data/proto_docs/google/cloud/documentai/v1beta3/document.rb +34 -0
- data/proto_docs/google/cloud/documentai/v1beta3/document_io.rb +4 -0
- data/proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb +20 -0
- data/proto_docs/google/cloud/documentai/v1beta3/document_service.rb +4 -0
- data/proto_docs/google/cloud/documentai/v1beta3/processor.rb +4 -0
- data/proto_docs/google/longrunning/operations.rb +23 -14
- data/proto_docs/google/type/datetime.rb +4 -0
- metadata +6 -9
@@ -30,7 +30,8 @@ module Google
|
|
30
30
|
# including transcoding, making the REST call, and deserialing the response.
|
31
31
|
#
|
32
32
|
class ServiceStub
|
33
|
-
|
33
|
+
# @private
|
34
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
|
34
35
|
# These require statements are intentionally placed here to initialize
|
35
36
|
# the REST modules only when it's required.
|
36
37
|
require "gapic/rest"
|
@@ -40,7 +41,9 @@ module Google
|
|
40
41
|
universe_domain: universe_domain,
|
41
42
|
credentials: credentials,
|
42
43
|
numeric_enums: true,
|
43
|
-
|
44
|
+
service_name: self.class,
|
45
|
+
raise_faraday_errors: false,
|
46
|
+
logger: logger
|
44
47
|
end
|
45
48
|
|
46
49
|
##
|
@@ -61,6 +64,15 @@ module Google
|
|
61
64
|
@client_stub.endpoint
|
62
65
|
end
|
63
66
|
|
67
|
+
##
|
68
|
+
# The logger used for request/response debug logging.
|
69
|
+
#
|
70
|
+
# @return [Logger]
|
71
|
+
#
|
72
|
+
def logger stub: false
|
73
|
+
stub ? @client_stub.stub_logger : @client_stub.logger
|
74
|
+
end
|
75
|
+
|
64
76
|
##
|
65
77
|
# Baseline implementation for the update_dataset REST call
|
66
78
|
#
|
@@ -87,16 +99,18 @@ module Google
|
|
87
99
|
|
88
100
|
response = @client_stub.make_http_request(
|
89
101
|
verb,
|
90
|
-
uri:
|
91
|
-
body:
|
92
|
-
params:
|
102
|
+
uri: uri,
|
103
|
+
body: body || "",
|
104
|
+
params: query_string_params,
|
105
|
+
method_name: "update_dataset",
|
93
106
|
options: options
|
94
107
|
)
|
95
108
|
operation = ::Gapic::Rest::TransportOperation.new response
|
96
109
|
result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
|
97
|
-
|
98
|
-
|
99
|
-
|
110
|
+
catch :response do
|
111
|
+
yield result, operation if block_given?
|
112
|
+
result
|
113
|
+
end
|
100
114
|
end
|
101
115
|
|
102
116
|
##
|
@@ -125,16 +139,18 @@ module Google
|
|
125
139
|
|
126
140
|
response = @client_stub.make_http_request(
|
127
141
|
verb,
|
128
|
-
uri:
|
129
|
-
body:
|
130
|
-
params:
|
142
|
+
uri: uri,
|
143
|
+
body: body || "",
|
144
|
+
params: query_string_params,
|
145
|
+
method_name: "import_documents",
|
131
146
|
options: options
|
132
147
|
)
|
133
148
|
operation = ::Gapic::Rest::TransportOperation.new response
|
134
149
|
result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
|
135
|
-
|
136
|
-
|
137
|
-
|
150
|
+
catch :response do
|
151
|
+
yield result, operation if block_given?
|
152
|
+
result
|
153
|
+
end
|
138
154
|
end
|
139
155
|
|
140
156
|
##
|
@@ -163,16 +179,18 @@ module Google
|
|
163
179
|
|
164
180
|
response = @client_stub.make_http_request(
|
165
181
|
verb,
|
166
|
-
uri:
|
167
|
-
body:
|
168
|
-
params:
|
182
|
+
uri: uri,
|
183
|
+
body: body || "",
|
184
|
+
params: query_string_params,
|
185
|
+
method_name: "get_document",
|
169
186
|
options: options
|
170
187
|
)
|
171
188
|
operation = ::Gapic::Rest::TransportOperation.new response
|
172
189
|
result = ::Google::Cloud::DocumentAI::V1beta3::GetDocumentResponse.decode_json response.body, ignore_unknown_fields: true
|
173
|
-
|
174
|
-
|
175
|
-
|
190
|
+
catch :response do
|
191
|
+
yield result, operation if block_given?
|
192
|
+
result
|
193
|
+
end
|
176
194
|
end
|
177
195
|
|
178
196
|
##
|
@@ -201,16 +219,18 @@ module Google
|
|
201
219
|
|
202
220
|
response = @client_stub.make_http_request(
|
203
221
|
verb,
|
204
|
-
uri:
|
205
|
-
body:
|
206
|
-
params:
|
222
|
+
uri: uri,
|
223
|
+
body: body || "",
|
224
|
+
params: query_string_params,
|
225
|
+
method_name: "list_documents",
|
207
226
|
options: options
|
208
227
|
)
|
209
228
|
operation = ::Gapic::Rest::TransportOperation.new response
|
210
229
|
result = ::Google::Cloud::DocumentAI::V1beta3::ListDocumentsResponse.decode_json response.body, ignore_unknown_fields: true
|
211
|
-
|
212
|
-
|
213
|
-
|
230
|
+
catch :response do
|
231
|
+
yield result, operation if block_given?
|
232
|
+
result
|
233
|
+
end
|
214
234
|
end
|
215
235
|
|
216
236
|
##
|
@@ -239,16 +259,18 @@ module Google
|
|
239
259
|
|
240
260
|
response = @client_stub.make_http_request(
|
241
261
|
verb,
|
242
|
-
uri:
|
243
|
-
body:
|
244
|
-
params:
|
262
|
+
uri: uri,
|
263
|
+
body: body || "",
|
264
|
+
params: query_string_params,
|
265
|
+
method_name: "batch_delete_documents",
|
245
266
|
options: options
|
246
267
|
)
|
247
268
|
operation = ::Gapic::Rest::TransportOperation.new response
|
248
269
|
result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
|
249
|
-
|
250
|
-
|
251
|
-
|
270
|
+
catch :response do
|
271
|
+
yield result, operation if block_given?
|
272
|
+
result
|
273
|
+
end
|
252
274
|
end
|
253
275
|
|
254
276
|
##
|
@@ -277,16 +299,18 @@ module Google
|
|
277
299
|
|
278
300
|
response = @client_stub.make_http_request(
|
279
301
|
verb,
|
280
|
-
uri:
|
281
|
-
body:
|
282
|
-
params:
|
302
|
+
uri: uri,
|
303
|
+
body: body || "",
|
304
|
+
params: query_string_params,
|
305
|
+
method_name: "get_dataset_schema",
|
283
306
|
options: options
|
284
307
|
)
|
285
308
|
operation = ::Gapic::Rest::TransportOperation.new response
|
286
309
|
result = ::Google::Cloud::DocumentAI::V1beta3::DatasetSchema.decode_json response.body, ignore_unknown_fields: true
|
287
|
-
|
288
|
-
|
289
|
-
|
310
|
+
catch :response do
|
311
|
+
yield result, operation if block_given?
|
312
|
+
result
|
313
|
+
end
|
290
314
|
end
|
291
315
|
|
292
316
|
##
|
@@ -315,16 +339,18 @@ module Google
|
|
315
339
|
|
316
340
|
response = @client_stub.make_http_request(
|
317
341
|
verb,
|
318
|
-
uri:
|
319
|
-
body:
|
320
|
-
params:
|
342
|
+
uri: uri,
|
343
|
+
body: body || "",
|
344
|
+
params: query_string_params,
|
345
|
+
method_name: "update_dataset_schema",
|
321
346
|
options: options
|
322
347
|
)
|
323
348
|
operation = ::Gapic::Rest::TransportOperation.new response
|
324
349
|
result = ::Google::Cloud::DocumentAI::V1beta3::DatasetSchema.decode_json response.body, ignore_unknown_fields: true
|
325
|
-
|
326
|
-
|
327
|
-
|
350
|
+
catch :response do
|
351
|
+
yield result, operation if block_given?
|
352
|
+
result
|
353
|
+
end
|
328
354
|
end
|
329
355
|
|
330
356
|
##
|
@@ -11,7 +11,7 @@ require 'google/cloud/documentai/v1beta3/document_io_pb'
|
|
11
11
|
require 'google/cloud/documentai/v1beta3/document_schema_pb'
|
12
12
|
|
13
13
|
|
14
|
-
descriptor_data = "\n-google/cloud/documentai/v1beta3/dataset.proto\x12\x1fgoogle.cloud.documentai.v1beta3\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a.google/cloud/documentai/v1beta3/document.proto\x1a\x31google/cloud/documentai/v1beta3/document_io.proto\x1a\x35google/cloud/documentai/v1beta3/document_schema.proto\"\x9c\x08\n\x07\x44\x61taset\x12\\\n\x12gcs_managed_config\x18\x03 \x01(\x0b\x32\x39.google.cloud.documentai.v1beta3.Dataset.GCSManagedConfigB\x03\xe0\x41\x01H\x00\x12l\n\x19\x64ocument_warehouse_config\x18\x05 \x01(\x0b\x32@.google.cloud.documentai.v1beta3.Dataset.DocumentWarehouseConfigB\x05\x18\x01\xe0\x41\x01H\x00\x12h\n\x18unmanaged_dataset_config\x18\x06 \x01(\x0b\x32?.google.cloud.documentai.v1beta3.Dataset.UnmanagedDatasetConfigB\x03\xe0\x41\x01H\x00\x12\x66\n\x17spanner_indexing_config\x18\x04 \x01(\x0b\x32>.google.cloud.documentai.v1beta3.Dataset.SpannerIndexingConfigB\x03\xe0\x41\x01H\x01\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x42\n\x05state\x18\x02 \x01(\x0e\x32..google.cloud.documentai.v1beta3.Dataset.StateB\x03\xe0\x41\x02\x12\x1a\n\rsatisfies_pzs\x18\x08 \x01(\x08\x42\x03\xe0\x41\x03\x12\x1a\n\rsatisfies_pzi\x18\t \x01(\x08\x42\x03\xe0\x41\x03\x1aW\n\x10GCSManagedConfig\x12\x43\n\ngcs_prefix\x18\x01 \x01(\x0b\x32*.google.cloud.documentai.v1beta3.GcsPrefixB\x03\xe0\x41\x02\x1ar\n\x17\x44ocumentWarehouseConfig\x12\x17\n\ncollection\x18\x01 \x01(\tB\x03\xe0\x41\x03\x12>\n\x06schema\x18\x02 \x01(\tB.\xe0\x41\x03\xfa\x41(\n&contentwarehouse.googleapis.com/Schema\x1a\x18\n\x16UnmanagedDatasetConfig\x1a\x17\n\x15SpannerIndexingConfig\"T\n\x05State\x12\x15\n\x11STATE_UNSPECIFIED\x10\x00\x12\x11\n\rUNINITIALIZED\x10\x01\x12\x10\n\x0cINITIALIZING\x10\x02\x12\x0f\n\x0bINITIALIZED\x10\x03:n\xea\x41k\n!documentai.googleapis.com/Dataset\x12\x46projects/{project}/locations/{location}/processors/{processor}/datasetB\x10\n\x0estorage_sourceB\x11\n\x0findexing_source\"\x86\x03\n\nDocumentId\x12^\n\x12gcs_managed_doc_id\x18\x01 \x01(\x0b\x32@.google.cloud.documentai.v1beta3.DocumentId.GCSManagedDocumentIdH\x00\x12[\n\x10unmanaged_doc_id\x18\x04 \x01(\x0b\x32?.google.cloud.documentai.v1beta3.DocumentId.UnmanagedDocumentIdH\x00\x12\x42\n\x0crevision_ref\x18\x03 \x01(\x0b\x32,.google.cloud.documentai.v1beta3.RevisionRef\x1a\x43\n\x14GCSManagedDocumentId\x12\x14\n\x07gcs_uri\x18\x01 \x01(\tB\x03\xe0\x41\x02\x12\x15\n\tcw_doc_id\x18\x02 \x01(\tB\x02\x18\x01\x1a*\n\x13UnmanagedDocumentId\x12\x13\n\x06\x64oc_id\x18\x01 \x01(\tB\x03\xe0\x41\x02\x42\x06\n\x04type\"\
|
14
|
+
descriptor_data = "\n-google/cloud/documentai/v1beta3/dataset.proto\x12\x1fgoogle.cloud.documentai.v1beta3\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a.google/cloud/documentai/v1beta3/document.proto\x1a\x31google/cloud/documentai/v1beta3/document_io.proto\x1a\x35google/cloud/documentai/v1beta3/document_schema.proto\"\x9c\x08\n\x07\x44\x61taset\x12\\\n\x12gcs_managed_config\x18\x03 \x01(\x0b\x32\x39.google.cloud.documentai.v1beta3.Dataset.GCSManagedConfigB\x03\xe0\x41\x01H\x00\x12l\n\x19\x64ocument_warehouse_config\x18\x05 \x01(\x0b\x32@.google.cloud.documentai.v1beta3.Dataset.DocumentWarehouseConfigB\x05\x18\x01\xe0\x41\x01H\x00\x12h\n\x18unmanaged_dataset_config\x18\x06 \x01(\x0b\x32?.google.cloud.documentai.v1beta3.Dataset.UnmanagedDatasetConfigB\x03\xe0\x41\x01H\x00\x12\x66\n\x17spanner_indexing_config\x18\x04 \x01(\x0b\x32>.google.cloud.documentai.v1beta3.Dataset.SpannerIndexingConfigB\x03\xe0\x41\x01H\x01\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x42\n\x05state\x18\x02 \x01(\x0e\x32..google.cloud.documentai.v1beta3.Dataset.StateB\x03\xe0\x41\x02\x12\x1a\n\rsatisfies_pzs\x18\x08 \x01(\x08\x42\x03\xe0\x41\x03\x12\x1a\n\rsatisfies_pzi\x18\t \x01(\x08\x42\x03\xe0\x41\x03\x1aW\n\x10GCSManagedConfig\x12\x43\n\ngcs_prefix\x18\x01 \x01(\x0b\x32*.google.cloud.documentai.v1beta3.GcsPrefixB\x03\xe0\x41\x02\x1ar\n\x17\x44ocumentWarehouseConfig\x12\x17\n\ncollection\x18\x01 \x01(\tB\x03\xe0\x41\x03\x12>\n\x06schema\x18\x02 \x01(\tB.\xe0\x41\x03\xfa\x41(\n&contentwarehouse.googleapis.com/Schema\x1a\x18\n\x16UnmanagedDatasetConfig\x1a\x17\n\x15SpannerIndexingConfig\"T\n\x05State\x12\x15\n\x11STATE_UNSPECIFIED\x10\x00\x12\x11\n\rUNINITIALIZED\x10\x01\x12\x10\n\x0cINITIALIZING\x10\x02\x12\x0f\n\x0bINITIALIZED\x10\x03:n\xea\x41k\n!documentai.googleapis.com/Dataset\x12\x46projects/{project}/locations/{location}/processors/{processor}/datasetB\x10\n\x0estorage_sourceB\x11\n\x0findexing_source\"\x86\x03\n\nDocumentId\x12^\n\x12gcs_managed_doc_id\x18\x01 \x01(\x0b\x32@.google.cloud.documentai.v1beta3.DocumentId.GCSManagedDocumentIdH\x00\x12[\n\x10unmanaged_doc_id\x18\x04 \x01(\x0b\x32?.google.cloud.documentai.v1beta3.DocumentId.UnmanagedDocumentIdH\x00\x12\x42\n\x0crevision_ref\x18\x03 \x01(\x0b\x32,.google.cloud.documentai.v1beta3.RevisionRef\x1a\x43\n\x14GCSManagedDocumentId\x12\x14\n\x07gcs_uri\x18\x01 \x01(\tB\x03\xe0\x41\x02\x12\x15\n\tcw_doc_id\x18\x02 \x01(\tB\x02\x18\x01\x1a*\n\x13UnmanagedDocumentId\x12\x13\n\x06\x64oc_id\x18\x01 \x01(\tB\x03\xe0\x41\x02\x42\x06\n\x04type\"\xa9\x02\n\rDatasetSchema\x12\x0c\n\x04name\x18\x01 \x01(\t\x12M\n\x0f\x64ocument_schema\x18\x03 \x01(\x0b\x32/.google.cloud.documentai.v1beta3.DocumentSchemaB\x03\xe0\x41\x01\x12\x1a\n\rsatisfies_pzs\x18\x04 \x01(\x08\x42\x03\xe0\x41\x03\x12\x1a\n\rsatisfies_pzi\x18\x05 \x01(\x08\x42\x03\xe0\x41\x03:\x82\x01\xea\x41\x7f\n\'documentai.googleapis.com/DatasetSchema\x12Tprojects/{project}/locations/{location}/processors/{processor}/dataset/datasetSchema\"\x87\x02\n\x15\x42\x61tchDatasetDocuments\x12o\n\x17individual_document_ids\x18\x01 \x01(\x0b\x32L.google.cloud.documentai.v1beta3.BatchDatasetDocuments.IndividualDocumentIdsH\x00\x12\x10\n\x06\x66ilter\x18\x02 \x01(\tH\x00\x1a_\n\x15IndividualDocumentIds\x12\x46\n\x0c\x64ocument_ids\x18\x01 \x03(\x0b\x32+.google.cloud.documentai.v1beta3.DocumentIdB\x03\xe0\x41\x02\x42\n\n\x08\x63riteriaB\xc8\x02\n#com.google.cloud.documentai.v1beta3B\x0c\x44\x61tasetProtoP\x01ZCcloud.google.com/go/documentai/apiv1beta3/documentaipb;documentaipb\xaa\x02\x1fGoogle.Cloud.DocumentAI.V1Beta3\xca\x02\x1fGoogle\\Cloud\\DocumentAI\\V1beta3\xea\x02\"Google::Cloud::DocumentAI::V1beta3\xea\x41\x62\n&contentwarehouse.googleapis.com/Schema\x12\x38projects/{project}/locations/{location}/schemas/{schema}b\x06proto3"
|
15
15
|
|
16
16
|
pool = Google::Protobuf::DescriptorPool.generated_pool
|
17
17
|
|
@@ -28,6 +28,9 @@ module Google
|
|
28
28
|
# @!attribute [rw] destinations
|
29
29
|
# @return [::Array<::Google::Api::ClientLibraryDestination>]
|
30
30
|
# The destination where API teams want this client library to be published.
|
31
|
+
# @!attribute [rw] selective_gapic_generation
|
32
|
+
# @return [::Google::Api::SelectiveGapicGeneration]
|
33
|
+
# Configuration for which RPCs should be generated in the GAPIC client.
|
31
34
|
class CommonLanguageSettings
|
32
35
|
include ::Google::Protobuf::MessageExts
|
33
36
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -212,6 +215,12 @@ module Google
|
|
212
215
|
# enabled. By default, asynchronous REST clients will not be generated.
|
213
216
|
# This feature will be enabled by default 1 month after launching the
|
214
217
|
# feature in preview packages.
|
218
|
+
# @!attribute [rw] protobuf_pythonic_types_enabled
|
219
|
+
# @return [::Boolean]
|
220
|
+
# Enables generation of protobuf code using new types that are more
|
221
|
+
# Pythonic which are included in `protobuf>=5.29.x`. This feature will be
|
222
|
+
# enabled by default 1 month after launching the feature in preview
|
223
|
+
# packages.
|
215
224
|
class ExperimentalFeatures
|
216
225
|
include ::Google::Protobuf::MessageExts
|
217
226
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -297,9 +306,28 @@ module Google
|
|
297
306
|
# @!attribute [rw] common
|
298
307
|
# @return [::Google::Api::CommonLanguageSettings]
|
299
308
|
# Some settings.
|
309
|
+
# @!attribute [rw] renamed_services
|
310
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
311
|
+
# Map of service names to renamed services. Keys are the package relative
|
312
|
+
# service names and values are the name to be used for the service client
|
313
|
+
# and call options.
|
314
|
+
#
|
315
|
+
# publishing:
|
316
|
+
# go_settings:
|
317
|
+
# renamed_services:
|
318
|
+
# Publisher: TopicAdmin
|
300
319
|
class GoSettings
|
301
320
|
include ::Google::Protobuf::MessageExts
|
302
321
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
322
|
+
|
323
|
+
# @!attribute [rw] key
|
324
|
+
# @return [::String]
|
325
|
+
# @!attribute [rw] value
|
326
|
+
# @return [::String]
|
327
|
+
class RenamedServicesEntry
|
328
|
+
include ::Google::Protobuf::MessageExts
|
329
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
330
|
+
end
|
303
331
|
end
|
304
332
|
|
305
333
|
# Describes the generator configuration for a method.
|
@@ -375,6 +403,17 @@ module Google
|
|
375
403
|
end
|
376
404
|
end
|
377
405
|
|
406
|
+
# This message is used to configure the generation of a subset of the RPCs in
|
407
|
+
# a service for client libraries.
|
408
|
+
# @!attribute [rw] methods
|
409
|
+
# @return [::Array<::String>]
|
410
|
+
# An allowlist of the fully qualified names of RPCs that should be included
|
411
|
+
# on public client surfaces.
|
412
|
+
class SelectiveGapicGeneration
|
413
|
+
include ::Google::Protobuf::MessageExts
|
414
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
415
|
+
end
|
416
|
+
|
378
417
|
# The organization for which the client libraries are being published.
|
379
418
|
# Affects the url where generated docs are published, etc.
|
380
419
|
module ClientLibraryOrganization
|
@@ -29,16 +29,22 @@ module Google
|
|
29
29
|
# Optional. User-managed Cloud Storage dataset configuration. Use this
|
30
30
|
# configuration if the dataset documents are stored under a user-managed
|
31
31
|
# Cloud Storage location.
|
32
|
+
#
|
33
|
+
# Note: The following fields are mutually exclusive: `gcs_managed_config`, `document_warehouse_config`, `unmanaged_dataset_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
32
34
|
# @!attribute [rw] document_warehouse_config
|
33
35
|
# @deprecated This field is deprecated and may be removed in the next major version update.
|
34
36
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Dataset::DocumentWarehouseConfig]
|
35
37
|
# Optional. Deprecated. Warehouse-based dataset configuration is not
|
36
38
|
# supported.
|
39
|
+
#
|
40
|
+
# Note: The following fields are mutually exclusive: `document_warehouse_config`, `gcs_managed_config`, `unmanaged_dataset_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
37
41
|
# @!attribute [rw] unmanaged_dataset_config
|
38
42
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Dataset::UnmanagedDatasetConfig]
|
39
43
|
# Optional. Unmanaged dataset configuration. Use this configuration if the
|
40
44
|
# dataset documents are managed by the document service internally (not
|
41
45
|
# user-managed).
|
46
|
+
#
|
47
|
+
# Note: The following fields are mutually exclusive: `unmanaged_dataset_config`, `gcs_managed_config`, `document_warehouse_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
42
48
|
# @!attribute [rw] spanner_indexing_config
|
43
49
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Dataset::SpannerIndexingConfig]
|
44
50
|
# Optional. A lightweight indexing source with low latency and high
|
@@ -118,9 +124,13 @@ module Google
|
|
118
124
|
# @!attribute [rw] gcs_managed_doc_id
|
119
125
|
# @return [::Google::Cloud::DocumentAI::V1beta3::DocumentId::GCSManagedDocumentId]
|
120
126
|
# A document id within user-managed Cloud Storage.
|
127
|
+
#
|
128
|
+
# Note: The following fields are mutually exclusive: `gcs_managed_doc_id`, `unmanaged_doc_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
121
129
|
# @!attribute [rw] unmanaged_doc_id
|
122
130
|
# @return [::Google::Cloud::DocumentAI::V1beta3::DocumentId::UnmanagedDocumentId]
|
123
131
|
# A document id within unmanaged dataset.
|
132
|
+
#
|
133
|
+
# Note: The following fields are mutually exclusive: `unmanaged_doc_id`, `gcs_managed_doc_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
124
134
|
# @!attribute [rw] revision_ref
|
125
135
|
# @return [::Google::Cloud::DocumentAI::V1beta3::RevisionRef]
|
126
136
|
# Points to a specific revision of the document if set.
|
@@ -162,6 +172,12 @@ module Google
|
|
162
172
|
# @!attribute [rw] document_schema
|
163
173
|
# @return [::Google::Cloud::DocumentAI::V1beta3::DocumentSchema]
|
164
174
|
# Optional. Schema of the dataset.
|
175
|
+
# @!attribute [r] satisfies_pzs
|
176
|
+
# @return [::Boolean]
|
177
|
+
# Output only. Reserved for future use.
|
178
|
+
# @!attribute [r] satisfies_pzi
|
179
|
+
# @return [::Boolean]
|
180
|
+
# Output only. Reserved for future use.
|
165
181
|
class DatasetSchema
|
166
182
|
include ::Google::Protobuf::MessageExts
|
167
183
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -171,11 +187,15 @@ module Google
|
|
171
187
|
# @!attribute [rw] individual_document_ids
|
172
188
|
# @return [::Google::Cloud::DocumentAI::V1beta3::BatchDatasetDocuments::IndividualDocumentIds]
|
173
189
|
# Document identifiers.
|
190
|
+
#
|
191
|
+
# Note: The following fields are mutually exclusive: `individual_document_ids`, `filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
174
192
|
# @!attribute [rw] filter
|
175
193
|
# @return [::String]
|
176
194
|
# A filter matching the documents.
|
177
195
|
# Follows the same format and restriction as
|
178
196
|
# [google.cloud.documentai.master.ListDocumentsRequest.filter].
|
197
|
+
#
|
198
|
+
# Note: The following fields are mutually exclusive: `filter`, `individual_document_ids`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
179
199
|
class BatchDatasetDocuments
|
180
200
|
include ::Google::Protobuf::MessageExts
|
181
201
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -31,11 +31,15 @@ module Google
|
|
31
31
|
# `gs://bucket_name/object_name`. Object versioning is not supported.
|
32
32
|
# For more information, refer to [Google Cloud Storage Request
|
33
33
|
# URIs](https://cloud.google.com/storage/docs/reference-uris).
|
34
|
+
#
|
35
|
+
# Note: The following fields are mutually exclusive: `uri`, `content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
34
36
|
# @!attribute [rw] content
|
35
37
|
# @return [::String]
|
36
38
|
# Optional. Inline document content, represented as a stream of bytes.
|
37
39
|
# Note: As with all `bytes` fields, protobuffers use a pure binary
|
38
40
|
# representation, whereas JSON representations use base64.
|
41
|
+
#
|
42
|
+
# Note: The following fields are mutually exclusive: `content`, `uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
39
43
|
# @!attribute [rw] mime_type
|
40
44
|
# @return [::String]
|
41
45
|
# An IANA published [media type (MIME
|
@@ -731,28 +735,42 @@ module Google
|
|
731
735
|
# @return [::Google::Type::Money]
|
732
736
|
# Money value. See also:
|
733
737
|
# https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
|
738
|
+
#
|
739
|
+
# Note: The following fields are mutually exclusive: `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
734
740
|
# @!attribute [rw] date_value
|
735
741
|
# @return [::Google::Type::Date]
|
736
742
|
# Date value. Includes year, month, day. See also:
|
737
743
|
# https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
|
744
|
+
#
|
745
|
+
# Note: The following fields are mutually exclusive: `date_value`, `money_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
738
746
|
# @!attribute [rw] datetime_value
|
739
747
|
# @return [::Google::Type::DateTime]
|
740
748
|
# DateTime value. Includes date, time, and timezone. See also:
|
741
749
|
# https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
|
750
|
+
#
|
751
|
+
# Note: The following fields are mutually exclusive: `datetime_value`, `money_value`, `date_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
742
752
|
# @!attribute [rw] address_value
|
743
753
|
# @return [::Google::Type::PostalAddress]
|
744
754
|
# Postal address. See also:
|
745
755
|
# https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
|
756
|
+
#
|
757
|
+
# Note: The following fields are mutually exclusive: `address_value`, `money_value`, `date_value`, `datetime_value`, `boolean_value`, `integer_value`, `float_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
746
758
|
# @!attribute [rw] boolean_value
|
747
759
|
# @return [::Boolean]
|
748
760
|
# Boolean value. Can be used for entities with binary values, or for
|
749
761
|
# checkboxes.
|
762
|
+
#
|
763
|
+
# Note: The following fields are mutually exclusive: `boolean_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `integer_value`, `float_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
750
764
|
# @!attribute [rw] integer_value
|
751
765
|
# @return [::Integer]
|
752
766
|
# Integer value.
|
767
|
+
#
|
768
|
+
# Note: The following fields are mutually exclusive: `integer_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `float_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
753
769
|
# @!attribute [rw] float_value
|
754
770
|
# @return [::Float]
|
755
771
|
# Float value.
|
772
|
+
#
|
773
|
+
# Note: The following fields are mutually exclusive: `float_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
756
774
|
# @!attribute [rw] text
|
757
775
|
# @return [::String]
|
758
776
|
# Optional. An optional field to store a normalized string.
|
@@ -988,10 +1006,14 @@ module Google
|
|
988
1006
|
# @return [::String]
|
989
1007
|
# If the change was made by a person specify the name or id of that
|
990
1008
|
# person.
|
1009
|
+
#
|
1010
|
+
# Note: The following fields are mutually exclusive: `agent`, `processor`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
991
1011
|
# @!attribute [rw] processor
|
992
1012
|
# @return [::String]
|
993
1013
|
# If the annotation was made by processor identify the processor by its
|
994
1014
|
# resource name.
|
1015
|
+
#
|
1016
|
+
# Note: The following fields are mutually exclusive: `processor`, `agent`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
995
1017
|
# @!attribute [rw] id
|
996
1018
|
# @return [::String]
|
997
1019
|
# Id of the revision, internally generated by doc proto storage.
|
@@ -1067,12 +1089,18 @@ module Google
|
|
1067
1089
|
# @!attribute [rw] text_block
|
1068
1090
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::DocumentLayout::DocumentLayoutBlock::LayoutTextBlock]
|
1069
1091
|
# Block consisting of text content.
|
1092
|
+
#
|
1093
|
+
# Note: The following fields are mutually exclusive: `text_block`, `table_block`, `list_block`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1070
1094
|
# @!attribute [rw] table_block
|
1071
1095
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::DocumentLayout::DocumentLayoutBlock::LayoutTableBlock]
|
1072
1096
|
# Block consisting of table content/structure.
|
1097
|
+
#
|
1098
|
+
# Note: The following fields are mutually exclusive: `table_block`, `text_block`, `list_block`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1073
1099
|
# @!attribute [rw] list_block
|
1074
1100
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::DocumentLayout::DocumentLayoutBlock::LayoutListBlock]
|
1075
1101
|
# Block consisting of list content/structure.
|
1102
|
+
#
|
1103
|
+
# Note: The following fields are mutually exclusive: `list_block`, `text_block`, `table_block`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1076
1104
|
# @!attribute [rw] block_id
|
1077
1105
|
# @return [::String]
|
1078
1106
|
# ID of the block.
|
@@ -1252,14 +1280,20 @@ module Google
|
|
1252
1280
|
# @!attribute [rw] revision_case
|
1253
1281
|
# @return [::Google::Cloud::DocumentAI::V1beta3::RevisionRef::RevisionCase]
|
1254
1282
|
# Reads the revision by the predefined case.
|
1283
|
+
#
|
1284
|
+
# Note: The following fields are mutually exclusive: `revision_case`, `revision_id`, `latest_processor_version`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1255
1285
|
# @!attribute [rw] revision_id
|
1256
1286
|
# @return [::String]
|
1257
1287
|
# Reads the revision given by the id.
|
1288
|
+
#
|
1289
|
+
# Note: The following fields are mutually exclusive: `revision_id`, `revision_case`, `latest_processor_version`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1258
1290
|
# @!attribute [rw] latest_processor_version
|
1259
1291
|
# @return [::String]
|
1260
1292
|
# Reads the revision generated by the processor version.
|
1261
1293
|
# The format takes the full resource name of processor version.
|
1262
1294
|
# `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
|
1295
|
+
#
|
1296
|
+
# Note: The following fields are mutually exclusive: `latest_processor_version`, `revision_case`, `revision_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1263
1297
|
class RevisionRef
|
1264
1298
|
include ::Google::Protobuf::MessageExts
|
1265
1299
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -75,9 +75,13 @@ module Google
|
|
75
75
|
# @!attribute [rw] gcs_prefix
|
76
76
|
# @return [::Google::Cloud::DocumentAI::V1beta3::GcsPrefix]
|
77
77
|
# The set of documents that match the specified Cloud Storage `gcs_prefix`.
|
78
|
+
#
|
79
|
+
# Note: The following fields are mutually exclusive: `gcs_prefix`, `gcs_documents`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
78
80
|
# @!attribute [rw] gcs_documents
|
79
81
|
# @return [::Google::Cloud::DocumentAI::V1beta3::GcsDocuments]
|
80
82
|
# The set of documents individually specified on Cloud Storage.
|
83
|
+
#
|
84
|
+
# Note: The following fields are mutually exclusive: `gcs_documents`, `gcs_prefix`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
81
85
|
class BatchDocumentsInputConfig
|
82
86
|
include ::Google::Protobuf::MessageExts
|
83
87
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -25,13 +25,19 @@ module Google
|
|
25
25
|
# @!attribute [rw] individual_page_selector
|
26
26
|
# @return [::Google::Cloud::DocumentAI::V1beta3::ProcessOptions::IndividualPageSelector]
|
27
27
|
# Which pages to process (1-indexed).
|
28
|
+
#
|
29
|
+
# Note: The following fields are mutually exclusive: `individual_page_selector`, `from_start`, `from_end`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
28
30
|
# @!attribute [rw] from_start
|
29
31
|
# @return [::Integer]
|
30
32
|
# Only process certain pages from the start. Process all if the document
|
31
33
|
# has fewer pages.
|
34
|
+
#
|
35
|
+
# Note: The following fields are mutually exclusive: `from_start`, `individual_page_selector`, `from_end`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
32
36
|
# @!attribute [rw] from_end
|
33
37
|
# @return [::Integer]
|
34
38
|
# Only process certain pages from the end, same as above.
|
39
|
+
#
|
40
|
+
# Note: The following fields are mutually exclusive: `from_end`, `individual_page_selector`, `from_start`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
35
41
|
# @!attribute [rw] ocr_config
|
36
42
|
# @return [::Google::Cloud::DocumentAI::V1beta3::OcrConfig]
|
37
43
|
# Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`.
|
@@ -98,12 +104,18 @@ module Google
|
|
98
104
|
# @!attribute [rw] inline_document
|
99
105
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document]
|
100
106
|
# An inline document proto.
|
107
|
+
#
|
108
|
+
# Note: The following fields are mutually exclusive: `inline_document`, `raw_document`, `gcs_document`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
101
109
|
# @!attribute [rw] raw_document
|
102
110
|
# @return [::Google::Cloud::DocumentAI::V1beta3::RawDocument]
|
103
111
|
# A raw document content (bytes).
|
112
|
+
#
|
113
|
+
# Note: The following fields are mutually exclusive: `raw_document`, `inline_document`, `gcs_document`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
104
114
|
# @!attribute [rw] gcs_document
|
105
115
|
# @return [::Google::Cloud::DocumentAI::V1beta3::GcsDocument]
|
106
116
|
# A raw document on Google Cloud Storage.
|
117
|
+
#
|
118
|
+
# Note: The following fields are mutually exclusive: `gcs_document`, `inline_document`, `raw_document`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
107
119
|
# @!attribute [rw] name
|
108
120
|
# @return [::String]
|
109
121
|
# Required. The resource name of the
|
@@ -787,9 +799,13 @@ module Google
|
|
787
799
|
# @!attribute [rw] custom_document_extraction_options
|
788
800
|
# @return [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::CustomDocumentExtractionOptions]
|
789
801
|
# Options to control Custom Document Extraction (CDE) Processor.
|
802
|
+
#
|
803
|
+
# Note: The following fields are mutually exclusive: `custom_document_extraction_options`, `foundation_model_tuning_options`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
790
804
|
# @!attribute [rw] foundation_model_tuning_options
|
791
805
|
# @return [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::FoundationModelTuningOptions]
|
792
806
|
# Options to control foundation model tuning of a processor.
|
807
|
+
#
|
808
|
+
# Note: The following fields are mutually exclusive: `foundation_model_tuning_options`, `custom_document_extraction_options`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
793
809
|
# @!attribute [rw] parent
|
794
810
|
# @return [::String]
|
795
811
|
# Required. The parent (project, location and processor) to create the new
|
@@ -1137,10 +1153,14 @@ module Google
|
|
1137
1153
|
# and destination processor need to be in the same environment and region.
|
1138
1154
|
# Note that ProcessorVersions with `model_type` `MODEL_TYPE_LLM` are not
|
1139
1155
|
# supported.
|
1156
|
+
#
|
1157
|
+
# Note: The following fields are mutually exclusive: `processor_version_source`, `external_processor_version_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1140
1158
|
# @!attribute [rw] external_processor_version_source
|
1141
1159
|
# @return [::Google::Cloud::DocumentAI::V1beta3::ImportProcessorVersionRequest::ExternalProcessorVersionSource]
|
1142
1160
|
# The source processor version to import from. It can be from a different
|
1143
1161
|
# environment and region than the destination processor.
|
1162
|
+
#
|
1163
|
+
# Note: The following fields are mutually exclusive: `external_processor_version_source`, `processor_version_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1144
1164
|
# @!attribute [rw] parent
|
1145
1165
|
# @return [::String]
|
1146
1166
|
# Required. The destination processor name to create the processor version
|
@@ -59,10 +59,14 @@ module Google
|
|
59
59
|
# @!attribute [rw] dataset_split
|
60
60
|
# @return [::Google::Cloud::DocumentAI::V1beta3::DatasetSplitType]
|
61
61
|
# Target dataset split where the documents must be stored.
|
62
|
+
#
|
63
|
+
# Note: The following fields are mutually exclusive: `dataset_split`, `auto_split_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
62
64
|
# @!attribute [rw] auto_split_config
|
63
65
|
# @return [::Google::Cloud::DocumentAI::V1beta3::ImportDocumentsRequest::BatchDocumentsImportConfig::AutoSplitConfig]
|
64
66
|
# If set, documents will be automatically split into training and test
|
65
67
|
# split category with the specified ratio.
|
68
|
+
#
|
69
|
+
# Note: The following fields are mutually exclusive: `auto_split_config`, `dataset_split`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
66
70
|
# @!attribute [rw] batch_input_config
|
67
71
|
# @return [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig]
|
68
72
|
# The common config to specify a set of documents used as input.
|
@@ -90,9 +90,13 @@ module Google
|
|
90
90
|
# @!attribute [rw] foundation_gen_ai_model_info
|
91
91
|
# @return [::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion::GenAiModelInfo::FoundationGenAiModelInfo]
|
92
92
|
# Information for a pretrained Google-managed foundation model.
|
93
|
+
#
|
94
|
+
# Note: The following fields are mutually exclusive: `foundation_gen_ai_model_info`, `custom_gen_ai_model_info`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
93
95
|
# @!attribute [rw] custom_gen_ai_model_info
|
94
96
|
# @return [::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo]
|
95
97
|
# Information for a custom Generative AI model created by the user.
|
98
|
+
#
|
99
|
+
# Note: The following fields are mutually exclusive: `custom_gen_ai_model_info`, `foundation_gen_ai_model_info`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
96
100
|
class GenAiModelInfo
|
97
101
|
include ::Google::Protobuf::MessageExts
|
98
102
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|