google-cloud-document_ai-v1 0.20.0 → 0.21.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 (12) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/document_ai/v1/document_processor_service/client.rb +37 -60
  3. data/lib/google/cloud/document_ai/v1/document_processor_service/rest/client.rb +37 -60
  4. data/lib/google/cloud/document_ai/v1/version.rb +1 -1
  5. data/lib/google/cloud/documentai/v1/document_processor_service_pb.rb +2 -1
  6. data/lib/google/cloud/documentai/v1/document_processor_service_services_pb.rb +5 -9
  7. data/proto_docs/google/api/client.rb +4 -0
  8. data/proto_docs/google/cloud/documentai/v1/document.rb +72 -132
  9. data/proto_docs/google/cloud/documentai/v1/document_io.rb +1 -3
  10. data/proto_docs/google/cloud/documentai/v1/document_processor_service.rb +89 -122
  11. data/proto_docs/google/cloud/documentai/v1/processor.rb +1 -2
  12. metadata +2 -2
data/proto_docs/google/cloud/documentai/v1/document_processor_service.rb CHANGED
@@ -38,11 +38,9 @@ module Google
38
38
  # Returns error if set on other processor types.
39
39
  # @!attribute [rw] schema_override
40
40
  # @return [::Google::Cloud::DocumentAI::V1::DocumentSchema]
41
- # Optional. Override the schema of the
42
- # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}. Will
43
- # return an Invalid Argument error if this field is set when the underlying
44
- # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} doesn't
45
- # support schema override.
41
+ # Optional. Override the schema of the {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}. Will return an Invalid
42
+ # Argument error if this field is set when the underlying
43
+ # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} doesn't support schema override.
46
44
  class ProcessOptions
47
45
  include ::Google::Protobuf::MessageExts
48
46
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -58,8 +56,7 @@ module Google
58
56
  end
59
57
 
60
58
  # Request message for the
61
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#process_document ProcessDocument}
62
- # method.
59
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#process_document ProcessDocument} method.
63
60
  # @!attribute [rw] inline_document
64
61
  # @return [::Google::Cloud::DocumentAI::V1::Document]
65
62
  # An inline document proto.
@@ -71,15 +68,11 @@ module Google
71
68
  # A raw document on Google Cloud Storage.
72
69
  # @!attribute [rw] name
73
70
  # @return [::String]
74
- # Required. The resource name of the
75
- # {::Google::Cloud::DocumentAI::V1::Processor Processor} or
71
+ # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::Processor Processor} or
76
72
  # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}
77
- # to use for processing. If a
78
- # {::Google::Cloud::DocumentAI::V1::Processor Processor} is specified, the server
79
- # will use its [default
80
- # version][google.cloud.documentai.v1.Processor.default_processor_version].
81
- # Format: `projects/{project}/locations/{location}/processors/{processor}`,
82
- # or
73
+ # to use for processing. If a {::Google::Cloud::DocumentAI::V1::Processor Processor} is specified, the server will use
74
+ # its {::Google::Cloud::DocumentAI::V1::Processor#default_processor_version default version}. Format:
75
+ # `projects/{project}/locations/{location}/processors/{processor}`, or
83
76
  # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
84
77
  # @!attribute [rw] skip_human_review
85
78
  # @return [::Boolean]
@@ -87,8 +80,7 @@ module Google
87
80
  # `false`.
88
81
  # @!attribute [rw] field_mask
89
82
  # @return [::Google::Protobuf::FieldMask]
90
- # Specifies which fields to include in the
91
- # {::Google::Cloud::DocumentAI::V1::ProcessResponse#document ProcessResponse.document}
83
+ # Specifies which fields to include in the {::Google::Cloud::DocumentAI::V1::ProcessResponse#document ProcessResponse.document}
92
84
  # output. Only supports top-level document and pages field, so it must be in
93
85
  # the form of `{document_field_name}` or `pages.{page_field_name}`.
94
86
  # @!attribute [rw] process_options
@@ -126,11 +118,9 @@ module Google
126
118
  # @!attribute [rw] human_review_operation
127
119
  # @return [::String]
128
120
  # The name of the operation triggered by the processed document. This field
