google-cloud-document_ai-v1beta3 0.12.0 → 0.14.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 (29) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +1 -1
  3. data/lib/google/cloud/document_ai/v1beta3/document_processor_service/client.rb +1407 -153
  4. data/lib/google/cloud/document_ai/v1beta3/document_processor_service/paths.rb +44 -0
  5. data/lib/google/cloud/document_ai/v1beta3/version.rb +1 -1
  6. data/lib/google/cloud/documentai/v1beta3/barcode_pb.rb +24 -0
  7. data/lib/google/cloud/documentai/v1beta3/document_io_pb.rb +2 -1
  8. data/lib/google/cloud/documentai/v1beta3/document_pb.rb +25 -1
  9. data/lib/google/cloud/documentai/v1beta3/document_processor_service_pb.rb +142 -0
  10. data/lib/google/cloud/documentai/v1beta3/document_processor_service_services_pb.rb +32 -1
  11. data/lib/google/cloud/documentai/v1beta3/document_schema_pb.rb +60 -0
  12. data/lib/google/cloud/documentai/v1beta3/evaluation_pb.rb +72 -0
  13. data/lib/google/cloud/documentai/v1beta3/geometry_pb.rb +0 -2
  14. data/lib/google/cloud/documentai/v1beta3/operation_metadata_pb.rb +1 -1
  15. data/lib/google/cloud/documentai/v1beta3/processor_pb.rb +29 -2
  16. data/lib/google/cloud/documentai/v1beta3/processor_type_pb.rb +2 -1
  17. data/proto_docs/google/api/client.rb +318 -0
  18. data/proto_docs/google/api/launch_stage.rb +71 -0
  19. data/proto_docs/google/cloud/documentai/v1beta3/barcode.rb +73 -0
  20. data/proto_docs/google/cloud/documentai/v1beta3/document.rb +162 -145
  21. data/proto_docs/google/cloud/documentai/v1beta3/document_io.rb +7 -2
  22. data/proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb +382 -10
  23. data/proto_docs/google/cloud/documentai/v1beta3/document_schema.rb +155 -0
  24. data/proto_docs/google/cloud/documentai/v1beta3/evaluation.rb +181 -0
  25. data/proto_docs/google/cloud/documentai/v1beta3/operation_metadata.rb +3 -0
  26. data/proto_docs/google/cloud/documentai/v1beta3/processor.rb +97 -9
  27. data/proto_docs/google/cloud/documentai/v1beta3/processor_type.rb +9 -6
  28. data/proto_docs/google/protobuf/empty.rb +0 -2
  29. metadata +32 -4
@@ -28,7 +28,7 @@ module Google
28
28
  # @!attribute [rw] mime_type
29
29
  # @return [::String]
30
30
  # An IANA MIME type (RFC6838) indicating the nature and format of the
31
- # [content].
31
+ # {::Google::Cloud::DocumentAI::V1beta3::RawDocument#content content}.
32
32
  class RawDocument
33
33
  include ::Google::Protobuf::MessageExts
34
34
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -67,7 +67,7 @@ module Google
67
67
  # The common config to specify a set of documents used as input.
68
68
  # @!attribute [rw] gcs_prefix
69
69
  # @return [::Google::Cloud::DocumentAI::V1beta3::GcsPrefix]
70
- # The set of documents that match the specified Cloud Storage [gcs_prefix].
70
+ # The set of documents that match the specified Cloud Storage `gcs_prefix`.
71
71
  # @!attribute [rw] gcs_documents
72
72
  # @return [::Google::Cloud::DocumentAI::V1beta3::GcsDocuments]
73
73
  # The set of documents individually specified on Cloud Storage.
@@ -89,6 +89,11 @@ module Google
89
89
  # @!attribute [rw] gcs_uri
90
90
  # @return [::String]
91
91
  # The Cloud Storage uri (a directory) of the output.
92
+ # @!attribute [rw] field_mask
93
+ # @return [::Google::Protobuf::FieldMask]
94
+ # Specifies which fields to include in the output documents.
95
+ # Only supports top level document and pages field so it must be in the
96
+ # form of `{document_field_name}` or `pages.{page_field_name}`.
92
97
  class GcsOutputConfig
93
98
  include ::Google::Protobuf::MessageExts
94
99
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -30,7 +30,12 @@ module Google
30
30
  # A raw document content (bytes).
31
31
  # @!attribute [rw] name
32
32
  # @return [::String]
