google-cloud-document_ai-v1 0.21.0 → 0.21.1

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 (13) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/document_ai/v1/document_processor_service/client.rb +106 -56
  3. data/lib/google/cloud/document_ai/v1/document_processor_service/operations.rb +13 -5
  4. data/lib/google/cloud/document_ai/v1/document_processor_service/rest/client.rb +106 -56
  5. data/lib/google/cloud/document_ai/v1/document_processor_service/rest/operations.rb +11 -4
  6. data/lib/google/cloud/document_ai/v1/version.rb +1 -1
  7. data/lib/google/cloud/documentai/v1/document_processor_service_services_pb.rb +9 -5
  8. data/lib/google/cloud/documentai/v1/processor_pb.rb +1 -1
  9. data/proto_docs/google/cloud/documentai/v1/document.rb +136 -76
  10. data/proto_docs/google/cloud/documentai/v1/document_io.rb +3 -1
  11. data/proto_docs/google/cloud/documentai/v1/document_processor_service.rb +127 -76
  12. data/proto_docs/google/cloud/documentai/v1/processor.rb +5 -4
  13. metadata +2 -2
data/proto_docs/google/cloud/documentai/v1/document_processor_service.rb CHANGED
@@ -38,9 +38,11 @@ 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 {::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.
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.
44
46
  class ProcessOptions
45
47
  include ::Google::Protobuf::MessageExts
46
48
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -56,7 +58,8 @@ module Google
56
58
  end
57
59
 
58
60
  # Request message for the
59
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#process_document ProcessDocument} method.
61
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#process_document ProcessDocument}
62
+ # method.
60
63
  # @!attribute [rw] inline_document
61
64
  # @return [::Google::Cloud::DocumentAI::V1::Document]
62
65
  # An inline document proto.
@@ -68,11 +71,15 @@ module Google
68
71
  # A raw document on Google Cloud Storage.
69
72
  # @!attribute [rw] name
70
73
  # @return [::String]
71
- # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::Processor Processor} or
74
+ # Required. The resource name of the
75
+ # {::Google::Cloud::DocumentAI::V1::Processor Processor} or
72
76
  # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}
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
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
76
83
  # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
77
84
  # @!attribute [rw] skip_human_review
78
85
  # @return [::Boolean]
@@ -80,7 +87,8 @@ module Google
80
87
  # `false`.
81
88
  # @!attribute [rw] field_mask
82
89
  # @return [::Google::Protobuf::FieldMask]
83
- # Specifies which fields to include in the {::Google::Cloud::DocumentAI::V1::ProcessResponse#document ProcessResponse.document}
90
+ # Specifies which fields to include in the
91
+ # {::Google::Cloud::DocumentAI::V1::ProcessResponse#document ProcessResponse.document}
84
92
  # output. Only supports top-level document and pages field, so it must be in
85
93
  # the form of `{document_field_name}` or `pages.{page_field_name}`.
86
94
  # @!attribute [rw] process_options
@@ -118,9 +126,11 @@ module Google
118
126
  # @!attribute [rw] human_review_operation
119
127
  # @return [::String]
120
128
  # The name of the operation triggered by the processed document. This field
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}.
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}.
124
134
  class HumanReviewStatus
125
135
  include ::Google::Protobuf::MessageExts
126
136
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -142,13 +152,15 @@ module Google
142
152
  IN_PROGRESS = 3
143
153
 
144
154
  # Some error happened during triggering human review, see the
145
- # {::Google::Cloud::DocumentAI::V1::HumanReviewStatus#state_message state_message} for details.
155
+ # {::Google::Cloud::DocumentAI::V1::HumanReviewStatus#state_message state_message}
156
+ # for details.
146
157
  ERROR = 4
147
158
  end
148
159
  end
149
160
 
150
161
  # Response message for the
151
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#process_document ProcessDocument} method.
162
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#process_document ProcessDocument}
163
+ # method.
152
164
  # @!attribute [rw] document
153
165
  # @return [::Google::Cloud::DocumentAI::V1::Document]
154
166
  # The document payload, will populate fields based on the processor's
@@ -165,7 +177,8 @@ module Google
165
177
  # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#batch_process_documents BatchProcessDocuments}.
166
178
  # @!attribute [rw] name
167
179
  # @return [::String]
168
- # Required. The resource name of {::Google::Cloud::DocumentAI::V1::Processor Processor} or
180
+ # Required. The resource name of
181
+ # {::Google::Cloud::DocumentAI::V1::Processor Processor} or
169
182
  # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}.