129
- # is populated only when the
130
- # {::Google::Cloud::DocumentAI::V1::HumanReviewStatus#state state} is
131
- # `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as
132
- # the long-running operation returned by
133
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#review_document ReviewDocument}.
121
+ # is populated only when the {::Google::Cloud::DocumentAI::V1::HumanReviewStatus#state state} is `HUMAN_REVIEW_IN_PROGRESS`. It has
122
+ # the same response type and metadata as the long-running operation returned
123
+ # by {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#review_document ReviewDocument}.
134
124
  class HumanReviewStatus
135
125
  include ::Google::Protobuf::MessageExts
136
126
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -152,15 +142,13 @@ module Google
152
142
  IN_PROGRESS = 3
153
143
 
154
144
  # Some error happened during triggering human review, see the
155
- # {::Google::Cloud::DocumentAI::V1::HumanReviewStatus#state_message state_message}
156
- # for details.
145
+ # {::Google::Cloud::DocumentAI::V1::HumanReviewStatus#state_message state_message} for details.
157
146
  ERROR = 4
158
147
  end
159
148
  end
160
149
 
161
150
  # Response message for the
162
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#process_document ProcessDocument}
163
- # method.
151
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#process_document ProcessDocument} method.
164
152
  # @!attribute [rw] document
165
153
  # @return [::Google::Cloud::DocumentAI::V1::Document]
166
154
  # The document payload, will populate fields based on the processor's
@@ -177,8 +165,7 @@ module Google
177
165
  # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#batch_process_documents BatchProcessDocuments}.
178
166
  # @!attribute [rw] name
179
167
  # @return [::String]
180
- # Required. The resource name of
181
- # {::Google::Cloud::DocumentAI::V1::Processor Processor} or
168
+ # Required. The resource name of {::Google::Cloud::DocumentAI::V1::Processor Processor} or
182
169
  # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}.
183
170
  # Format: `projects/{project}/locations/{location}/processors/{processor}`,
184
171
  # or
@@ -254,17 +241,16 @@ module Google
254
241
  # The status of a each individual document in the batch process.
255
242
  # @!attribute [rw] input_gcs_source
256
243
  # @return [::String]
257
- # The source of the document, same as the
258
- # {::Google::Cloud::DocumentAI::V1::BatchProcessMetadata::IndividualProcessStatus#input_gcs_source input_gcs_source}
259
- # field in the request when the batch process started.
244
+ # The source of the document, same as the {::Google::Cloud::DocumentAI::V1::BatchProcessMetadata::IndividualProcessStatus#input_gcs_source input_gcs_source} field in the
245
+ # request when the batch process started.
260
246
  # @!attribute [rw] status
261
247
  # @return [::Google::Rpc::Status]
262
248
  # The status processing the document.
263
249
  # @!attribute [rw] output_gcs_destination
264
250
  # @return [::String]
265
251
  # The Cloud Storage output destination (in the request as
266
- # {::Google::Cloud::DocumentAI::V1::DocumentOutputConfig::GcsOutputConfig#gcs_uri DocumentOutputConfig.GcsOutputConfig.gcs_uri})
267
- # of the processed document if it was successful, otherwise empty.
252
+ # {::Google::Cloud::DocumentAI::V1::DocumentOutputConfig::GcsOutputConfig#gcs_uri DocumentOutputConfig.GcsOutputConfig.gcs_uri}) of the processed
253
+ # document if it was successful, otherwise empty.
268
254
  # @!attribute [rw] human_review_status
269
255
  # @return [::Google::Cloud::DocumentAI::V1::HumanReviewStatus]
270
256
  # The status of human review on the processed document.
@@ -299,9 +285,8 @@ module Google
299
285
  end
300
286
 
301
287
  # Request message for the
302
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#fetch_processor_types FetchProcessorTypes}
303
- # method. Some processor types may require the project be added to an
304
- # allowlist.
288
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#fetch_processor_types FetchProcessorTypes} method.
289
+ # Some processor types may require the project be added to an allowlist.
305
290
  # @!attribute [rw] parent
306
291
  # @return [::String]
307
292
  # Required. The location of processor types to list.
@@ -312,8 +297,7 @@ module Google
312
297
  end
313
298
 
314
299
  # Response message for the
315
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#fetch_processor_types FetchProcessorTypes}
316
- # method.
300
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#fetch_processor_types FetchProcessorTypes} method.
317
301
  # @!attribute [rw] processor_types
318
302
  # @return [::Array<::Google::Cloud::DocumentAI::V1::ProcessorType>]