33
- # Required. The processor resource name.
33
+ # Required. The resource name of the {::Google::Cloud::DocumentAI::V1beta3::Processor Processor} or
34
+ # {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion}
35
+ # to use for processing. If a {::Google::Cloud::DocumentAI::V1beta3::Processor Processor} is specified, the server will use
36
+ # its {::Google::Cloud::DocumentAI::V1beta3::Processor#default_processor_version default version}. Format:
37
+ # `projects/{project}/locations/{location}/processors/{processor}`, or
38
+ # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
34
39
  # @!attribute [rw] document
35
40
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document]
36
41
  # The document payload, the [content] and [mime_type] fields must be set.
@@ -38,6 +43,11 @@ module Google
38
43
  # @return [::Boolean]
39
44
  # Whether Human Review feature should be skipped for this request. Default to
40
45
  # false.
46
+ # @!attribute [rw] field_mask
47
+ # @return [::Google::Protobuf::FieldMask]
48
+ # Specifies which fields to include in ProcessResponse's document.
49
+ # Only supports top level document and pages field so it must be in the form
50
+ # of `{document_field_name}` or `pages.{page_field_name}`.
41
51
  class ProcessRequest
42
52
  include ::Google::Protobuf::MessageExts
43
53
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -104,7 +114,11 @@ module Google
104
114
  # Request message for batch process document method.
105
115
  # @!attribute [rw] name
106
116
  # @return [::String]
107
- # Required. The processor resource name.
117
+ # Required. The resource name of {::Google::Cloud::DocumentAI::V1beta3::Processor Processor} or
118
+ # {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion}.
119
+ # Format: `projects/{project}/locations/{location}/processors/{processor}`,
120
+ # or
121
+ # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
108
122
  # @!attribute [rw] input_configs
109
123
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest::BatchInputConfig>]
110
124
  # The input config for each single document in the batch process.
@@ -185,10 +199,10 @@ module Google
185
199
  # document during the process.
186
200
  # @!attribute [rw] status
187
201
  # @return [::Google::Rpc::Status]
188
- # The status of the processing of the document.
202
+ # The status processing the document.
189
203
  # @!attribute [rw] output_gcs_destination
190
204
  # @return [::String]
191
- # The output_gcs_destination (in the request as 'output_gcs_destination')
205
+ # The output_gcs_destination (in the request as `output_gcs_destination`)
192
206
  # of the processed document if it was successful, otherwise empty.
193
207
  # @!attribute [rw] human_review_operation
194
208
  # @return [::String]
@@ -233,7 +247,8 @@ module Google
233
247
  # @!attribute [rw] parent
234
248
  # @return [::String]
235
249
  # Required. The project of processor type to list.
236
- # Format: projects/\\{project}/locations/\\{location}
250
+ # The available processor types may depend on the allow-listing on projects.
251
+ # Format: `projects/{project}/locations/{location}`
237
252
  class FetchProcessorTypesRequest
238
253
  include ::Google::Protobuf::MessageExts
239
254
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -248,11 +263,42 @@ module Google
248
263
  extend ::Google::Protobuf::MessageExts::ClassMethods
249
264
  end
250
265
 
266
+ # Request message for list processor types.
267
+ # @!attribute [rw] parent
268
+ # @return [::String]
269
+ # Required. The location of processor type to list.
270
+ # The available processor types may depend on the allow-listing on projects.
271
+ # Format: `projects/{project}/locations/{location}`
272
+ # @!attribute [rw] page_size
273
+ # @return [::Integer]
274
+ # The maximum number of processor types to return.
275
+ # If unspecified, at most 100 processor types will be returned.
276
+ # The maximum value is 500; values above 500 will be coerced to 500.
277
+ # @!attribute [rw] page_token
278
+ # @return [::String]
279
+ # Used to retrieve the next page of results, empty if at the end of the list.
280
+ class ListProcessorTypesRequest
281
+ include ::Google::Protobuf::MessageExts
282
+ extend ::Google::Protobuf::MessageExts::ClassMethods
283
+ end
284
+
285
+ # Response message for list processor types.
286
+ # @!attribute [rw] processor_types
287
+ # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::ProcessorType>]
288
+ # The processor types.
289
+ # @!attribute [rw] next_page_token
290
+ # @return [::String]
291
+ # Points to the next page, otherwise empty.
292
+ class ListProcessorTypesResponse
293
+ include ::Google::Protobuf::MessageExts
294
+ extend ::Google::Protobuf::MessageExts::ClassMethods
295
+ end
296
+
251
297
  # Request message for list all processors belongs to a project.
