google-cloud-document_ai-v1beta3 0.23.0 → 0.25.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (35) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/document_ai/v1beta3/document_processor_service/client.rb +57 -40
  3. data/lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/client.rb +57 -40
  4. data/lib/google/cloud/document_ai/v1beta3/document_processor_service/rest.rb +1 -1
  5. data/lib/google/cloud/document_ai/v1beta3/document_processor_service.rb +1 -1
  6. data/lib/google/cloud/document_ai/v1beta3/document_service/client.rb +932 -0
  7. data/lib/google/cloud/document_ai/v1beta3/document_service/credentials.rb +51 -0
  8. data/lib/google/cloud/document_ai/v1beta3/document_service/operations.rb +770 -0
  9. data/lib/google/cloud/document_ai/v1beta3/document_service/paths.rb +90 -0
  10. data/lib/google/cloud/document_ai/v1beta3/document_service/rest/client.rb +761 -0
  11. data/lib/google/cloud/document_ai/v1beta3/document_service/rest/operations.rb +815 -0
  12. data/lib/google/cloud/document_ai/v1beta3/document_service/rest/service_stub.rb +406 -0
  13. data/lib/google/cloud/document_ai/v1beta3/document_service/rest.rb +54 -0
  14. data/lib/google/cloud/document_ai/v1beta3/document_service.rb +56 -0
  15. data/lib/google/cloud/document_ai/v1beta3/rest.rb +1 -0
  16. data/lib/google/cloud/document_ai/v1beta3/version.rb +1 -1
  17. data/lib/google/cloud/document_ai/v1beta3.rb +1 -0
  18. data/lib/google/cloud/documentai/v1beta3/dataset_pb.rb +62 -0
  19. data/lib/google/cloud/documentai/v1beta3/document_io_pb.rb +1 -1
  20. data/lib/google/cloud/documentai/v1beta3/document_pb.rb +4 -1
  21. data/lib/google/cloud/documentai/v1beta3/document_processor_service_pb.rb +4 -1
  22. data/lib/google/cloud/documentai/v1beta3/document_processor_service_services_pb.rb +8 -6
  23. data/lib/google/cloud/documentai/v1beta3/document_schema_pb.rb +3 -1
  24. data/lib/google/cloud/documentai/v1beta3/document_service_pb.rb +78 -0
  25. data/lib/google/cloud/documentai/v1beta3/document_service_services_pb.rb +55 -0
  26. data/lib/google/cloud/documentai/v1beta3/processor_pb.rb +1 -1
  27. data/proto_docs/google/cloud/documentai/v1beta3/dataset.rb +187 -0
  28. data/proto_docs/google/cloud/documentai/v1beta3/document.rb +120 -27
  29. data/proto_docs/google/cloud/documentai/v1beta3/document_io.rb +10 -1
  30. data/proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb +261 -123
  31. data/proto_docs/google/cloud/documentai/v1beta3/document_schema.rb +44 -13
  32. data/proto_docs/google/cloud/documentai/v1beta3/document_service.rb +275 -0
  33. data/proto_docs/google/cloud/documentai/v1beta3/processor.rb +12 -10
  34. data/proto_docs/google/cloud/documentai/v1beta3/processor_type.rb +3 -2
  35. metadata +16 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 60d67b5bc0dc4a9e2a194fffeec7f521f254b2b3e807241b859b4f63722e3afa
4
- data.tar.gz: 48e6d0622a02f4268d6ca4b588eb505605c2fbbd851aae11e5a5e5b5af0e8386
3
+ metadata.gz: c60364ce123a47b9ac5ac09894c35cd341119e5bef78659fe766a510a7f55b53
4
+ data.tar.gz: 0ac3e4c8b1af36c2db5b8142d197ffaa631d7415245db9912dcf17b8bde5515d
5
5
  SHA512:
