google-cloud-document_ai-v1beta3 0.23.0 → 0.24.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.
Files changed (35) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/document_ai/v1beta3/document_processor_service/client.rb +54 -39
  3. data/lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/client.rb +54 -39
  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 +618 -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 +530 -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 +227 -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 +55 -0
  19. data/lib/google/cloud/documentai/v1beta3/document_io_pb.rb +1 -1
  20. data/lib/google/cloud/documentai/v1beta3/document_pb.rb +2 -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 +57 -0
  25. data/lib/google/cloud/documentai/v1beta3/document_service_services_pb.rb +49 -0
  26. data/lib/google/cloud/documentai/v1beta3/processor_pb.rb +1 -1
  27. data/proto_docs/google/cloud/documentai/v1beta3/dataset.rb +125 -0
  28. data/proto_docs/google/cloud/documentai/v1beta3/document.rb +88 -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 +258 -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 +73 -0
  33. data/proto_docs/google/cloud/documentai/v1beta3/processor.rb +11 -9
  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: 874c654f8cfe406c08fae1cb6b257e899672238d977cfa5f174ffcef633394b3
4
+ data.tar.gz: ea4546e6df5ddbc579da1f9658fe3a6b680e6d6d1b56c5fc212fda0135973555
5
5
  SHA512:
6
- metadata.gz: '08699863619993f0864b4d3669e957c5780d7a457f4aa3db237c7192f5f50068ae4ed8505837f6193b471146324e4a5a81d7055849e2a643a09dbac1b15f9c88'
7
- data.tar.gz: 3df39d6e1ca108dc843f2ea4e241f6258382a28f5efe79013c37de849bfdbb31de753bca5b79072ecb7d387976faa243609a5e9754adc3ada54bfd012e755c94
6
+ metadata.gz: f5b707d9a7d247a2805a65420dbd938f5c51d010a152ef9104ca8510900d93d419b6975eabbeb700f9d5ec292d2edacc5665d86bf39bc27d9e82ba3c7131790a
7
+ data.tar.gz: 8184c01a1597bda5985cc3389f73612890ebc661dde4d527c8c00a76bc0d97bfe31331c04c77856f36cff631a0ffcadc27f0554993046be67cc988ade211d52e
@@ -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
  }
@@ -223,14 +223,18 @@ module Google
223
223
  # or
224
224
  # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
225
225
  # @param document [::Google::Cloud::DocumentAI::V1beta3::Document, ::Hash]
226
- # The document payload, the [content] and [mime_type] fields must be set.
226
+ # The document payload, the
227
+ # {::Google::Cloud::DocumentAI::V1beta3::Document#content content} and
228
+ # {::Google::Cloud::DocumentAI::V1beta3::Document#mime_type mime_type} fields must
229
+ # be set.
227
230
  # @param skip_human_review [::Boolean]
228
- # Whether Human Review feature should be skipped for this request. Default to
229
- # false.
231
+ # Whether human review should be skipped for this request. Default to
232
+ # `false`.
230
233
  # @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}`.
234
+ # Specifies which fields to include in the
235
+ # {::Google::Cloud::DocumentAI::V1beta3::ProcessResponse#document ProcessResponse.document}
236
+ # output. Only supports top-level document and pages field, so it must be in
237
+ # the form of `{document_field_name}` or `pages.{page_field_name}`.
234
238
  # @param process_options [::Google::Cloud::DocumentAI::V1beta3::ProcessOptions, ::Hash]
235
239
  # Inference-time options for the process API
236
240
  #
@@ -329,12 +333,16 @@ module Google
329
333
  # @param output_config [::Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest::BatchOutputConfig, ::Hash]
330
334
  # The overall output config for batch process.
331
335
  # @param input_documents [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig, ::Hash]
332
- # The input documents for batch process.
336
+ # The input documents for the
337
+ # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#batch_process_documents BatchProcessDocuments}
338
+ # method.
333
339
  # @param document_output_config [::Google::Cloud::DocumentAI::V1beta3::DocumentOutputConfig, ::Hash]
334
- # The overall output config for batch process.
340
+ # The output configuration for the
341
+ # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#batch_process_documents BatchProcessDocuments}
342
+ # method.
335
343
  # @param skip_human_review [::Boolean]
336
- # Whether Human Review feature should be skipped for this request. Default to
337
- # false.
344
+ # Whether human review should be skipped for this request. Default to
345
+ # `false`.
338
346
  # @param process_options [::Google::Cloud::DocumentAI::V1beta3::ProcessOptions, ::Hash]