252
298
  # @!attribute [rw] parent
253
299
  # @return [::String]
254
300
  # Required. The parent (project and location) which owns this collection of Processors.
255
- # Format: projects/\\{project}/locations/\\{location}
301
+ # Format: `projects/{project}/locations/{location}`
256
302
  # @!attribute [rw] page_size
257
303
  # @return [::Integer]
258
304
  # The maximum number of processors to return.
@@ -279,13 +325,129 @@ module Google
279
325
  extend ::Google::Protobuf::MessageExts::ClassMethods
280
326
  end
281
327
 
328
+ # Request message for get processor.
329
+ # @!attribute [rw] name
330
+ # @return [::String]
331
+ # Required. The processor resource name.
332
+ class GetProcessorRequest
333
+ include ::Google::Protobuf::MessageExts
334
+ extend ::Google::Protobuf::MessageExts::ClassMethods
335
+ end
336
+
337
+ # Request message for get processor version.
338
+ # @!attribute [rw] name
339
+ # @return [::String]
340
+ # Required. The processor resource name.
341
+ class GetProcessorVersionRequest
342
+ include ::Google::Protobuf::MessageExts
343
+ extend ::Google::Protobuf::MessageExts::ClassMethods
344
+ end
345
+
346
+ # Request message for list all processor versions belongs to a processor.
347
+ # @!attribute [rw] parent
348
+ # @return [::String]
349
+ # Required. The parent (project, location and processor) to list all versions.
350
+ # Format: `projects/{project}/locations/{location}/processors/{processor}`
351
+ # @!attribute [rw] page_size
352
+ # @return [::Integer]
353
+ # The maximum number of processor versions to return.
354
+ # If unspecified, at most 10 processor versions will be returned.
355
+ # The maximum value is 20; values above 20 will be coerced to 20.
356
+ # @!attribute [rw] page_token
357
+ # @return [::String]
358
+ # We will return the processor versions sorted by creation time. The page
359
+ # token will point to the next processor version.
360
+ class ListProcessorVersionsRequest
361
+ include ::Google::Protobuf::MessageExts
362
+ extend ::Google::Protobuf::MessageExts::ClassMethods
363
+ end
364
+
365
+ # Response message for list processors.
366
+ # @!attribute [rw] processor_versions
367
+ # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion>]
368
+ # The list of processors.
369
+ # @!attribute [rw] next_page_token
370
+ # @return [::String]
371
+ # Points to the next processor, otherwise empty.
372
+ class ListProcessorVersionsResponse
373
+ include ::Google::Protobuf::MessageExts
374
+ extend ::Google::Protobuf::MessageExts::ClassMethods
375
+ end
376
+
377
+ # Request message for the delete processor version method.
378
+ # @!attribute [rw] name
379
+ # @return [::String]
380
+ # Required. The processor version resource name to be deleted.
381
+ class DeleteProcessorVersionRequest
382
+ include ::Google::Protobuf::MessageExts
383
+ extend ::Google::Protobuf::MessageExts::ClassMethods
384
+ end
385
+
386
+ # The long running operation metadata for delete processor version method.
387
+ # @!attribute [rw] common_metadata
388
+ # @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
389
+ # The basic metadata of the long running operation.
390
+ class DeleteProcessorVersionMetadata
391
+ include ::Google::Protobuf::MessageExts
392
+ extend ::Google::Protobuf::MessageExts::ClassMethods
393
+ end
394
+
395
+ # Request message for the deploy processor version method.
396
+ # @!attribute [rw] name
397
+ # @return [::String]
398
+ # Required. The processor version resource name to be deployed.
399
+ class DeployProcessorVersionRequest
400
+ include ::Google::Protobuf::MessageExts
401
+ extend ::Google::Protobuf::MessageExts::ClassMethods
402
+ end
403
+
404
+ # Response message for the deploy processor version method.
405
+ class DeployProcessorVersionResponse
406
+ include ::Google::Protobuf::MessageExts
407
+ extend ::Google::Protobuf::MessageExts::ClassMethods
408
+ end
409
+
410
+ # The long running operation metadata for deploy processor version method.
411
+ # @!attribute [rw] common_metadata
412
+ # @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
413
+ # The basic metadata of the long running operation.
414
+ class DeployProcessorVersionMetadata
415
+ include ::Google::Protobuf::MessageExts
416
+ extend ::Google::Protobuf::MessageExts::ClassMethods
417
+ end
418
+
419
+ # Request message for the undeploy processor version method.
420
+ # @!attribute [rw] name
421
+ # @return [::String]
422
+ # Required. The processor version resource name to be undeployed.
423
+ class UndeployProcessorVersionRequest
424
+ include ::Google::Protobuf::MessageExts
425
+ extend ::Google::Protobuf::MessageExts::ClassMethods
426
+ end
427
+
428
+ # Response message for the undeploy processor version method.
429
+ class UndeployProcessorVersionResponse
430
+ include ::Google::Protobuf::MessageExts
431
+ extend ::Google::Protobuf::MessageExts::ClassMethods
432
+ end
433
+
434
+ # The long running operation metadata for the undeploy processor version
435
+ # method.
436
+ # @!attribute [rw] common_metadata
437
+ # @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
438
+ # The basic metadata of the long running operation.
439
+ class UndeployProcessorVersionMetadata
440
+ include ::Google::Protobuf::MessageExts
441
+ extend ::Google::Protobuf::MessageExts::ClassMethods
442
+ end
443
+
282
444
  # Request message for create a processor. Notice this request is sent to