319
303
  # The list of processor types.
@@ -323,9 +307,8 @@ module Google
323
307
  end
324
308
 
325
309
  # Request message for the
326
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#list_processor_types ListProcessorTypes}
327
- # method. Some processor types may require the project be added to an
328
- # allowlist.
310
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#list_processor_types ListProcessorTypes} method.
311
+ # Some processor types may require the project be added to an allowlist.
329
312
  # @!attribute [rw] parent
330
313
  # @return [::String]
331
314
  # Required. The location of processor types to list.
@@ -344,8 +327,7 @@ module Google
344
327
  end
345
328
 
346
329
  # Response message for the
347
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#list_processor_types ListProcessorTypes}
348
- # method.
330
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#list_processor_types ListProcessorTypes} method.
349
331
  # @!attribute [rw] processor_types
350
332
  # @return [::Array<::Google::Cloud::DocumentAI::V1::ProcessorType>]
351
333
  # The processor types.
@@ -360,8 +342,8 @@ module Google
360
342
  # Request message for list all processors belongs to a project.
361
343
  # @!attribute [rw] parent
362
344
  # @return [::String]
363
- # Required. The parent (project and location) which owns this collection of
364
- # Processors. Format: `projects/{project}/locations/{location}`
345
+ # Required. The parent (project and location) which owns this collection of Processors.
346
+ # Format: `projects/{project}/locations/{location}`
365
347
  # @!attribute [rw] page_size
366
348
  # @return [::Integer]
367
349
  # The maximum number of processors to return.
@@ -377,8 +359,7 @@ module Google
377
359
  end
378
360
 
379
361
  # Response message for the
380
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#list_processors ListProcessors}
381
- # method.
362
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#list_processors ListProcessors} method.
382
363
  # @!attribute [rw] processors
383
364
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Processor>]
384
365
  # The list of processors.
@@ -391,8 +372,7 @@ module Google
391
372
  end
392
373
 
393
374
  # Request message for the
394
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#get_processor_type GetProcessorType}
395
- # method.
375
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#get_processor_type GetProcessorType} method.
396
376
  # @!attribute [rw] name
397
377
  # @return [::String]
398
378
  # Required. The processor type resource name.
@@ -401,8 +381,7 @@ module Google
401
381
  extend ::Google::Protobuf::MessageExts::ClassMethods
402
382
  end
403
383
 
404
- # Request message for the
405
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#get_processor GetProcessor}
384
+ # Request message for the {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#get_processor GetProcessor}
406
385
  # method.
407
386
  # @!attribute [rw] name
408
387
  # @return [::String]
@@ -413,8 +392,7 @@ module Google
413
392
  end
414
393
 
415
394
  # Request message for the
416
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#get_processor_version GetProcessorVersion}
417
- # method.
395
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#get_processor_version GetProcessorVersion} method.
418
396
  # @!attribute [rw] name
419
397
  # @return [::String]
420
398
  # Required. The processor resource name.
@@ -426,9 +404,8 @@ module Google
426
404
  # Request message for list all processor versions belongs to a processor.
427
405
  # @!attribute [rw] parent
428
406
  # @return [::String]
429
- # Required. The parent (project, location and processor) to list all
430
- # versions. Format:
431
- # `projects/{project}/locations/{location}/processors/{processor}`
407
+ # Required. The parent (project, location and processor) to list all versions.
408
+ # Format: `projects/{project}/locations/{location}/processors/{processor}`
432
409
  # @!attribute [rw] page_size
433
410
  # @return [::Integer]
434
411
  # The maximum number of processor versions to return.
@@ -540,21 +517,17 @@ module Google
540
517
  end
541
518
 
542
519
  # Request message for the
543
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#create_processor CreateProcessor}
544
- # method. Notice this request is sent to a regionalized backend service. If the
545
- # {::Google::Cloud::DocumentAI::V1::ProcessorType ProcessorType} isn't available in
546
- # that region, the creation fails.
520
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#create_processor CreateProcessor} method. Notice
521
+ # this request is sent to a regionalized backend service. If the
522
+ # {::Google::Cloud::DocumentAI::V1::ProcessorType ProcessorType} isn't available in that region, the creation fails.
547
523
  # @!attribute [rw] parent
548
524
  # @return [::String]