6
- metadata.gz: '08699863619993f0864b4d3669e957c5780d7a457f4aa3db237c7192f5f50068ae4ed8505837f6193b471146324e4a5a81d7055849e2a643a09dbac1b15f9c88'
7
- data.tar.gz: 3df39d6e1ca108dc843f2ea4e241f6258382a28f5efe79013c37de849bfdbb31de753bca5b79072ecb7d387976faa243609a5e9754adc3ada54bfd012e755c94
6
+ metadata.gz: fbcb8b8d5f7afaf9a56df2b6349e186c3844d6d5d705433818a58ad14ab0fd248d7993de3ed2cc8c940aca8b754392505556e47923dde66a7e4a3b2a99636f28
7
+ data.tar.gz: d0fa8e1ebf02342c6130c2d24cb10c109b34b4cc003a7bfd91c7faeca1ba63f406a1b811a274a9c2c2a3e4d53c5b6771cdeb0376d28bd4fa9d2cb5d1fa293049
data/lib/google/cloud/document_ai/v1beta3/document_processor_service/client.rb CHANGED
@@ -28,7 +28,7 @@ module Google
28
28
  ##
29
29
  # Client for the DocumentProcessorService service.
30
30
  #
31
- # Service to call Cloud DocumentAI to process documents according to the
31
+ # Service to call Document AI to process documents according to the
32
32
  # processor's definition. Processors are built using state-of-the-art Google
33
33
  # AI such as natural language, computer vision, and translation to extract
34
34
  # structured information from unstructured or semi-structured documents.
@@ -68,7 +68,7 @@ module Google
68
68
  end
69
69
  default_config = Client::Configuration.new parent_config
70
70
 
71
- default_config.rpcs.process_document.timeout = 120.0
71
+ default_config.rpcs.process_document.timeout = 300.0
72
72
  default_config.rpcs.process_document.retry_policy = {
73
73
  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
74
74
  }
@@ -202,7 +202,7 @@ module Google
202
202
  # @param options [::Gapic::CallOptions, ::Hash]
203
203
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
204
204
  #
205
- # @overload process_document(inline_document: nil, raw_document: nil, name: nil, document: nil, skip_human_review: nil, field_mask: nil, process_options: nil)
205
+ # @overload process_document(inline_document: nil, raw_document: nil, gcs_document: nil, name: nil, document: nil, skip_human_review: nil, field_mask: nil, process_options: nil)
206
206
  # Pass arguments to `process_document` via keyword arguments. Note that at
207
207
  # least one keyword argument is required. To specify no parameters, or to keep all
208
208
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -211,6 +211,8 @@ module Google
211
211
  # An inline document proto.
212
212
  # @param raw_document [::Google::Cloud::DocumentAI::V1beta3::RawDocument, ::Hash]
213
213
  # A raw document content (bytes).
214
+ # @param gcs_document [::Google::Cloud::DocumentAI::V1beta3::GcsDocument, ::Hash]
215
+ # A raw document on Google Cloud Storage.
214
216
  # @param name [::String]
215
217
  # Required. The resource name of the
216
218
  # {::Google::Cloud::DocumentAI::V1beta3::Processor Processor} or
@@ -223,14 +225,18 @@ module Google
223
225
  # or
224
226
  # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
225
227
  # @param document [::Google::Cloud::DocumentAI::V1beta3::Document, ::Hash]
226
- # The document payload, the [content] and [mime_type] fields must be set.
228
+ # The document payload, the
229
+ # {::Google::Cloud::DocumentAI::V1beta3::Document#content content} and
230
+ # {::Google::Cloud::DocumentAI::V1beta3::Document#mime_type mime_type} fields must
231
+ # be set.
227
232
  # @param skip_human_review [::Boolean]
228
- # Whether Human Review feature should be skipped for this request. Default to
229
- # false.
233
+ # Whether human review should be skipped for this request. Default to
234
+ # `false`.
230
235
  # @param field_mask [::Google::Protobuf::FieldMask, ::Hash]
231
- # Specifies which fields to include in ProcessResponse's document.
232
- # Only supports top level document and pages field so it must be in the form
233
- # of `{document_field_name}` or `pages.{page_field_name}`.
236
+ # Specifies which fields to include in the
237
+ # {::Google::Cloud::DocumentAI::V1beta3::ProcessResponse#document ProcessResponse.document}
238
+ # output. Only supports top-level document and pages field, so it must be in
239
+ # the form of `{document_field_name}` or `pages.{page_field_name}`.
234
240
  # @param process_options [::Google::Cloud::DocumentAI::V1beta3::ProcessOptions, ::Hash]
235
241
  # Inference-time options for the process API