170
183
  # Format: `projects/{project}/locations/{location}/processors/{processor}`,
171
184
  # or
@@ -241,16 +254,17 @@ module Google
241
254
  # The status of a each individual document in the batch process.
242
255
  # @!attribute [rw] input_gcs_source
243
256
  # @return [::String]
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.
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.
246
260
  # @!attribute [rw] status
247
261
  # @return [::Google::Rpc::Status]
248
262
  # The status processing the document.
249
263
  # @!attribute [rw] output_gcs_destination
250
264
  # @return [::String]
251
265
  # The Cloud Storage output destination (in the request as
252
- # {::Google::Cloud::DocumentAI::V1::DocumentOutputConfig::GcsOutputConfig#gcs_uri DocumentOutputConfig.GcsOutputConfig.gcs_uri}) of the processed
253
- # document if it was successful, otherwise empty.
266
+ # {::Google::Cloud::DocumentAI::V1::DocumentOutputConfig::GcsOutputConfig#gcs_uri DocumentOutputConfig.GcsOutputConfig.gcs_uri})
267
+ # of the processed document if it was successful, otherwise empty.
254
268
  # @!attribute [rw] human_review_status
255
269
  # @return [::Google::Cloud::DocumentAI::V1::HumanReviewStatus]
256
270
  # The status of human review on the processed document.
@@ -285,8 +299,9 @@ module Google
285
299
  end
286
300
 
287
301
  # Request message for the
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.
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.
290
305
  # @!attribute [rw] parent
291
306
  # @return [::String]
292
307
  # Required. The location of processor types to list.
@@ -297,7 +312,8 @@ module Google
297
312
  end
298
313
 
299
314
  # Response message for the
300
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#fetch_processor_types FetchProcessorTypes} method.
315
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#fetch_processor_types FetchProcessorTypes}
316
+ # method.
301
317
  # @!attribute [rw] processor_types
302
318
  # @return [::Array<::Google::Cloud::DocumentAI::V1::ProcessorType>]
303
319
  # The list of processor types.
@@ -307,8 +323,9 @@ module Google
307
323
  end
308
324
 
309
325
  # Request message for the
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.
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.
312
329
  # @!attribute [rw] parent
313
330
  # @return [::String]
314
331
  # Required. The location of processor types to list.
@@ -327,7 +344,8 @@ module Google
327
344
  end
328
345
 
329
346
  # Response message for the
330
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#list_processor_types ListProcessorTypes} method.
347
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#list_processor_types ListProcessorTypes}
348
+ # method.
331
349
  # @!attribute [rw] processor_types
332
350
  # @return [::Array<::Google::Cloud::DocumentAI::V1::ProcessorType>]
333
351
  # The processor types.
@@ -342,8 +360,8 @@ module Google
342
360
  # Request message for list all processors belongs to a project.
343
361
  # @!attribute [rw] parent
344
362
  # @return [::String]
345
- # Required. The parent (project and location) which owns this collection of Processors.
346
- # Format: `projects/{project}/locations/{location}`
363
+ # Required. The parent (project and location) which owns this collection of
364
+ # Processors. Format: `projects/{project}/locations/{location}`
347
365
  # @!attribute [rw] page_size
348
366
  # @return [::Integer]
349
367
  # The maximum number of processors to return.
@@ -359,7 +377,8 @@ module Google
359
377
  end
360
378
 
361
379
  # Response message for the
362
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#list_processors ListProcessors} method.
380
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#list_processors ListProcessors}
381
+ # method.
363
382
  # @!attribute [rw] processors
364
383
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Processor>]
365
384
  # The list of processors.
@@ -372,7 +391,8 @@ module Google
372
391
  end
373
392
 
374
393
  # Request message for the
375
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#get_processor_type GetProcessorType} method.
394
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#get_processor_type GetProcessorType}
395
+ # method.
376
396
  # @!attribute [rw] name
377
397
  # @return [::String]
378
398
  # Required. The processor type resource name.
@@ -381,7 +401,8 @@ module Google
381
401
  extend ::Google::Protobuf::MessageExts::ClassMethods
382
402
  end
383
403
 
384
- # Request message for the {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#get_processor GetProcessor}
404
+ # Request message for the
405
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#get_processor GetProcessor}
385
406
  # method.
386
407
  # @!attribute [rw] name
387
408
  # @return [::String]
@@ -392,7 +413,8 @@ module Google
392
413
  end
393
414
 
394
415
  # Request message for the