549
- # Required. The parent (project and location) under which to create the
550
- # processor. Format: `projects/{project}/locations/{location}`
525
+ # Required. The parent (project and location) under which to create the processor.
526
+ # Format: `projects/{project}/locations/{location}`
551
527
  # @!attribute [rw] processor
552
528
  # @return [::Google::Cloud::DocumentAI::V1::Processor]
553
- # Required. The processor to be created, requires
554
- # {::Google::Cloud::DocumentAI::V1::Processor#type Processor.type} and
555
- # {::Google::Cloud::DocumentAI::V1::Processor#display_name Processor.display_name}
556
- # to be set. Also, the
557
- # {::Google::Cloud::DocumentAI::V1::Processor#kms_key_name Processor.kms_key_name}
529
+ # Required. The processor to be created, requires {::Google::Cloud::DocumentAI::V1::Processor#type Processor.type} and
530
+ # {::Google::Cloud::DocumentAI::V1::Processor#display_name Processor.display_name} to be set. Also, the {::Google::Cloud::DocumentAI::V1::Processor#kms_key_name Processor.kms_key_name}
558
531
  # field must be set if the processor is under CMEK.
559
532
  class CreateProcessorRequest
560
533
  include ::Google::Protobuf::MessageExts
@@ -562,8 +535,7 @@ module Google
562
535
  end
563
536
 
564
537
  # Request message for the
565
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#delete_processor DeleteProcessor}
566
- # method.
538
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#delete_processor DeleteProcessor} method.
567
539
  # @!attribute [rw] name
568
540
  # @return [::String]
569
541
  # Required. The processor resource name to be deleted.
@@ -573,8 +545,7 @@ module Google
573
545
  end
574
546
 
575
547
  # The long-running operation metadata for the
576
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#delete_processor DeleteProcessor}
577
- # method.
548
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#delete_processor DeleteProcessor} method.
578
549
  # @!attribute [rw] common_metadata
579
550
  # @return [::Google::Cloud::DocumentAI::V1::CommonOperationMetadata]
580
551
  # The basic metadata of the long-running operation.
@@ -584,8 +555,7 @@ module Google
584
555
  end
585
556
 
586
557
  # Request message for the
587
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#enable_processor EnableProcessor}
588
- # method.
558
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#enable_processor EnableProcessor} method.
589
559
  # @!attribute [rw] name
590
560
  # @return [::String]
591
561
  # Required. The processor resource name to be enabled.
@@ -595,16 +565,15 @@ module Google
595
565
  end
596
566
 
597
567
  # Response message for the
598
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#enable_processor EnableProcessor}
599
- # method. Intentionally empty proto for adding fields in future.
568
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#enable_processor EnableProcessor} method.
569
+ # Intentionally empty proto for adding fields in future.
600
570
  class EnableProcessorResponse
601
571
  include ::Google::Protobuf::MessageExts
602
572
  extend ::Google::Protobuf::MessageExts::ClassMethods
603
573
  end
604
574
 
605
575
  # The long-running operation metadata for the
606
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#enable_processor EnableProcessor}
607
- # method.
576
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#enable_processor EnableProcessor} method.
608
577
  # @!attribute [rw] common_metadata
609
578
  # @return [::Google::Cloud::DocumentAI::V1::CommonOperationMetadata]
610
579
  # The basic metadata of the long-running operation.
@@ -614,8 +583,7 @@ module Google
614
583
  end
615
584
 
616
585
  # Request message for the
617
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#disable_processor DisableProcessor}
618
- # method.
586
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#disable_processor DisableProcessor} method.
619
587
  # @!attribute [rw] name
620
588
  # @return [::String]
621
589
  # Required. The processor resource name to be disabled.
@@ -625,16 +593,15 @@ module Google
625
593
  end
626
594
 
627
595
  # Response message for the
628
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#disable_processor DisableProcessor}
629
- # method. Intentionally empty proto for adding fields in future.
596
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#disable_processor DisableProcessor} method.
597
+ # Intentionally empty proto for adding fields in future.
630
598
  class DisableProcessorResponse
631
599
  include ::Google::Protobuf::MessageExts
632
600
  extend ::Google::Protobuf::MessageExts::ClassMethods
633
601
  end
634
602
 
635
603
  # The long-running operation metadata for the