236
242
  #
@@ -329,12 +335,16 @@ module Google
329
335
  # @param output_config [::Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest::BatchOutputConfig, ::Hash]
330
336
  # The overall output config for batch process.
331
337
  # @param input_documents [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig, ::Hash]
332
- # The input documents for batch process.
338
+ # The input documents for the
339
+ # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#batch_process_documents BatchProcessDocuments}
340
+ # method.
333
341
  # @param document_output_config [::Google::Cloud::DocumentAI::V1beta3::DocumentOutputConfig, ::Hash]
334
- # The overall output config for batch process.
342
+ # The output configuration for the
343
+ # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#batch_process_documents BatchProcessDocuments}
344
+ # method.
335
345
  # @param skip_human_review [::Boolean]
336
- # Whether Human Review feature should be skipped for this request. Default to
337
- # false.
346
+ # Whether human review should be skipped for this request. Default to
347
+ # `false`.
338
348
  # @param process_options [::Google::Cloud::DocumentAI::V1beta3::ProcessOptions, ::Hash]
339
349
  # Inference-time options for the process API
340
350
  #
@@ -411,8 +421,9 @@ module Google
411
421
  end
412
422
 
413
423
  ##
414
- # Fetches processor types. Note that we do not use ListProcessorTypes here
415
- # because it is not paginated.
424
+ # Fetches processor types. Note that we don't use
425
+ # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#list_processor_types ListProcessorTypes}
426
+ # here, because it isn't paginated.
416
427
  #
417
428
  # @overload fetch_processor_types(request, options = nil)
418
429
  # Pass arguments to `fetch_processor_types` via a request object, either of type
@@ -430,9 +441,8 @@ module Google
430
441
  # the default parameter values, pass an empty Hash as a request object (see above).
431
442
  #
432
443
  # @param parent [::String]
433
- # Required. The project of processor type to list.
434
- # The available processor types may depend on the allow-listing on projects.
435
- # Format: `projects/{project}/locations/{location}`
444
+ # Required. The location of processor types to list.
445
+ # Format: `projects/{project}/locations/{location}`.
436
446
  #
437
447
  # @yield [response, operation] Access the result along with the RPC operation
438
448
  # @yieldparam response [::Google::Cloud::DocumentAI::V1beta3::FetchProcessorTypesResponse]
@@ -517,13 +527,12 @@ module Google
517
527
  # the default parameter values, pass an empty Hash as a request object (see above).
518
528
  #
519
529
  # @param parent [::String]
520
- # Required. The location of processor type to list.
521
- # The available processor types may depend on the allow-listing on projects.
522
- # Format: `projects/{project}/locations/{location}`
530
+ # Required. The location of processor types to list.
531
+ # Format: `projects/{project}/locations/{location}`.
523
532
  # @param page_size [::Integer]
524
533
  # The maximum number of processor types to return.
525
- # If unspecified, at most 100 processor types will be returned.
526
- # The maximum value is 500; values above 500 will be coerced to 500.
534
+ # If unspecified, at most `100` processor types will be returned.
535
+ # The maximum value is `500`. Values above `500` will be coerced to `500`.
527
536
  # @param page_token [::String]
528
537
  # Used to retrieve the next page of results, empty if at the end of the list.
529
538
  #
@@ -704,8 +713,8 @@ module Google
704
713
  # Processors. Format: `projects/{project}/locations/{location}`
705
714
  # @param page_size [::Integer]
706
715
  # The maximum number of processors to return.
707
- # If unspecified, at most 50 processors will be returned.
708
- # The maximum value is 100; values above 100 will be coerced to 100.
716
+ # If unspecified, at most `50` processors will be returned.
717
+ # The maximum value is `100`. Values above `100` will be coerced to `100`.
709
718
  # @param page_token [::String]
710
719
  # We will return the processors sorted by creation time. The page token
711
720
  # will point to the next processor.
@@ -867,7 +876,7 @@ module Google
867
876
  ##
868
877
  # Trains a new processor version.
869
878
  # Operation metadata is returned as
870
- # cloud_documentai_core.TrainProcessorVersionMetadata.
879
+ # {::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionMetadata TrainProcessorVersionMetadata}.
871
880
  #
872
881
  # @overload train_processor_version(request, options = nil)