395
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#get_processor_version GetProcessorVersion} method.
416
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#get_processor_version GetProcessorVersion}
417
+ # method.
396
418
  # @!attribute [rw] name
397
419
  # @return [::String]
398
420
  # Required. The processor resource name.
@@ -404,8 +426,9 @@ module Google
404
426
  # Request message for list all processor versions belongs to a processor.
405
427
  # @!attribute [rw] parent
406
428
  # @return [::String]
407
- # Required. The parent (project, location and processor) to list all versions.
408
- # Format: `projects/{project}/locations/{location}/processors/{processor}`
429
+ # Required. The parent (project, location and processor) to list all
430
+ # versions. Format:
431
+ # `projects/{project}/locations/{location}/processors/{processor}`
409
432
  # @!attribute [rw] page_size
410
433
  # @return [::Integer]
411
434
  # The maximum number of processor versions to return.
@@ -517,17 +540,21 @@ module Google
517
540
  end
518
541
 
519
542
  # Request message for the
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.
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.
523
547
  # @!attribute [rw] parent
524
548
  # @return [::String]
525
- # Required. The parent (project and location) under which to create the processor.
526
- # Format: `projects/{project}/locations/{location}`
549
+ # Required. The parent (project and location) under which to create the
550
+ # processor. Format: `projects/{project}/locations/{location}`
527
551
  # @!attribute [rw] processor
528
552
  # @return [::Google::Cloud::DocumentAI::V1::Processor]
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}
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}
531
558
  # field must be set if the processor is under CMEK.
532
559
  class CreateProcessorRequest
533
560
  include ::Google::Protobuf::MessageExts
@@ -535,7 +562,8 @@ module Google
535
562
  end
536
563
 
537
564
  # Request message for the
538
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#delete_processor DeleteProcessor} method.
565
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#delete_processor DeleteProcessor}
566
+ # method.
539
567
  # @!attribute [rw] name
540
568
  # @return [::String]
541
569
  # Required. The processor resource name to be deleted.
@@ -545,7 +573,8 @@ module Google
545
573
  end
546
574
 
547
575
  # The long-running operation metadata for the
548
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#delete_processor DeleteProcessor} method.
576
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#delete_processor DeleteProcessor}
577
+ # method.
549
578
  # @!attribute [rw] common_metadata
550
579
  # @return [::Google::Cloud::DocumentAI::V1::CommonOperationMetadata]
551
580
  # The basic metadata of the long-running operation.
@@ -555,7 +584,8 @@ module Google
555
584
  end
556
585
 
557
586
  # Request message for the
558
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#enable_processor EnableProcessor} method.
587
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#enable_processor EnableProcessor}
588
+ # method.
559
589
  # @!attribute [rw] name
560
590
  # @return [::String]
561
591
  # Required. The processor resource name to be enabled.
@@ -565,15 +595,16 @@ module Google
565
595
  end
566
596
 
567
597
  # Response message for the
568
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#enable_processor EnableProcessor} method.
569
- # Intentionally empty proto for adding fields in future.
598
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#enable_processor EnableProcessor}
599
+ # method. Intentionally empty proto for adding fields in future.
570
600
  class EnableProcessorResponse
571
601
  include ::Google::Protobuf::MessageExts
572
602
  extend ::Google::Protobuf::MessageExts::ClassMethods
573
603
  end
574
604
 
575
605
  # The long-running operation metadata for the
576
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#enable_processor EnableProcessor} method.
606
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#enable_processor EnableProcessor}
607
+ # method.
577
608
  # @!attribute [rw] common_metadata
578
609
  # @return [::Google::Cloud::DocumentAI::V1::CommonOperationMetadata]
579
610
  # The basic metadata of the long-running operation.
@@ -583,7 +614,8 @@ module Google
583
614
  end
584
615
 
585
616
  # Request message for the
586
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#disable_processor DisableProcessor} method.
617
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#disable_processor DisableProcessor}
618
+ # method.
587
619
  # @!attribute [rw] name
588
620
  # @return [::String]
589
621
  # Required. The processor resource name to be disabled.
@@ -593,15 +625,16 @@ module Google
593
625
  end
594
626
 
595
627
  # Response message for the
596
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#disable_processor DisableProcessor} method.
597
- # Intentionally empty proto for adding fields in future.
628
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#disable_processor DisableProcessor}
629
+ # method. Intentionally empty proto for adding fields in future.
598
630
  class DisableProcessorResponse
599
631
  include ::Google::Protobuf::MessageExts
600
632
  extend ::Google::Protobuf::MessageExts::ClassMethods
