google-cloud-document_ai-v1 0.2.2 → 0.2.3

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2bfb26fd885978863dc1e4b15b4ca36b7bd768e6afd5a468dee387d40370a64f
4
- data.tar.gz: 4abf14e8918e52b9aacdbfd53c97611f9035c9d117da79485c9713f75a56fc96
3
+ metadata.gz: 24fbe2305962ad733b73b86b892f2cc056719f9b15ae68448b51af84f6f8e41e
4
+ data.tar.gz: 5ec64c940d4f4cee643127bcbf8574a87bceeebf170e2e329c9ba9d2ad9c28d2
5
5
  SHA512:
6
- metadata.gz: '033858b5aa5f0041b8e445127b63153aa16cba72a732b79fb72ce7ec2b1bc5cc51d50de4a8dada54f8c3b09a29b027141c479bf3fd7cde0250c79875788ef9ca'
7
- data.tar.gz: 31d2c286119ad7ee3b0ff492775a532ac3395af4386083db03e420059252f89d991901d9a67ad2cc55f431f7c8fea43def6fd8be730920ad763d1d4f0b559a9b
6
+ metadata.gz: e0b706410acad88a8670fcd63053426d20a3de05d4aa97d1e573c583262af4bbe6394df875c26bcbe0c7e0cfa4550cf96988db55b1acbf8def5e9ac2e5b7eb30
7
+ data.tar.gz: 69bedf13c4c6362ca21903f79eafc347420b2222931a545679ecac9351e9df6dbb0224b09ae5ae2e87147028dbdc1e319a017910e3ae25a66e5ffb9bb9252d57
@@ -210,6 +210,21 @@ module Google
210
210
  #
211
211
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
212
212
  #
213
+ # @example Basic example
214
+ # require "google/cloud/document_ai/v1"
215
+ #
216
+ # # Create a client object. The client can be reused for multiple calls.
217
+ # client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new
218
+ #
219
+ # # Create a request. To set request fields, pass in keyword arguments.
220
+ # request = Google::Cloud::DocumentAI::V1::ProcessRequest.new
221
+ #
222
+ # # Call the process_document method.
223
+ # result = client.process_document request
224
+ #
225
+ # # The returned object is of type Google::Cloud::DocumentAI::V1::ProcessResponse.
226
+ # p result
227
+ #
213
228
  def process_document request, options = nil
214
229
  raise ::ArgumentError, "request must be provided" if request.nil?
215
230
 
@@ -227,9 +242,11 @@ module Google
227
242
  gapic_version: ::Google::Cloud::DocumentAI::V1::VERSION
228
243
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
229
244
 
230
- header_params = {
231
- "name" => request.name
232
- }
245
+ header_params = {}
246
+ if request.name
247
+ header_params["name"] = request.name
248
+ end
249
+
233
250
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
234
251
  metadata[:"x-goog-request-params"] ||= request_params_header
235
252
 
@@ -286,6 +303,28 @@ module Google
286
303
  #
287
304
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
288
305
  #
306
+ # @example Basic example
307
+ # require "google/cloud/document_ai/v1"
308
+ #
309
+ # # Create a client object. The client can be reused for multiple calls.
310
+ # client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new
311
+ #
312
+ # # Create a request. To set request fields, pass in keyword arguments.
313
+ # request = Google::Cloud::DocumentAI::V1::BatchProcessRequest.new
314
+ #
315
+ # # Call the batch_process_documents method.
316
+ # result = client.batch_process_documents request
317
+ #
318
+ # # The returned object is of type Gapic::Operation. You can use this
319
+ # # object to check the status of an operation, cancel it, or wait
320
+ # # for results. Here is how to block until completion:
321
+ # result.wait_until_done! timeout: 60
322
+ # if result.response?
323
+ # p result.response
324
+ # else
325
+ # puts "Error!"
326
+ # end
327
+ #
289
328
  def batch_process_documents request, options = nil
290
329
  raise ::ArgumentError, "request must be provided" if request.nil?
291
330
 
@@ -303,9 +342,11 @@ module Google
303
342
  gapic_version: ::Google::Cloud::DocumentAI::V1::VERSION
304
343
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
305
344
 