339
347
  # Inference-time options for the process API
340
348
  #
@@ -411,8 +419,9 @@ module Google
411
419
  end
412
420
 
413
421
  ##
414
- # Fetches processor types. Note that we do not use ListProcessorTypes here
415
- # because it is not paginated.
422
+ # Fetches processor types. Note that we don't use
423
+ # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#list_processor_types ListProcessorTypes}
424
+ # here, because it isn't paginated.
416
425
  #
417
426
  # @overload fetch_processor_types(request, options = nil)
418
427
  # Pass arguments to `fetch_processor_types` via a request object, either of type
@@ -430,9 +439,8 @@ module Google
430
439
  # the default parameter values, pass an empty Hash as a request object (see above).
431
440
  #
432
441
  # @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}`
442
+ # Required. The location of processor types to list.
443
+ # Format: `projects/{project}/locations/{location}`.
436
444
  #
437
445
  # @yield [response, operation] Access the result along with the RPC operation
438
446
  # @yieldparam response [::Google::Cloud::DocumentAI::V1beta3::FetchProcessorTypesResponse]
@@ -517,13 +525,12 @@ module Google
517
525
  # the default parameter values, pass an empty Hash as a request object (see above).
518
526
  #
519
527
  # @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}`
528
+ # Required. The location of processor types to list.
529
+ # Format: `projects/{project}/locations/{location}`.
523
530
  # @param page_size [::Integer]
524
531
  # 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.
532
+ # If unspecified, at most `100` processor types will be returned.
533
+ # The maximum value is `500`. Values above `500` will be coerced to `500`.
527
534
  # @param page_token [::String]
528
535
  # Used to retrieve the next page of results, empty if at the end of the list.
529
536
  #
@@ -704,8 +711,8 @@ module Google
704
711
  # Processors. Format: `projects/{project}/locations/{location}`
705
712
  # @param page_size [::Integer]
706
713
  # 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.
714
+ # If unspecified, at most `50` processors will be returned.
715
+ # The maximum value is `100`. Values above `100` will be coerced to `100`.
709
716
  # @param page_token [::String]
710
717
  # We will return the processors sorted by creation time. The page token
711
718
  # will point to the next processor.
@@ -867,7 +874,7 @@ module Google
867
874
  ##
868
875
  # Trains a new processor version.
869
876
  # Operation metadata is returned as
870
- # cloud_documentai_core.TrainProcessorVersionMetadata.
877
+ # {::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionMetadata TrainProcessorVersionMetadata}.
871
878
  #
872
879
  # @overload train_processor_version(request, options = nil)
873
880
  # Pass arguments to `train_processor_version` via a request object, either of type
@@ -879,11 +886,13 @@ module Google
879
886
  # @param options [::Gapic::CallOptions, ::Hash]
880
887
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
881
888
  #
882
- # @overload train_processor_version(parent: nil, processor_version: nil, document_schema: nil, input_data: nil, base_processor_version: nil)
889
+ # @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
890
  # Pass arguments to `train_processor_version` via keyword arguments. Note that at
884
891
  # least one keyword argument is required. To specify no parameters, or to keep all
885
892
  # the default parameter values, pass an empty Hash as a request object (see above).
886
893
  #
894
+ # @param custom_document_extraction_options [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::CustomDocumentExtractionOptions, ::Hash]
895
+ # Options to control Custom Document Extraction (CDE) Processor.
887
896
  # @param parent [::String]
888
897
  # Required. The parent (project, location and processor) to create the new
889
898
  # version for. Format:
@@ -893,7 +902,8 @@ module Google
893
902
  # @param document_schema [::Google::Cloud::DocumentAI::V1beta3::DocumentSchema, ::Hash]
894
903
  # Optional. The schema the processor version will be trained with.
895
904
  # @param input_data [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::InputData, ::Hash]
896
- # Optional. The input data used to train the `ProcessorVersion`.
905
+ # Optional. The input data used to train the
906
+ # {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion}.
897
907
  # @param base_processor_version [::String]
898
908
  # Optional. The processor version to use as a base for training. This
899
909
  # processor version must be a child of `parent`. Format:
@@ -1080,8 +1090,8 @@ module Google
1080
1090
  # `projects/{project}/locations/{location}/processors/{processor}`
1081
1091
  # @param page_size [::Integer]
1082
1092
  # 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.
1093
+ # If unspecified, at most `10` processor versions will be returned.
1094
+ # The maximum value is `20`. Values above `20` will be coerced to `20`.
1085
1095
  # @param page_token [::String]