283
445
  # a regionalized backend service, and if the processor type is not available
284
446
  # on that region, the creation will fail.
285
447
  # @!attribute [rw] parent
286
448
  # @return [::String]
287
449
  # Required. The parent (project and location) under which to create the processor.
288
- # Format: projects/\\{project}/locations/\\{location}
450
+ # Format: `projects/{project}/locations/{location}`
289
451
  # @!attribute [rw] processor
290
452
  # @return [::Google::Cloud::DocumentAI::V1beta3::Processor]
291
453
  # Required. The processor to be created, requires [processor_type] and [display_name]
@@ -323,6 +485,7 @@ module Google
323
485
  end
324
486
 
325
487
  # Response message for the enable processor method.
488
+ # Intentionally empty proto for adding fields in future.
326
489
  class EnableProcessorResponse
327
490
  include ::Google::Protobuf::MessageExts
328
491
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -347,6 +510,7 @@ module Google
347
510
  end
348
511
 
349
512
  # Response message for the disable processor method.
513
+ # Intentionally empty proto for adding fields in future.
350
514
  class DisableProcessorResponse
351
515
  include ::Google::Protobuf::MessageExts
352
516
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -361,8 +525,120 @@ module Google
361
525
  extend ::Google::Protobuf::MessageExts::ClassMethods
362
526
  end
363
527
 