306
- header_params = {
307
- "name" => request.name
308
- }
345
+ header_params = {}
346
+ if request.name
347
+ header_params["name"] = request.name
348
+ end
349
+
309
350
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
310
351
  metadata[:"x-goog-request-params"] ||= request_params_header
311
352
 
@@ -363,6 +404,28 @@ module Google
363
404
  #
364
405
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
365
406
  #
407
+ # @example Basic example
408
+ # require "google/cloud/document_ai/v1"
409
+ #
410
+ # # Create a client object. The client can be reused for multiple calls.
411
+ # client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new
412
+ #
413
+ # # Create a request. To set request fields, pass in keyword arguments.
414
+ # request = Google::Cloud::DocumentAI::V1::ReviewDocumentRequest.new
415
+ #
416
+ # # Call the review_document method.
417
+ # result = client.review_document request
418
+ #
419
+ # # The returned object is of type Gapic::Operation. You can use this
420
+ # # object to check the status of an operation, cancel it, or wait
421
+ # # for results. Here is how to block until completion:
422
+ # result.wait_until_done! timeout: 60
423
+ # if result.response?
424
+ # p result.response
425
+ # else
426
+ # puts "Error!"
427
+ # end
428
+ #
366
429
  def review_document request, options = nil
367
430
  raise ::ArgumentError, "request must be provided" if request.nil?
368
431
 
@@ -380,9 +443,11 @@ module Google
380
443
  gapic_version: ::Google::Cloud::DocumentAI::V1::VERSION
381
444
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
382
445
 
383
- header_params = {
384
- "human_review_config" => request.human_review_config
385
- }
446
+ header_params = {}
447
+ if request.human_review_config
448
+ header_params["human_review_config"] = request.human_review_config
449
+ end
450
+
386
451
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
387
452
  metadata[:"x-goog-request-params"] ||= request_params_header
388
453
 
@@ -143,6 +143,27 @@ module Google
143
143
  #
144
144
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
145
145
  #
146
+ # @example Basic example
147
+ # require "google/longrunning"
148
+ #
149
+ # # Create a client object. The client can be reused for multiple calls.
150
+ # client = Google::Longrunning::Operations::Client.new
151
+ #
152
+ # # Create a request. To set request fields, pass in keyword arguments.
153
+ # request = Google::Longrunning::ListOperationsRequest.new
154
+ #
155
+ # # Call the list_operations method.
156
+ # result = client.list_operations request
157
+ #
158
+ # # The returned object is of type Gapic::PagedEnumerable. You can
159
+ # # iterate over all elements by calling #each, and the enumerable
160
+ # # will lazily make API calls to fetch subsequent pages. Other
161
+ # # methods are also available for managing paging directly.
162
+ # result.each do |response|
163
+ # # Each element is of type ::Google::Longrunning::Operation.
164
+ # p response
165
+ # end
166
+ #
146
167
  def list_operations request, options = nil
147
168
  raise ::ArgumentError, "request must be provided" if request.nil?
148
169
 
@@ -160,9 +181,11 @@ module Google
160
181
  gapic_version: ::Google::Cloud::DocumentAI::V1::VERSION
161
182
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
162
183
 
163
- header_params = {
164
- "name" => request.name
165
- }
184
+ header_params = {}
185
+ if request.name
186
+ header_params["name"] = request.name
187
+ end
188
+
166
189
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
167
190
  metadata[:"x-goog-request-params"] ||= request_params_header
168
191
 
@@ -215,6 +238,28 @@ module Google
215
238
  #
216
239
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
217
240
  #
241
+ # @example Basic example
242
+ # require "google/longrunning"
243
+ #
244
+ # # Create a client object. The client can be reused for multiple calls.
245
+ # client = Google::Longrunning::Operations::Client.new
246
+ #
247
+ # # Create a request. To set request fields, pass in keyword arguments.
248
+ # request = Google::Longrunning::GetOperationRequest.new
249
+ #
250
+ # # Call the get_operation method.
251
+ # result = client.get_operation request
252
+ #
253
+ # # The returned object is of type Gapic::Operation. You can use this
254
+ # # object to check the status of an operation, cancel it, or wait
255
+ # # for results. Here is how to block until completion:
256
+ # result.wait_until_done! timeout: 60
257
+ # if result.response?
258
+ # p result.response
259
+ # else
260
+ # puts "Error!"
261
+ # end
262
+ #
218
263
  def get_operation request, options = nil