1086
1096
  # We will return the processor versions sorted by creation time. The page
1087
1097
  # token will point to the next processor version.
@@ -1436,8 +1446,9 @@ module Google
1436
1446
  end
1437
1447
 
1438
1448
  ##
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.
1449
+ # Creates a processor from the
1450
+ # {::Google::Cloud::DocumentAI::V1beta3::ProcessorType ProcessorType} provided.
1451
+ # The processor will be at `ENABLED` state by default after its creation.
1441
1452
  #
1442
1453
  # @overload create_processor(request, options = nil)
1443
1454
  # Pass arguments to `create_processor` via a request object, either of type
@@ -1458,9 +1469,11 @@ module Google
1458
1469
  # Required. The parent (project and location) under which to create the
1459
1470
  # processor. Format: `projects/{project}/locations/{location}`
1460
1471
  # @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.
1472
+ # Required. The processor to be created, requires
1473
+ # {::Google::Cloud::DocumentAI::V1beta3::Processor#type Processor.type} and
1474
+ # [Processor.display_name]][] to be set. Also, the
1475
+ # {::Google::Cloud::DocumentAI::V1beta3::Processor#kms_key_name Processor.kms_key_name}
1476
+ # field must be set if the processor is under CMEK.
1464
1477
  #
1465
1478
  # @yield [response, operation] Access the result along with the RPC operation
1466
1479
  # @yieldparam response [::Google::Cloud::DocumentAI::V1beta3::Processor]
@@ -1932,8 +1945,9 @@ module Google
1932
1945
  # @param inline_document [::Google::Cloud::DocumentAI::V1beta3::Document, ::Hash]
1933
1946
  # An inline document proto.
1934
1947
  # @param human_review_config [::String]
1935
- # Required. The resource name of the HumanReviewConfig that the document will
1936
- # be reviewed with.
1948
+ # Required. The resource name of the
1949
+ # [HumanReviewConfig][google.cloud.documentai.v1beta3.HumanReviewConfig] that
1950
+ # the document will be reviewed with.
1937
1951
  # @param document [::Google::Cloud::DocumentAI::V1beta3::Document, ::Hash]
1938
1952
  # The document that needs human review.
1939
1953
  # @param enable_schema_validation [::Boolean]
@@ -2227,8 +2241,8 @@ module Google
2227
2241
  # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
2228
2242
  # @param page_size [::Integer]
2229
2243
  # 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.
2244
+ # If unspecified, at most `5` evaluations are returned.
2245
+ # The maximum value is `100`. Values above `100` are coerced to `100`.
2232
2246
  # @param page_token [::String]
2233
2247
  # A page token, received from a previous `ListEvaluations` call.
2234
2248
  # Provide this to retrieve the subsequent page.
@@ -2321,7 +2335,8 @@ module Google
2321
2335
  # the default parameter values, pass an empty Hash as a request object (see above).
2322
2336
  #
2323
2337
  # @param processor_version_source [::String]
2324
- # The source processor version to import from.
2338
+ # The source processor version to import from. The source processor version
2339
+ # and destination processor need to be in the same environment and region.
2325
2340
  # @param parent [::String]
2326
2341
  # Required. The destination processor name to create the processor version
2327
2342
  # in. Format:
@@ -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
  }
@@ -215,14 +215,18 @@ module Google
215
215
  # or
216
216
  # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
217
217
  # @param document [::Google::Cloud::DocumentAI::V1beta3::Document, ::Hash]
218
- # The document payload, the [content] and [mime_type] fields must be set.
218
+ # The document payload, the
219
+ # {::Google::Cloud::DocumentAI::V1beta3::Document#content content} and
220
+ # {::Google::Cloud::DocumentAI::V1beta3::Document#mime_type mime_type} fields must
221
+ # be set.
219
222
  # @param skip_human_review [::Boolean]
220
- # Whether Human Review feature should be skipped for this request. Default to
221
- # false.
223
+ # Whether human review should be skipped for this request. Default to
224
+ # `false`.
222
225
  # @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}`.
226
+ # Specifies which fields to include in the
227
+ # {::Google::Cloud::DocumentAI::V1beta3::ProcessResponse#document ProcessResponse.document}
228
+ # output. Only supports top-level document and pages field, so it must be in
229
+ # the form of `{document_field_name}` or `pages.{page_field_name}`.
226
230
  # @param process_options [::Google::Cloud::DocumentAI::V1beta3::ProcessOptions, ::Hash]