873
882
  # Pass arguments to `train_processor_version` via a request object, either of type
@@ -879,11 +888,13 @@ module Google
879
888
  # @param options [::Gapic::CallOptions, ::Hash]
880
889
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
881
890
  #
882
- # @overload train_processor_version(parent: nil, processor_version: nil, document_schema: nil, input_data: nil, base_processor_version: nil)
891
+ # @overload train_processor_version(custom_document_extraction_options: nil, parent: nil, processor_version: nil, document_schema: nil, input_data: nil, base_processor_version: nil)
883
892
  # Pass arguments to `train_processor_version` via keyword arguments. Note that at
884
893
  # least one keyword argument is required. To specify no parameters, or to keep all
885
894
  # the default parameter values, pass an empty Hash as a request object (see above).
886
895
  #
896
+ # @param custom_document_extraction_options [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::CustomDocumentExtractionOptions, ::Hash]
897
+ # Options to control Custom Document Extraction (CDE) Processor.
887
898
  # @param parent [::String]
888
899
  # Required. The parent (project, location and processor) to create the new
889
900
  # version for. Format:
@@ -893,7 +904,8 @@ module Google
893
904
  # @param document_schema [::Google::Cloud::DocumentAI::V1beta3::DocumentSchema, ::Hash]
894
905
  # Optional. The schema the processor version will be trained with.
895
906
  # @param input_data [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::InputData, ::Hash]
896
- # Optional. The input data used to train the `ProcessorVersion`.
907
+ # Optional. The input data used to train the
908
+ # {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion}.
897
909
  # @param base_processor_version [::String]
898
910
  # Optional. The processor version to use as a base for training. This
899
911
  # processor version must be a child of `parent`. Format:
@@ -1080,8 +1092,8 @@ module Google
1080
1092
  # `projects/{project}/locations/{location}/processors/{processor}`
1081
1093
  # @param page_size [::Integer]
1082
1094
  # The maximum number of processor versions to return.
1083
- # If unspecified, at most 10 processor versions will be returned.
1084
- # The maximum value is 20; values above 20 will be coerced to 20.
1095
+ # If unspecified, at most `10` processor versions will be returned.
1096
+ # The maximum value is `20`. Values above `20` will be coerced to `20`.
1085
1097
  # @param page_token [::String]
1086
1098
  # We will return the processor versions sorted by creation time. The page
1087
1099
  # token will point to the next processor version.
@@ -1436,8 +1448,9 @@ module Google
1436
1448
  end
1437
1449
 
1438
1450
  ##
1439
- # Creates a processor from the type processor that the user chose.
1440
- # The processor will be at "ENABLED" state by default after its creation.
1451
+ # Creates a processor from the
1452
+ # {::Google::Cloud::DocumentAI::V1beta3::ProcessorType ProcessorType} provided.
1453
+ # The processor will be at `ENABLED` state by default after its creation.
1441
1454
  #
1442
1455
  # @overload create_processor(request, options = nil)
1443
1456
  # Pass arguments to `create_processor` via a request object, either of type
@@ -1458,9 +1471,11 @@ module Google
1458
1471
  # Required. The parent (project and location) under which to create the
1459
1472
  # processor. Format: `projects/{project}/locations/{location}`
1460
1473
  # @param processor [::Google::Cloud::DocumentAI::V1beta3::Processor, ::Hash]
1461
- # Required. The processor to be created, requires [processor_type] and
1462
- # [display_name] to be set. Also, the processor is under CMEK if CMEK fields
1463
- # are set.
1474
+ # Required. The processor to be created, requires
1475
+ # {::Google::Cloud::DocumentAI::V1beta3::Processor#type Processor.type} and
1476
+ # [Processor.display_name]][] to be set. Also, the
1477
+ # {::Google::Cloud::DocumentAI::V1beta3::Processor#kms_key_name Processor.kms_key_name}
1478
+ # field must be set if the processor is under CMEK.
1464
1479
  #
1465
1480
  # @yield [response, operation] Access the result along with the RPC operation
1466
1481
  # @yieldparam response [::Google::Cloud::DocumentAI::V1beta3::Processor]
@@ -1932,8 +1947,9 @@ module Google
1932
1947
  # @param inline_document [::Google::Cloud::DocumentAI::V1beta3::Document, ::Hash]