219
264
  raise ::ArgumentError, "request must be provided" if request.nil?
220
265
 
@@ -232,9 +277,11 @@ module Google
232
277
  gapic_version: ::Google::Cloud::DocumentAI::V1::VERSION
233
278
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
234
279
 
235
- header_params = {
236
- "name" => request.name
237
- }
280
+ header_params = {}
281
+ if request.name
282
+ header_params["name"] = request.name
283
+ end
284
+
238
285
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
239
286
  metadata[:"x-goog-request-params"] ||= request_params_header
240
287
 
@@ -287,6 +334,21 @@ module Google
287
334
  #
288
335
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
289
336
  #
337
+ # @example Basic example
338
+ # require "google/longrunning"
339
+ #
340
+ # # Create a client object. The client can be reused for multiple calls.
341
+ # client = Google::Longrunning::Operations::Client.new
342
+ #
343
+ # # Create a request. To set request fields, pass in keyword arguments.
344
+ # request = Google::Longrunning::DeleteOperationRequest.new
345
+ #
346
+ # # Call the delete_operation method.
347
+ # result = client.delete_operation request
348
+ #
349
+ # # The returned object is of type Google::Protobuf::Empty.
350
+ # p result
351
+ #
290
352
  def delete_operation request, options = nil
291
353
  raise ::ArgumentError, "request must be provided" if request.nil?
292
354
 
@@ -304,9 +366,11 @@ module Google
304
366
  gapic_version: ::Google::Cloud::DocumentAI::V1::VERSION
305
367
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
306
368
 
307
- header_params = {
308
- "name" => request.name
309
- }
369
+ header_params = {}
370
+ if request.name
371
+ header_params["name"] = request.name
372
+ end
373
+
310
374
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
311
375
  metadata[:"x-goog-request-params"] ||= request_params_header
312
376
 
@@ -364,6 +428,21 @@ module Google
364
428
  #
365
429
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
366
430
  #
431
+ # @example Basic example
432
+ # require "google/longrunning"
433
+ #
434
+ # # Create a client object. The client can be reused for multiple calls.
435
+ # client = Google::Longrunning::Operations::Client.new
436
+ #
437
+ # # Create a request. To set request fields, pass in keyword arguments.
438
+ # request = Google::Longrunning::CancelOperationRequest.new
439
+ #
440
+ # # Call the cancel_operation method.
441
+ # result = client.cancel_operation request
442
+ #
443
+ # # The returned object is of type Google::Protobuf::Empty.
444
+ # p result
445
+ #
367
446
  def cancel_operation request, options = nil
368
447
  raise ::ArgumentError, "request must be provided" if request.nil?
369
448
 
@@ -381,9 +460,11 @@ module Google
381
460
  gapic_version: ::Google::Cloud::DocumentAI::V1::VERSION
382
461
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
383
462
 
384
- header_params = {
385
- "name" => request.name
386
- }
463
+ header_params = {}
464
+ if request.name
465
+ header_params["name"] = request.name
466
+ end
467
+
387
468
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
388
469
  metadata[:"x-goog-request-params"] ||= request_params_header
389
470
 
@@ -444,6 +525,28 @@ module Google
444
525
  #
445
526
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
446
527
  #
528
+ # @example Basic example
529
+ # require "google/longrunning"
530
+ #
531
+ # # Create a client object. The client can be reused for multiple calls.
532
+ # client = Google::Longrunning::Operations::Client.new
533
+ #
534
+ # # Create a request. To set request fields, pass in keyword arguments.
535
+ # request = Google::Longrunning::WaitOperationRequest.new
536
+ #
537
+ # # Call the wait_operation method.
538
+ # result = client.wait_operation request
539
+ #
540
+ # # The returned object is of type Gapic::Operation. You can use this
541
+ # # object to check the status of an operation, cancel it, or wait
542
+ # # for results. Here is how to block until completion:
543
+ # result.wait_until_done! timeout: 60
544
+ # if result.response?
545
+ # p result.response
546
+ # else
547
+ # puts "Error!"
548
+ # end
549
+ #
447
550
  def wait_operation request, options = nil