601
633
  end
602
634
 
603
635
  # The long-running operation metadata for the
604
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#disable_processor DisableProcessor} method.
636
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#disable_processor DisableProcessor}
637
+ # method.
605
638
  # @!attribute [rw] common_metadata
606
639
  # @return [::Google::Cloud::DocumentAI::V1::CommonOperationMetadata]
607
640
  # The basic metadata of the long-running operation.
@@ -615,11 +648,14 @@ module Google
615
648
  # method.
616
649
  # @!attribute [rw] processor
617
650
  # @return [::String]
618
- # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::Processor Processor} to change default version.
651
+ # Required. The resource name of the
652
+ # {::Google::Cloud::DocumentAI::V1::Processor Processor} to change default
653
+ # version.
619
654
  # @!attribute [rw] default_processor_version
620
655
  # @return [::String]
621
- # Required. The resource name of child {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to use as default.
622
- # Format:
656
+ # Required. The resource name of child
657
+ # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to use as
658
+ # default. Format:
623
659
  # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}`
624
660
  class SetDefaultProcessorVersionRequest
625
661
  include ::Google::Protobuf::MessageExts
@@ -656,8 +692,9 @@ module Google
656
692
  # Options to control foundation model tuning of a processor.
657
693
  # @!attribute [rw] parent
658
694
  # @return [::String]
659
- # Required. The parent (project, location and processor) to create the new version for.
660
- # Format: `projects/{project}/locations/{location}/processors/{processor}`.
695
+ # Required. The parent (project, location and processor) to create the new
696
+ # version for. Format:
697
+ # `projects/{project}/locations/{location}/processors/{processor}`.
661
698
  # @!attribute [rw] processor_version
662
699
  # @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion]
663
700
  # Required. The processor version to be created.
@@ -666,17 +703,19 @@ module Google
666
703
  # Optional. The schema the processor version will be trained with.
667
704
  # @!attribute [rw] input_data
668
705
  # @return [::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest::InputData]
669
- # Optional. The input data used to train the {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}.
706
+ # Optional. The input data used to train the
707
+ # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}.
670
708
  # @!attribute [rw] base_processor_version
671
709
  # @return [::String]
672
- # Optional. The processor version to use as a base for training. This processor version
673
- # must be a child of `parent`. Format:
710
+ # Optional. The processor version to use as a base for training. This
711
+ # processor version must be a child of `parent`. Format:
674
712
  # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.
675
713
  class TrainProcessorVersionRequest
676
714
  include ::Google::Protobuf::MessageExts
677
715
  extend ::Google::Protobuf::MessageExts::ClassMethods
678
716
 
679
- # The input data used to train a new {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}.
717
+ # The input data used to train a new
718
+ # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}.
680
719
  # @!attribute [rw] training_documents
681
720
  # @return [::Google::Cloud::DocumentAI::V1::BatchDocumentsInputConfig]
682
721
  # The documents used for training the new version.
@@ -711,13 +750,13 @@ module Google
711
750
  # Options to control foundation model tuning of the processor.
712
751
  # @!attribute [rw] train_steps
713
752
  # @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.
753
+ # Optional. The number of steps to run for model tuning. Valid values are
754
+ # between 1 and 400. If not provided, recommended steps will be used.
716
755
  # @!attribute [rw] learning_rate_multiplier
717
756
  # @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.
757
+ # Optional. The multiplier to apply to the recommended learning rate. Valid
758
+ # values are between 0.1 and 10. If not provided, recommended learning rate
759
+ # will be used.
721
760
  class FoundationModelTuningOptions
722
761
  include ::Google::Protobuf::MessageExts
723
762
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -773,14 +812,16 @@ module Google
773
812
  end
774
813
 
775
814
  # Request message for the
776
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#review_document ReviewDocument} method.
815
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#review_document ReviewDocument}
816
+ # method.
777
817
  # @!attribute [rw] inline_document
778
818
  # @return [::Google::Cloud::DocumentAI::V1::Document]
779
819
  # An inline document proto.
780
820
  # @!attribute [rw] human_review_config
781
821
  # @return [::String]
782
- # Required. The resource name of the [HumanReviewConfig][google.cloud.documentai.v1.HumanReviewConfig] that the document will be
783
- # reviewed with.
822
+ # Required. The resource name of the
823
+ # [HumanReviewConfig][google.cloud.documentai.v1.HumanReviewConfig] that the
824
+ # document will be reviewed with.
784
825
  # @!attribute [rw] enable_schema_validation