1933
1948
  # An inline document proto.
1934
1949
  # @param human_review_config [::String]
1935
- # Required. The resource name of the HumanReviewConfig that the document will
1936
- # be reviewed with.
1950
+ # Required. The resource name of the
1951
+ # [HumanReviewConfig][google.cloud.documentai.v1beta3.HumanReviewConfig] that
1952
+ # the document will be reviewed with.
1937
1953
  # @param document [::Google::Cloud::DocumentAI::V1beta3::Document, ::Hash]
1938
1954
  # The document that needs human review.
1939
1955
  # @param enable_schema_validation [::Boolean]
@@ -2227,8 +2243,8 @@ module Google
2227
2243
  # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
2228
2244
  # @param page_size [::Integer]
2229
2245
  # The standard list page size.
2230
- # If unspecified, at most 5 evaluations will be returned.
2231
- # The maximum value is 100; values above 100 will be coerced to 100.
2246
+ # If unspecified, at most `5` evaluations are returned.
2247
+ # The maximum value is `100`. Values above `100` are coerced to `100`.
2232
2248
  # @param page_token [::String]
2233
2249
  # A page token, received from a previous `ListEvaluations` call.
2234
2250
  # Provide this to retrieve the subsequent page.
@@ -2321,7 +2337,8 @@ module Google
2321
2337
  # the default parameter values, pass an empty Hash as a request object (see above).
2322
2338
  #
2323
2339
  # @param processor_version_source [::String]
2324
- # The source processor version to import from.
2340
+ # The source processor version to import from. The source processor version
2341
+ # and destination processor need to be in the same environment and region.
2325
2342
  # @param parent [::String]
2326
2343
  # Required. The destination processor name to create the processor version
2327
2344
  # in. Format:
data/lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/client.rb CHANGED
@@ -30,7 +30,7 @@ module Google
30
30
  ##
31
31
  # REST client for the DocumentProcessorService service.
32
32
  #
33
- # Service to call Cloud DocumentAI to process documents according to the
33
+ # Service to call Document AI to process documents according to the
34
34
  # processor's definition. Processors are built using state-of-the-art Google
35
35
  # AI such as natural language, computer vision, and translation to extract
36
36
  # structured information from unstructured or semi-structured documents.
@@ -70,7 +70,7 @@ module Google
70
70
  end
71
71
  default_config = Client::Configuration.new parent_config
72
72
 
73
- default_config.rpcs.process_document.timeout = 120.0
73
+ default_config.rpcs.process_document.timeout = 300.0
74
74
  default_config.rpcs.process_document.retry_policy = {
75
75
  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
76
76
  }
@@ -194,7 +194,7 @@ module Google
194
194
  # @param options [::Gapic::CallOptions, ::Hash]
195
195
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
196
196
  #
197
- # @overload process_document(inline_document: nil, raw_document: nil, name: nil, document: nil, skip_human_review: nil, field_mask: nil, process_options: nil)
197
+ # @overload process_document(inline_document: nil, raw_document: nil, gcs_document: nil, name: nil, document: nil, skip_human_review: nil, field_mask: nil, process_options: nil)
198
198
  # Pass arguments to `process_document` via keyword arguments. Note that at
199
199
  # least one keyword argument is required. To specify no parameters, or to keep all
200
200
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -203,6 +203,8 @@ module Google
203
203
  # An inline document proto.
204
204
  # @param raw_document [::Google::Cloud::DocumentAI::V1beta3::RawDocument, ::Hash]
205
205
  # A raw document content (bytes).
206
+ # @param gcs_document [::Google::Cloud::DocumentAI::V1beta3::GcsDocument, ::Hash]
207
+ # A raw document on Google Cloud Storage.
206
208
  # @param name [::String]
207
209
  # Required. The resource name of the
208
210
  # {::Google::Cloud::DocumentAI::V1beta3::Processor Processor} or
@@ -215,14 +217,18 @@ module Google
215
217
  # or
216
218
  # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
217
219
  # @param document [::Google::Cloud::DocumentAI::V1beta3::Document, ::Hash]