448
551
  raise ::ArgumentError, "request must be provided" if request.nil?
449
552
 
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module DocumentAI
23
23
  module V1
24
- VERSION = "0.2.2"
24
+ VERSION = "0.2.3"
25
25
  end
26
26
  end
27
27
  end
@@ -1,9 +1,9 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/cloud/documentai/v1/document_io.proto
3
3
 
4
+ require 'google/api/annotations_pb'
4
5
  require 'google/protobuf'
5
6
 
6
- require 'google/api/annotations_pb'
7
7
  Google::Protobuf::DescriptorPool.generated_pool.build do
8
8
  add_file("google/cloud/documentai/v1/document_io.proto", :syntax => :proto3) do
9
9
  add_message "google.cloud.documentai.v1.RawDocument" do
@@ -1,8 +1,6 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/cloud/documentai/v1/document.proto
3
3
 
4
- require 'google/protobuf'
5
-
6
4
  require 'google/api/field_behavior_pb'
7
5
  require 'google/cloud/documentai/v1/geometry_pb'
8
6
  require 'google/protobuf/timestamp_pb'
@@ -13,6 +11,8 @@ require 'google/type/datetime_pb'
13
11
  require 'google/type/money_pb'
14
12
  require 'google/type/postal_address_pb'
15
13
  require 'google/api/annotations_pb'
14
+ require 'google/protobuf'
15
+
16
16
  Google::Protobuf::DescriptorPool.generated_pool.build do
17
17
  add_file("google/cloud/documentai/v1/document.proto", :syntax => :proto3) do
18
18
  add_message "google.cloud.documentai.v1.Document" do
@@ -1,8 +1,6 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/cloud/documentai/v1/document_processor_service.proto
3
3
 
4
- require 'google/protobuf'
5
-
6
4
  require 'google/api/annotations_pb'
7
5
  require 'google/api/client_pb'
8
6
  require 'google/api/field_behavior_pb'
@@ -14,6 +12,8 @@ require 'google/longrunning/operations_pb'
14
12
  require 'google/protobuf/field_mask_pb'
15
13
  require 'google/protobuf/timestamp_pb'
16
14
  require 'google/rpc/status_pb'
15
+ require 'google/protobuf'
16
+
17
17
  Google::Protobuf::DescriptorPool.generated_pool.build do
18
18
  add_file("google/cloud/documentai/v1/document_processor_service.proto", :syntax => :proto3) do
19
19
  add_message "google.cloud.documentai.v1.ProcessRequest" do
@@ -30,7 +30,7 @@ module Google
30
30
  # structured information from unstructured or semi-structured documents.
31
31
  class Service
32
32
 
33
- include GRPC::GenericService
33
+ include ::GRPC::GenericService
34
34
 
35
35
  self.marshal_class_method = :encode
36
36
  self.unmarshal_class_method = :decode
@@ -1,9 +1,9 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/cloud/documentai/v1/geometry.proto
3
3
 
4
+ require 'google/api/annotations_pb'
4
5
  require 'google/protobuf'
5
6
 
6
- require 'google/api/annotations_pb'
7
7
  Google::Protobuf::DescriptorPool.generated_pool.build do
8
8
  add_file("google/cloud/documentai/v1/geometry.proto", :syntax => :proto3) do
9
9
  add_message "google.cloud.documentai.v1.Vertex" do
@@ -1,10 +1,10 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/cloud/documentai/v1/operation_metadata.proto
3
3
 
4
- require 'google/protobuf'
5
-
6
4
  require 'google/protobuf/timestamp_pb'
7
5
  require 'google/api/annotations_pb'
6
+ require 'google/protobuf'
7
+
8
8
  Google::Protobuf::DescriptorPool.generated_pool.build do
9
9
  add_file("google/cloud/documentai/v1/operation_metadata.proto", :syntax => :proto3) do
10
10
  add_message "google.cloud.documentai.v1.CommonOperationMetadata" do
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-document_ai-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.2
4
+ version: 0.2.3
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-08-11 00:00:00.000000000 Z
11
+ date: 2021-11-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common