528
+ # Request message for the set default processor version method.
529
+ # @!attribute [rw] processor
530
+ # @return [::String]
531
+ # Required. The resource name of the {::Google::Cloud::DocumentAI::V1beta3::Processor Processor} to change default version.
532
+ # @!attribute [rw] default_processor_version
533
+ # @return [::String]
534
+ # Required. The resource name of child {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion} to use as default.
535
+ # Format:
536
+ # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}`
537
+ class SetDefaultProcessorVersionRequest
538
+ include ::Google::Protobuf::MessageExts
539
+ extend ::Google::Protobuf::MessageExts::ClassMethods
540
+ end
541
+
542
+ # Response message for set default processor version method.
543
+ class SetDefaultProcessorVersionResponse
544
+ include ::Google::Protobuf::MessageExts
545
+ extend ::Google::Protobuf::MessageExts::ClassMethods
546
+ end
547
+
548
+ # The long running operation metadata for set default processor version
549
+ # method.
550
+ # @!attribute [rw] common_metadata
551
+ # @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
552
+ # The basic metadata of the long running operation.
553
+ class SetDefaultProcessorVersionMetadata
554
+ include ::Google::Protobuf::MessageExts
555
+ extend ::Google::Protobuf::MessageExts::ClassMethods
556
+ end
557
+
558
+ # Request message for the create processor version method.
559
+ # @!attribute [rw] parent
560
+ # @return [::String]
561
+ # Required. The parent (project, location and processor) to create the new version for.
562
+ # Format: `projects/{project}/locations/{location}/processors/{processor}`.
563
+ # @!attribute [rw] processor_version
564
+ # @return [::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion]
565
+ # Required. The processor version to be created.
566
+ # @!attribute [rw] document_schema
567
+ # @return [::Google::Cloud::DocumentAI::V1beta3::DocumentSchema]
568
+ # Optional. The schema the processor version will be trained with.
569
+ # @!attribute [rw] input_data
570
+ # @return [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::InputData]
571
+ # Optional. The input data used to train the `ProcessorVersion`.
572
+ # @!attribute [rw] base_processor_version
573
+ # @return [::String]
574
+ # Optional. The processor version to use as a base for training. This processor version
575
+ # must be a child of `parent`. Format:
576
+ # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.
577
+ class TrainProcessorVersionRequest
578
+ include ::Google::Protobuf::MessageExts
579
+ extend ::Google::Protobuf::MessageExts::ClassMethods
580
+
581
+ # The input data used to train a new `ProcessorVersion`.
582
+ # @!attribute [rw] training_documents
583
+ # @return [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig]
584
+ # The documents used for training the new version.
585
+ # @!attribute [rw] test_documents
586
+ # @return [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig]
587
+ # The documents used for testing the trained version.
588
+ class InputData
589
+ include ::Google::Protobuf::MessageExts
590
+ extend ::Google::Protobuf::MessageExts::ClassMethods
591
+ end
592
+ end
593
+
594
+ # The response for the TrainProcessorVersion method.
595
+ # @!attribute [rw] processor_version
596
+ # @return [::String]
597
+ # The resource name of the processor version produced by training.
598
+ class TrainProcessorVersionResponse
599
+ include ::Google::Protobuf::MessageExts
600
+ extend ::Google::Protobuf::MessageExts::ClassMethods
601
+ end
602
+
603
+ # The metadata that represents a processor version being created.
604
+ # @!attribute [rw] common_metadata
605
+ # @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
606
+ # The basic metadata of the long running operation.
607
+ # @!attribute [rw] training_dataset_validation
608
+ # @return [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionMetadata::DatasetValidation]
609
+ # The training dataset validation information.
610
+ # @!attribute [rw] test_dataset_validation
611
+ # @return [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionMetadata::DatasetValidation]
612
+ # The test dataset validation information.
613
+ class TrainProcessorVersionMetadata
614
+ include ::Google::Protobuf::MessageExts
615
+ extend ::Google::Protobuf::MessageExts::ClassMethods
616
+
617
+ # The dataset validation information.
618
+ # This includes any and all errors with documents and the dataset.
619
+ # @!attribute [rw] document_error_count
620
+ # @return [::Integer]
621
+ # The total number of document errors.
622
+ # @!attribute [rw] dataset_error_count
623
+ # @return [::Integer]
624
+ # The total number of dataset errors.
625
+ # @!attribute [rw] document_errors
626
+ # @return [::Array<::Google::Rpc::Status>]
627
+ # Error information pertaining to specific documents. A maximum of 10
628
+ # document errors will be returned.
629
+ # Any document with errors will not be used throughout training.
630
+ # @!attribute [rw] dataset_errors
631
+ # @return [::Array<::Google::Rpc::Status>]
632
+ # Error information for the dataset as a whole. A maximum of 10 dataset
633
+ # errors will be returned.
634
+ # A single dataset error is terminal for training.
635
+ class DatasetValidation
636
+ include ::Google::Protobuf::MessageExts
637
+ extend ::Google::Protobuf::MessageExts::ClassMethods
638
+ end
639
+ end
640
+
364
641
  # Request message for review document method.
365
- # Next Id: 6.
366
642
  # @!attribute [rw] inline_document
367
643
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document]
368
644
  # An inline document proto.
@@ -379,6 +655,9 @@ module Google
379
655
  # @!attribute [rw] priority
380
656
  # @return [::Google::Cloud::DocumentAI::V1beta3::ReviewDocumentRequest::Priority]
381
657
  # The priority of the human review task.
658
+ # @!attribute [rw] document_schema
659
+ # @return [::Google::Cloud::DocumentAI::V1beta3::DocumentSchema]
660
+ # The document schema of the human review task.
382
661
  class ReviewDocumentRequest
383
662
  include ::Google::Protobuf::MessageExts
384
663
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -397,10 +676,29 @@ module Google
397
676
  # Response message for review document method.
398
677
  # @!attribute [rw] gcs_destination
399
678
  # @return [::String]
400
- # The Cloud Storage uri for the human reviewed document.
679
+ # The Cloud Storage uri for the human reviewed document if the review is
680
+ # succeeded.
681
+ # @!attribute [rw] state
682
+ # @return [::Google::Cloud::DocumentAI::V1beta3::ReviewDocumentResponse::State]
683
+ # The state of the review operation.
684
+ # @!attribute [rw] rejection_reason
685
+ # @return [::String]
686
+ # The reason why the review is rejected by reviewer.
401
687
  class ReviewDocumentResponse