218
- # The document payload, the [content] and [mime_type] fields must be set.
220
+ # The document payload, the
221
+ # {::Google::Cloud::DocumentAI::V1beta3::Document#content content} and
222
+ # {::Google::Cloud::DocumentAI::V1beta3::Document#mime_type mime_type} fields must
223
+ # be set.
219
224
  # @param skip_human_review [::Boolean]
220
- # Whether Human Review feature should be skipped for this request. Default to
221
- # false.
225
+ # Whether human review should be skipped for this request. Default to
226
+ # `false`.
222
227
  # @param field_mask [::Google::Protobuf::FieldMask, ::Hash]
223
- # Specifies which fields to include in ProcessResponse's document.
224
- # Only supports top level document and pages field so it must be in the form
225
- # of `{document_field_name}` or `pages.{page_field_name}`.
228
+ # Specifies which fields to include in the
229
+ # {::Google::Cloud::DocumentAI::V1beta3::ProcessResponse#document ProcessResponse.document}
230
+ # output. Only supports top-level document and pages field, so it must be in
231
+ # the form of `{document_field_name}` or `pages.{page_field_name}`.
226
232
  # @param process_options [::Google::Cloud::DocumentAI::V1beta3::ProcessOptions, ::Hash]
227
233
  # Inference-time options for the process API
228
234
  # @yield [result, operation] Access the result along with the TransportOperation object
@@ -298,12 +304,16 @@ module Google
298
304
  # @param output_config [::Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest::BatchOutputConfig, ::Hash]
299
305
  # The overall output config for batch process.
300
306
  # @param input_documents [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig, ::Hash]
301
- # The input documents for batch process.
307
+ # The input documents for the
308
+ # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Rest::Client#batch_process_documents BatchProcessDocuments}
309
+ # method.
302
310
  # @param document_output_config [::Google::Cloud::DocumentAI::V1beta3::DocumentOutputConfig, ::Hash]
303
- # The overall output config for batch process.
311
+ # The output configuration for the
312
+ # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Rest::Client#batch_process_documents BatchProcessDocuments}
313
+ # method.
304
314
  # @param skip_human_review [::Boolean]
305
- # Whether Human Review feature should be skipped for this request. Default to
306
- # false.
315
+ # Whether human review should be skipped for this request. Default to
316
+ # `false`.
307
317
  # @param process_options [::Google::Cloud::DocumentAI::V1beta3::ProcessOptions, ::Hash]
308
318
  # Inference-time options for the process API
309
319
  # @yield [result, operation] Access the result along with the TransportOperation object
@@ -350,8 +360,9 @@ module Google
350
360
  end
351
361
 
352
362
  ##
353
- # Fetches processor types. Note that we do not use ListProcessorTypes here
354
- # because it is not paginated.
363
+ # Fetches processor types. Note that we don't use
364
+ # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Rest::Client#list_processor_types ListProcessorTypes}
365
+ # here, because it isn't paginated.
355
366
  #
356
367
  # @overload fetch_processor_types(request, options = nil)
357
368
  # Pass arguments to `fetch_processor_types` via a request object, either of type
@@ -369,9 +380,8 @@ module Google
369
380
  # the default parameter values, pass an empty Hash as a request object (see above).
370
381
  #
371
382
  # @param parent [::String]
372
- # Required. The project of processor type to list.
373
- # The available processor types may depend on the allow-listing on projects.
374
- # Format: `projects/{project}/locations/{location}`
383
+ # Required. The location of processor types to list.
384
+ # Format: `projects/{project}/locations/{location}`.
375
385
  # @yield [result, operation] Access the result along with the TransportOperation object
376
386
  # @yieldparam result [::Google::Cloud::DocumentAI::V1beta3::FetchProcessorTypesResponse]
377
387
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -433,13 +443,12 @@ module Google
433
443
  # the default parameter values, pass an empty Hash as a request object (see above).
434
444
  #
435
445
  # @param parent [::String]
436
- # Required. The location of processor type to list.
437
- # The available processor types may depend on the allow-listing on projects.
438
- # Format: `projects/{project}/locations/{location}`
446
+ # Required. The location of processor types to list.
447
+ # Format: `projects/{project}/locations/{location}`.
439
448
  # @param page_size [::Integer]
440
449
  # The maximum number of processor types to return.