227
231
  # Inference-time options for the process API
228
232
  # @yield [result, operation] Access the result along with the TransportOperation object
@@ -298,12 +302,16 @@ module Google
298
302
  # @param output_config [::Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest::BatchOutputConfig, ::Hash]
299
303
  # The overall output config for batch process.
300
304
  # @param input_documents [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig, ::Hash]
301
- # The input documents for batch process.
305
+ # The input documents for the
306
+ # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Rest::Client#batch_process_documents BatchProcessDocuments}
307
+ # method.
302
308
  # @param document_output_config [::Google::Cloud::DocumentAI::V1beta3::DocumentOutputConfig, ::Hash]
303
- # The overall output config for batch process.
309
+ # The output configuration for the
310
+ # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Rest::Client#batch_process_documents BatchProcessDocuments}
311
+ # method.
304
312
  # @param skip_human_review [::Boolean]
305
- # Whether Human Review feature should be skipped for this request. Default to
306
- # false.
313
+ # Whether human review should be skipped for this request. Default to
314
+ # `false`.
307
315
  # @param process_options [::Google::Cloud::DocumentAI::V1beta3::ProcessOptions, ::Hash]
308
316
  # Inference-time options for the process API
309
317
  # @yield [result, operation] Access the result along with the TransportOperation object
@@ -350,8 +358,9 @@ module Google
350
358
  end
351
359
 
352
360
  ##
353
- # Fetches processor types. Note that we do not use ListProcessorTypes here
354
- # because it is not paginated.
361
+ # Fetches processor types. Note that we don't use
362
+ # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Rest::Client#list_processor_types ListProcessorTypes}
363
+ # here, because it isn't paginated.
355
364
  #
356
365
  # @overload fetch_processor_types(request, options = nil)
357
366
  # Pass arguments to `fetch_processor_types` via a request object, either of type
@@ -369,9 +378,8 @@ module Google
369
378
  # the default parameter values, pass an empty Hash as a request object (see above).
370
379
  #
371
380
  # @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}`
381
+ # Required. The location of processor types to list.
382
+ # Format: `projects/{project}/locations/{location}`.
375
383
  # @yield [result, operation] Access the result along with the TransportOperation object
376
384
  # @yieldparam result [::Google::Cloud::DocumentAI::V1beta3::FetchProcessorTypesResponse]
377
385
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -433,13 +441,12 @@ module Google
433
441
  # the default parameter values, pass an empty Hash as a request object (see above).
434
442
  #
435
443
  # @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}`
444
+ # Required. The location of processor types to list.
445
+ # Format: `projects/{project}/locations/{location}`.
439
446
  # @param page_size [::Integer]
440
447
  # 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.
448
+ # If unspecified, at most `100` processor types will be returned.
449
+ # The maximum value is `500`. Values above `500` will be coerced to `500`.
443
450
  # @param page_token [::String]
444
451
  # Used to retrieve the next page of results, empty if at the end of the list.
445
452
  # @yield [result, operation] Access the result along with the TransportOperation object
@@ -570,8 +577,8 @@ module Google
570
577
  # Processors. Format: `projects/{project}/locations/{location}`
571
578
  # @param page_size [::Integer]
572
579
  # 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.
580
+ # If unspecified, at most `50` processors will be returned.
581
+ # The maximum value is `100`. Values above `100` will be coerced to `100`.
575
582
  # @param page_token [::String]
576
583
  # We will return the processors sorted by creation time. The page token
577
584
  # will point to the next processor.
@@ -683,7 +690,7 @@ module Google
683
690
  ##
684
691
  # Trains a new processor version.
685
692
  # Operation metadata is returned as
686
- # cloud_documentai_core.TrainProcessorVersionMetadata.
693
+ # {::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionMetadata TrainProcessorVersionMetadata}.
687
694
  #
688
695
  # @overload train_processor_version(request, options = nil)
689
696
  # Pass arguments to `train_processor_version` via a request object, either of type
@@ -695,11 +702,13 @@ module Google
695
702
  # @param options [::Gapic::CallOptions, ::Hash]
696
703
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
697
704
  #
698
- # @overload train_processor_version(parent: nil, processor_version: nil, document_schema: nil, input_data: nil, base_processor_version: nil)
705
+ # @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
706
  # Pass arguments to `train_processor_version` via keyword arguments. Note that at
700
707
  # least one keyword argument is required. To specify no parameters, or to keep all
701
708
  # the default parameter values, pass an empty Hash as a request object (see above).
702
709
  #