785
826
  # @return [::Boolean]
786
827
  # Whether the validation should be performed on the ad-hoc review request.
@@ -806,7 +847,8 @@ module Google
806
847
  end
807
848
 
808
849
  # Response message for the
809
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#review_document ReviewDocument} method.
850
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#review_document ReviewDocument}
851
+ # method.
810
852
  # @!attribute [rw] gcs_destination
811
853
  # @return [::String]
812
854
  # The Cloud Storage uri for the human reviewed document if the review is
@@ -835,7 +877,8 @@ module Google
835
877
  end
836
878
 
837
879
  # The long-running operation metadata for the
838
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#review_document ReviewDocument} method.
880
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#review_document ReviewDocument}
881
+ # method.
839
882
  # @!attribute [rw] common_metadata
840
883
  # @return [::Google::Cloud::DocumentAI::V1::CommonOperationMetadata]
841
884
  # The basic metadata of the long-running operation.
@@ -847,15 +890,19 @@ module Google
847
890
  extend ::Google::Protobuf::MessageExts::ClassMethods
848
891
  end
849
892
 
850
- # Evaluates the given {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} against the supplied documents.
893
+ # Evaluates the given
894
+ # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} against the
895
+ # supplied documents.
851
896
  # @!attribute [rw] processor_version
852
897
  # @return [::String]
853
- # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to evaluate.
898
+ # Required. The resource name of the
899
+ # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to
900
+ # evaluate.
854
901
  # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
855
902
  # @!attribute [rw] evaluation_documents
856
903
  # @return [::Google::Cloud::DocumentAI::V1::BatchDocumentsInputConfig]
857
- # Optional. The documents used in the evaluation. If unspecified, use the processor's
858
- # dataset as evaluation input.
904
+ # Optional. The documents used in the evaluation. If unspecified, use the
905
+ # processor's dataset as evaluation input.
859
906
  class EvaluateProcessorVersionRequest
860
907
  include ::Google::Protobuf::MessageExts
861
908
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -886,17 +933,21 @@ module Google
886
933
  # Retrieves a specific Evaluation.
887
934
  # @!attribute [rw] name
888
935
  # @return [::String]
889
- # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::Evaluation Evaluation} to get.
936
+ # Required. The resource name of the
937
+ # {::Google::Cloud::DocumentAI::V1::Evaluation Evaluation} to get.
890
938
  # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}`
891
939
  class GetEvaluationRequest
892
940
  include ::Google::Protobuf::MessageExts
893
941
  extend ::Google::Protobuf::MessageExts::ClassMethods
894
942
  end
895
943
 
896
- # Retrieves a list of evaluations for a given {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}.
944
+ # Retrieves a list of evaluations for a given
945
+ # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}.
897
946
  # @!attribute [rw] parent
898
947
  # @return [::String]
899
- # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to list evaluations for.
948
+ # Required. The resource name of the
949
+ # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to list
950
+ # evaluations for.
900
951
  # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
901
952
  # @!attribute [rw] page_size
902
953
  # @return [::Integer]
data/proto_docs/google/cloud/documentai/v1/processor.rb CHANGED
@@ -27,7 +27,7 @@ module Google
27
27
  # Its document-processing behavior is defined by that version.
28
28
  # @!attribute [rw] name
29
29
  # @return [::String]
30
- # The resource name of the processor version.
30
+ # Identifier. The resource name of the processor version.
31
31
  # Format:
32
32
  # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
33
33
  # @!attribute [rw] display_name
@@ -36,9 +36,9 @@ module Google
36
36
  # @!attribute [rw] document_schema
37
37
  # @return [::Google::Cloud::DocumentAI::V1::DocumentSchema]
38
38
  # The schema of the processor version. Describes the output.
39
- # @!attribute [rw] state
39
+ # @!attribute [r] state
40
40
  # @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::State]
41
- # The state of the processor version.
41
+ # Output only. The state of the processor version.
42
42
  # @!attribute [rw] create_time
43
43
  # @return [::Google::Protobuf::Timestamp]
44
44
  # The time the processor version was created.
@@ -156,7 +156,8 @@ 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 processing.
159
+ # Output only. Immutable. The http endpoint that can be called to invoke
160
+ # processing.
160
161
  # @!attribute [rw] create_time
161
162
  # @return [::Google::Protobuf::Timestamp]
162
163
  # 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.21.0
4
+ version: 0.21.1
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-04-19 00:00:00.000000000 Z
11
+ date: 2024-05-16 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common