441
- # If unspecified, at most 100 processor types will be returned.
442
- # The maximum value is 500; values above 500 will be coerced to 500.
450
+ # If unspecified, at most `100` processor types will be returned.
451
+ # The maximum value is `500`. Values above `500` will be coerced to `500`.
443
452
  # @param page_token [::String]
444
453
  # Used to retrieve the next page of results, empty if at the end of the list.
445
454
  # @yield [result, operation] Access the result along with the TransportOperation object
@@ -570,8 +579,8 @@ module Google
570
579
  # Processors. Format: `projects/{project}/locations/{location}`
571
580
  # @param page_size [::Integer]
572
581
  # The maximum number of processors to return.
573
- # If unspecified, at most 50 processors will be returned.
574
- # The maximum value is 100; values above 100 will be coerced to 100.
582
+ # If unspecified, at most `50` processors will be returned.
583
+ # The maximum value is `100`. Values above `100` will be coerced to `100`.
575
584
  # @param page_token [::String]
576
585
  # We will return the processors sorted by creation time. The page token
577
586
  # will point to the next processor.
@@ -683,7 +692,7 @@ module Google
683
692
  ##
684
693
  # Trains a new processor version.
685
694
  # Operation metadata is returned as
686
- # cloud_documentai_core.TrainProcessorVersionMetadata.
695
+ # {::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionMetadata TrainProcessorVersionMetadata}.
687
696
  #
688
697
  # @overload train_processor_version(request, options = nil)
689
698
  # Pass arguments to `train_processor_version` via a request object, either of type
@@ -695,11 +704,13 @@ module Google
695
704
  # @param options [::Gapic::CallOptions, ::Hash]
696
705
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
697
706
  #
698
- # @overload train_processor_version(parent: nil, processor_version: nil, document_schema: nil, input_data: nil, base_processor_version: nil)
707
+ # @overload train_processor_version(custom_document_extraction_options: nil, parent: nil, processor_version: nil, document_schema: nil, input_data: nil, base_processor_version: nil)
699
708
  # Pass arguments to `train_processor_version` via keyword arguments. Note that at
700
709
  # least one keyword argument is required. To specify no parameters, or to keep all
701
710
  # the default parameter values, pass an empty Hash as a request object (see above).
702
711
  #
712
+ # @param custom_document_extraction_options [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::CustomDocumentExtractionOptions, ::Hash]
713
+ # Options to control Custom Document Extraction (CDE) Processor.
703
714
  # @param parent [::String]
704
715
  # Required. The parent (project, location and processor) to create the new
705
716
  # version for. Format:
@@ -709,7 +720,8 @@ module Google
709
720
  # @param document_schema [::Google::Cloud::DocumentAI::V1beta3::DocumentSchema, ::Hash]
710
721
  # Optional. The schema the processor version will be trained with.
711
722
  # @param input_data [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::InputData, ::Hash]
712
- # Optional. The input data used to train the `ProcessorVersion`.
723
+ # Optional. The input data used to train the
724
+ # {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion}.
713
725
  # @param base_processor_version [::String]
714
726
  # Optional. The processor version to use as a base for training. This
715
727
  # processor version must be a child of `parent`. Format:
@@ -843,8 +855,8 @@ module Google
843
855
  # `projects/{project}/locations/{location}/processors/{processor}`
844
856
  # @param page_size [::Integer]
845
857
  # The maximum number of processor versions to return.
846
- # If unspecified, at most 10 processor versions will be returned.
847
- # The maximum value is 20; values above 20 will be coerced to 20.
858
+ # If unspecified, at most `10` processor versions will be returned.
859
+ # The maximum value is `20`. Values above `20` will be coerced to `20`.
848
860
  # @param page_token [::String]
849
861
  # We will return the processor versions sorted by creation time. The page
850
862
  # token will point to the next processor version.
@@ -1082,8 +1094,9 @@ module Google
1082
1094
  end
1083
1095
 
1084
1096
  ##
1085
- # Creates a processor from the type processor that the user chose.
1086
- # The processor will be at "ENABLED" state by default after its creation.
1097
+ # Creates a processor from the
1098
+ # {::Google::Cloud::DocumentAI::V1beta3::ProcessorType ProcessorType} provided.
1099
+ # The processor will be at `ENABLED` state by default after its creation.
1087
1100
  #