710
+ # @param custom_document_extraction_options [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::CustomDocumentExtractionOptions, ::Hash]
711
+ # Options to control Custom Document Extraction (CDE) Processor.
703
712
  # @param parent [::String]
704
713
  # Required. The parent (project, location and processor) to create the new
705
714
  # version for. Format:
@@ -709,7 +718,8 @@ module Google
709
718
  # @param document_schema [::Google::Cloud::DocumentAI::V1beta3::DocumentSchema, ::Hash]
710
719
  # Optional. The schema the processor version will be trained with.
711
720
  # @param input_data [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::InputData, ::Hash]
712
- # Optional. The input data used to train the `ProcessorVersion`.
721
+ # Optional. The input data used to train the
722
+ # {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion}.
713
723
  # @param base_processor_version [::String]
714
724
  # Optional. The processor version to use as a base for training. This
715
725
  # processor version must be a child of `parent`. Format:
@@ -843,8 +853,8 @@ module Google
843
853
  # `projects/{project}/locations/{location}/processors/{processor}`
844
854
  # @param page_size [::Integer]
845
855
  # 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.
856
+ # If unspecified, at most `10` processor versions will be returned.
857
+ # The maximum value is `20`. Values above `20` will be coerced to `20`.
848
858
  # @param page_token [::String]
849
859
  # We will return the processor versions sorted by creation time. The page
850
860
  # token will point to the next processor version.
@@ -1082,8 +1092,9 @@ module Google
1082
1092
  end
1083
1093
 
1084
1094
  ##
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.
1095
+ # Creates a processor from the
1096
+ # {::Google::Cloud::DocumentAI::V1beta3::ProcessorType ProcessorType} provided.
1097
+ # The processor will be at `ENABLED` state by default after its creation.
1087
1098
  #
1088
1099
  # @overload create_processor(request, options = nil)
1089
1100
  # Pass arguments to `create_processor` via a request object, either of type
@@ -1104,9 +1115,11 @@ module Google
1104
1115
  # Required. The parent (project and location) under which to create the
1105
1116
  # processor. Format: `projects/{project}/locations/{location}`
1106
1117
  # @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.
1118
+ # Required. The processor to be created, requires
1119
+ # {::Google::Cloud::DocumentAI::V1beta3::Processor#type Processor.type} and
1120
+ # [Processor.display_name]][] to be set. Also, the
1121
+ # {::Google::Cloud::DocumentAI::V1beta3::Processor#kms_key_name Processor.kms_key_name}
1122
+ # field must be set if the processor is under CMEK.
1110
1123
  # @yield [result, operation] Access the result along with the TransportOperation object
1111
1124
  # @yieldparam result [::Google::Cloud::DocumentAI::V1beta3::Processor]
1112
1125
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1435,8 +1448,9 @@ module Google
1435
1448
  # @param inline_document [::Google::Cloud::DocumentAI::V1beta3::Document, ::Hash]
1436
1449
  # An inline document proto.
1437
1450
  # @param human_review_config [::String]
1438
- # Required. The resource name of the HumanReviewConfig that the document will
1439
- # be reviewed with.
1451
+ # Required. The resource name of the
1452
+ # [HumanReviewConfig][google.cloud.documentai.v1beta3.HumanReviewConfig] that
1453
+ # the document will be reviewed with.
1440
1454
  # @param document [::Google::Cloud::DocumentAI::V1beta3::Document, ::Hash]
1441
1455
  # The document that needs human review.
1442
1456
  # @param enable_schema_validation [::Boolean]
@@ -1647,8 +1661,8 @@ module Google
1647
1661
  # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
1648
1662
  # @param page_size [::Integer]
1649
1663
  # 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.
1664
+ # If unspecified, at most `5` evaluations are returned.
1665
+ # The maximum value is `100`. Values above `100` are coerced to `100`.
1652
1666
  # @param page_token [::String]
1653
1667
  # A page token, received from a previous `ListEvaluations` call.
1654
1668
  # Provide this to retrieve the subsequent page.
@@ -1714,7 +1728,8 @@ module Google
1714
1728
  # the default parameter values, pass an empty Hash as a request object (see above).
1715
1729
  #
1716
1730
  # @param processor_version_source [::String]
1717
- # The source processor version to import from.
1731
+ # The source processor version to import from. The source processor version
1732
+ # and destination processor need to be in the same environment and region.
1718
1733
  # @param parent [::String]
1719
1734
  # Required. The destination processor name to create the processor version
1720
1735
  # in. Format:
@@ -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.
@@ -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.