402
688
  include ::Google::Protobuf::MessageExts
403
689
  extend ::Google::Protobuf::MessageExts::ClassMethods
690
+
691
+ # Possible states of the review operation.
692
+ module State
693
+ # The default value. This value is used if the state is omitted.
694
+ STATE_UNSPECIFIED = 0
695
+
696
+ # The review operation is rejected by the reviewer.
697
+ REJECTED = 1
698
+
699
+ # The review operation is succeeded.
700
+ SUCCEEDED = 2
701
+ end
404
702
  end
405
703
 
406
704
  # The long running operation metadata for review document method.
@@ -422,7 +720,7 @@ module Google
422
720
  # The basic metadata of the long running operation.
423
721
  # @!attribute [rw] question_id
424
722
  # @return [::String]
425
- # The question ID.
723
+ # The Crowd Compute question ID.
426
724
  class ReviewDocumentOperationMetadata
427
725
  include ::Google::Protobuf::MessageExts
428
726
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -448,6 +746,80 @@ module Google
448
746
  CANCELLED = 5
449
747
  end
450
748
  end
749
+
750
+ # Evaluates the given ProcessorVersion against the supplied documents.
751
+ # @!attribute [rw] processor_version
752
+ # @return [::String]
753
+ # Required. The resource name of the {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion} to evaluate.
754
+ # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
755
+ # @!attribute [rw] evaluation_documents
756
+ # @return [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig]
757
+ # Optional. The documents used in the evaluation. If unspecified, use the processor's
758
+ # dataset as evaluation input.
759
+ class EvaluateProcessorVersionRequest
760
+ include ::Google::Protobuf::MessageExts
761
+ extend ::Google::Protobuf::MessageExts::ClassMethods
762
+ end
763
+
764
+ # Metadata of the EvaluateProcessorVersion method.
765
+ # @!attribute [rw] common_metadata
766
+ # @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
767
+ # The basic metadata of the long running operation.
768
+ class EvaluateProcessorVersionMetadata
769
+ include ::Google::Protobuf::MessageExts
770
+ extend ::Google::Protobuf::MessageExts::ClassMethods
771
+ end
772
+
773
+ # Metadata of the EvaluateProcessorVersion method.
774
+ # @!attribute [rw] evaluation
775
+ # @return [::String]
776
+ # The resource name of the created evaluation.
777
+ class EvaluateProcessorVersionResponse
778
+ include ::Google::Protobuf::MessageExts
779
+ extend ::Google::Protobuf::MessageExts::ClassMethods
780
+ end
781
+
782
+ # Retrieves a specific Evaluation.
783
+ # @!attribute [rw] name
784
+ # @return [::String]
785
+ # Required. The resource name of the {::Google::Cloud::DocumentAI::V1beta3::Evaluation Evaluation} to get.
786
+ # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}`
787
+ class GetEvaluationRequest
788
+ include ::Google::Protobuf::MessageExts
789
+ extend ::Google::Protobuf::MessageExts::ClassMethods
790
+ end
791
+
792
+ # Retrieves a list of evaluations for a given ProcessorVersion.
793
+ # @!attribute [rw] parent
794
+ # @return [::String]
795
+ # Required. The resource name of the {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion} to list evaluations for.
796
+ # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
797
+ # @!attribute [rw] page_size
798
+ # @return [::Integer]
799
+ # The standard list page size.
800
+ # If unspecified, at most 5 evaluations will be returned.
801
+ # The maximum value is 100; values above 100 will be coerced to 100.
802
+ # @!attribute [rw] page_token
803
+ # @return [::String]
804
+ # A page token, received from a previous `ListEvaluations` call.
805
+ # Provide this to retrieve the subsequent page.
806
+ class ListEvaluationsRequest
807
+ include ::Google::Protobuf::MessageExts
808
+ extend ::Google::Protobuf::MessageExts::ClassMethods
809
+ end
810
+
811
+ # The response from ListEvaluations.
812
+ # @!attribute [rw] evaluations
813
+ # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Evaluation>]
814
+ # The evaluations requested.
815
+ # @!attribute [rw] next_page_token
816
+ # @return [::String]
817
+ # A token, which can be sent as `page_token` to retrieve the next page.
818
+ # If this field is omitted, there are no subsequent pages.
819
+ class ListEvaluationsResponse
820
+ include ::Google::Protobuf::MessageExts
821
+ extend ::Google::Protobuf::MessageExts::ClassMethods
822
+ end
451
823
  end
452
824
  end
453
825
  end