1088
1101
  # @overload create_processor(request, options = nil)
1089
1102
  # Pass arguments to `create_processor` via a request object, either of type
@@ -1104,9 +1117,11 @@ module Google
1104
1117
  # Required. The parent (project and location) under which to create the
1105
1118
  # processor. Format: `projects/{project}/locations/{location}`
1106
1119
  # @param processor [::Google::Cloud::DocumentAI::V1beta3::Processor, ::Hash]
1107
- # Required. The processor to be created, requires [processor_type] and
1108
- # [display_name] to be set. Also, the processor is under CMEK if CMEK fields
1109
- # are set.
1120
+ # Required. The processor to be created, requires
1121
+ # {::Google::Cloud::DocumentAI::V1beta3::Processor#type Processor.type} and
1122
+ # [Processor.display_name]][] to be set. Also, the
1123
+ # {::Google::Cloud::DocumentAI::V1beta3::Processor#kms_key_name Processor.kms_key_name}
1124
+ # field must be set if the processor is under CMEK.
1110
1125
  # @yield [result, operation] Access the result along with the TransportOperation object
1111
1126
  # @yieldparam result [::Google::Cloud::DocumentAI::V1beta3::Processor]
1112
1127
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1435,8 +1450,9 @@ module Google
1435
1450
  # @param inline_document [::Google::Cloud::DocumentAI::V1beta3::Document, ::Hash]
1436
1451
  # An inline document proto.
1437
1452
  # @param human_review_config [::String]
1438
- # Required. The resource name of the HumanReviewConfig that the document will
1439
- # be reviewed with.
1453
+ # Required. The resource name of the
1454
+ # [HumanReviewConfig][google.cloud.documentai.v1beta3.HumanReviewConfig] that
1455
+ # the document will be reviewed with.
1440
1456
  # @param document [::Google::Cloud::DocumentAI::V1beta3::Document, ::Hash]
1441
1457
  # The document that needs human review.
1442
1458
  # @param enable_schema_validation [::Boolean]
@@ -1647,8 +1663,8 @@ module Google
1647
1663
  # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
1648
1664
  # @param page_size [::Integer]
1649
1665
  # The standard list page size.
1650
- # If unspecified, at most 5 evaluations will be returned.
1651
- # The maximum value is 100; values above 100 will be coerced to 100.
1666
+ # If unspecified, at most `5` evaluations are returned.
1667
+ # The maximum value is `100`. Values above `100` are coerced to `100`.
1652
1668
  # @param page_token [::String]
1653
1669
  # A page token, received from a previous `ListEvaluations` call.
1654
1670
  # Provide this to retrieve the subsequent page.
@@ -1714,7 +1730,8 @@ module Google
1714
1730
  # the default parameter values, pass an empty Hash as a request object (see above).
1715
1731
  #
1716
1732
  # @param processor_version_source [::String]
1717
- # The source processor version to import from.
1733
+ # The source processor version to import from. The source processor version
1734
+ # and destination processor need to be in the same environment and region.
1718
1735
  # @param parent [::String]
1719
1736
  # Required. The destination processor name to create the processor version
1720
1737
  # in. Format:
data/lib/google/cloud/document_ai/v1beta3/document_processor_service/rest.rb CHANGED
@@ -33,7 +33,7 @@ module Google
33
33
  module DocumentAI
34
34
  module V1beta3
35
35
  ##
36
- # Service to call Cloud DocumentAI to process documents according to the
36
+ # Service to call Document AI to process documents according to the
37
37
  # processor's definition. Processors are built using state-of-the-art Google
38
38
  # AI such as natural language, computer vision, and translation to extract
39
39
  # structured information from unstructured or semi-structured documents.
data/lib/google/cloud/document_ai/v1beta3/document_processor_service.rb CHANGED
@@ -33,7 +33,7 @@ module Google
33
33
  module DocumentAI
34
34
  module V1beta3
35
35
  ##
36
- # Service to call Cloud DocumentAI to process documents according to the
36
+ # Service to call Document AI to process documents according to the
37
37
  # processor's definition. Processors are built using state-of-the-art Google
38
38
  # AI such as natural language, computer vision, and translation to extract
39
39
  # structured information from unstructured or semi-structured documents.