636
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#disable_processor DisableProcessor}
637
- # method.
604
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#disable_processor DisableProcessor} method.
638
605
  # @!attribute [rw] common_metadata
639
606
  # @return [::Google::Cloud::DocumentAI::V1::CommonOperationMetadata]
640
607
  # The basic metadata of the long-running operation.
@@ -648,14 +615,11 @@ module Google
648
615
  # method.
649
616
  # @!attribute [rw] processor
650
617
  # @return [::String]
651
- # Required. The resource name of the
652
- # {::Google::Cloud::DocumentAI::V1::Processor Processor} to change default
653
- # version.
618
+ # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::Processor Processor} to change default version.
654
619
  # @!attribute [rw] default_processor_version
655
620
  # @return [::String]
656
- # Required. The resource name of child
657
- # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to use as
658
- # default. Format:
621
+ # Required. The resource name of child {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to use as default.
622
+ # Format:
659
623
  # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}`
660
624
  class SetDefaultProcessorVersionRequest
661
625
  include ::Google::Protobuf::MessageExts
@@ -687,11 +651,13 @@ module Google
687
651
  # @!attribute [rw] custom_document_extraction_options
688
652
  # @return [::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest::CustomDocumentExtractionOptions]
689
653
  # Options to control Custom Document Extraction (CDE) Processor.
654
+ # @!attribute [rw] foundation_model_tuning_options
655
+ # @return [::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest::FoundationModelTuningOptions]
656
+ # Options to control foundation model tuning of a processor.
690
657
  # @!attribute [rw] parent
691
658
  # @return [::String]
692
- # Required. The parent (project, location and processor) to create the new
693
- # version for. Format:
694
- # `projects/{project}/locations/{location}/processors/{processor}`.
659
+ # Required. The parent (project, location and processor) to create the new version for.
660
+ # Format: `projects/{project}/locations/{location}/processors/{processor}`.
695
661
  # @!attribute [rw] processor_version
696
662
  # @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion]
697
663
  # Required. The processor version to be created.
@@ -700,19 +666,17 @@ module Google
700
666
  # Optional. The schema the processor version will be trained with.
701
667
  # @!attribute [rw] input_data
702
668
  # @return [::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest::InputData]
703
- # Optional. The input data used to train the
704
- # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}.
669
+ # Optional. The input data used to train the {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}.
705
670
  # @!attribute [rw] base_processor_version
706
671
  # @return [::String]
707
- # Optional. The processor version to use as a base for training. This
708
- # processor version must be a child of `parent`. Format:
672
+ # Optional. The processor version to use as a base for training. This processor version
673
+ # must be a child of `parent`. Format:
709
674
  # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.
710
675
  class TrainProcessorVersionRequest
711
676
  include ::Google::Protobuf::MessageExts
712
677
  extend ::Google::Protobuf::MessageExts::ClassMethods
713
678
 
714
- # The input data used to train a new
715
- # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}.
679
+ # The input data used to train a new {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}.
716
680
  # @!attribute [rw] training_documents
717
681
  # @return [::Google::Cloud::DocumentAI::V1::BatchDocumentsInputConfig]
718
682
  # The documents used for training the new version.
@@ -743,6 +707,21 @@ module Google
743
707
  TEMPLATE_BASED = 2
744
708
  end
745
709
  end
710
+
711
+ # Options to control foundation model tuning of the processor.
712
+ # @!attribute [rw] train_steps
713
+ # @return [::Integer]
714
+ # Optional. The number of steps to run for model tuning. Valid values are between
715
+ # 1 and 400. If not provided, recommended steps will be used.
716
+ # @!attribute [rw] learning_rate_multiplier
717
+ # @return [::Float]
718
+ # Optional. The multiplier to apply to the recommended learning rate. Valid values
719
+ # are between 0.1 and 10. If not provided, recommended learning rate will
720
+ # be used.
721
+ class FoundationModelTuningOptions
722
+ include ::Google::Protobuf::MessageExts
723
+ extend ::Google::Protobuf::MessageExts::ClassMethods
724
+ end
746
725
  end
747
726
 
748
727
  # The response for
@@ -794,16 +773,14 @@ module Google
794
773
  end
795
774
 
796
775
  # Request message for the
797
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#review_document ReviewDocument}
798
- # method.
776
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#review_document ReviewDocument} method.
799
777
  # @!attribute [rw] inline_document
800
778
  # @return [::Google::Cloud::DocumentAI::V1::Document]
801
779
  # An inline document proto.
802
780
  # @!attribute [rw] human_review_config
803
781
  # @return [::String]
804
- # Required. The resource name of the
805
- # [HumanReviewConfig][google.cloud.documentai.v1.HumanReviewConfig] that the
806
- # document will be reviewed with.
782
+ # Required. The resource name of the [HumanReviewConfig][google.cloud.documentai.v1.HumanReviewConfig] that the document will be
783
+ # reviewed with.
807
784
  # @!attribute [rw] enable_schema_validation
808
785
  # @return [::Boolean]
809
786
  # Whether the validation should be performed on the ad-hoc review request.
@@ -829,8 +806,7 @@ module Google
829
806
  end
830
807
 
831
808
  # Response message for the
832
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#review_document ReviewDocument}
833
- # method.
809
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#review_document ReviewDocument} method.
834
810
  # @!attribute [rw] gcs_destination
835
811
  # @return [::String]
836
812
  # The Cloud Storage uri for the human reviewed document if the review is
@@ -859,8 +835,7 @@ module Google
859
835
  end
860
836
 
861
837
  # The long-running operation metadata for the
862
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#review_document ReviewDocument}
863
- # method.
838
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#review_document ReviewDocument} method.
864
839
  # @!attribute [rw] common_metadata
865
840
  # @return [::Google::Cloud::DocumentAI::V1::CommonOperationMetadata]
866
841
  # The basic metadata of the long-running operation.
@@ -872,19 +847,15 @@ module Google
872
847
  extend ::Google::Protobuf::MessageExts::ClassMethods
873
848
  end
874
849
 
875
- # Evaluates the given
876
- # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} against the
877
- # supplied documents.
850
+ # Evaluates the given {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} against the supplied documents.
878
851
  # @!attribute [rw] processor_version
879
852
  # @return [::String]
880
- # Required. The resource name of the
881
- # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to
882
- # evaluate.
853
+ # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to evaluate.
883
854
  # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
884
855
  # @!attribute [rw] evaluation_documents
885
856
  # @return [::Google::Cloud::DocumentAI::V1::BatchDocumentsInputConfig]
886
- # Optional. The documents used in the evaluation. If unspecified, use the
887
- # processor's dataset as evaluation input.
857
+ # Optional. The documents used in the evaluation. If unspecified, use the processor's
858
+ # dataset as evaluation input.
888
859
  class EvaluateProcessorVersionRequest
889
860
  include ::Google::Protobuf::MessageExts
890
861
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -915,21 +886,17 @@ module Google
915
886
  # Retrieves a specific Evaluation.
916
887
  # @!attribute [rw] name
917
888
  # @return [::String]
918
- # Required. The resource name of the
919
- # {::Google::Cloud::DocumentAI::V1::Evaluation Evaluation} to get.
889
+ # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::Evaluation Evaluation} to get.
920
890
  # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}`
921
891
  class GetEvaluationRequest
922
892
  include ::Google::Protobuf::MessageExts
923
893
  extend ::Google::Protobuf::MessageExts::ClassMethods
924
894
  end
925
895
 
926
- # Retrieves a list of evaluations for a given
927
- # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}.
896
+ # Retrieves a list of evaluations for a given {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}.
928
897
  # @!attribute [rw] parent
929
898
  # @return [::String]
930
- # Required. The resource name of the
931
- # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to list
932
- # evaluations for.
899
+ # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to list evaluations for.
933
900
  # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
934
901
  # @!attribute [rw] page_size
935
902
  # @return [::Integer]
data/proto_docs/google/cloud/documentai/v1/processor.rb CHANGED
@@ -156,8 +156,7 @@ module Google
156
156
  # Output only. The processor version aliases.
157
157
  # @!attribute [r] process_endpoint
158
158
  # @return [::String]
159
- # Output only. Immutable. The http endpoint that can be called to invoke
160
- # processing.
159
+ # Output only. Immutable. The http endpoint that can be called to invoke processing.
161
160
  # @!attribute [rw] create_time
162
161
  # @return [::Google::Protobuf::Timestamp]
163
162
  # The time the processor was created.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-document_ai-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.20.0
4
+ version: 0.21.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-02-26 00:00:00.000000000 Z
11
+ date: 2024-04-19 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common