google-apis-documentai_v1 0.54.0 → 0.56.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d447c0eab599df90a2f7fc4c7aa351ca86150d9eb2b2549a611ffde0f1d11dc4
4
- data.tar.gz: 0f0a6dfaeb72abaa55974f885241ab78b91710339a71e881282ae613a7666d7b
3
+ metadata.gz: 39ed666036e415996aa5742094876cd9977b392f4d55ffaca0acde82606a7584
4
+ data.tar.gz: fe2018747c14709276c33033f83a267d0ad7ed8c1870632f4be9e5cf11d6e58f
5
5
  SHA512:
6
- metadata.gz: 8b5bca68c6c4004772aad3c34676ddb7b780f358b933be4e37a1aae0bc98e14f29aeb0167decbc53d9ae5a95acaa61052df9f39ab58275aa484553a43b0583e1
7
- data.tar.gz: b808c8f96cb7454e22b3bf06f4fc7d0c45b63724722012c02c56b70056f852d8054b847ebad5ca7eaf4844d21daebf24c4356595f51e1e64b451b9cb6301aaad
6
+ metadata.gz: 2d837dc7e08f8c8e129e21c4b0a6d56ab37938221d354d751a7173b8e5039c43f6efc08f54185da88be734c0f11787f1c2af7de3959d7d7eff993d5f80de85ed
7
+ data.tar.gz: 7d5ac8e8e92e0018c642688d585f7c43385c295dfaac960e31619e3acda68930e76496ad8c9cdeb3a6b2a9b1ad636207615c9146d1e5287583dccae3109ca944
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-documentai_v1
2
2
 
3
+ ### v0.56.0 (2023-01-29)
4
+
5
+ * Regenerated from discovery document revision 20230120
6
+
7
+ ### v0.55.0 (2023-01-22)
8
+
9
+ * Regenerated from discovery document revision 20230113
10
+
3
11
  ### v0.54.0 (2023-01-15)
4
12
 
5
13
  * Regenerated from discovery document revision 20230106
@@ -244,25 +244,6 @@ module Google
244
244
  end
245
245
  end
246
246
 
247
- # The long running operation metadata for DeleteDataLabelingJob.
248
- class GoogleCloudDocumentaiUiv1beta3DeleteDataLabelingJobOperationMetadata
249
- include Google::Apis::Core::Hashable
250
-
251
- # The common metadata for long running operations.
252
- # Corresponds to the JSON property `commonMetadata`
253
- # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata]
254
- attr_accessor :common_metadata
255
-
256
- def initialize(**args)
257
- update!(**args)
258
- end
259
-
260
- # Update properties of this object
261
- def update!(**args)
262
- @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
263
- end
264
- end
265
-
266
247
  # The long running operation metadata for DeleteLabelerPool.
267
248
  class GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata
268
249
  include Google::Apis::Core::Hashable
@@ -395,6 +376,11 @@ module Google
395
376
  # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3DocumentIdGcsManagedDocumentId]
396
377
  attr_accessor :gcs_managed_doc_id
397
378
 
379
+ # The revision reference specifies which revision on the document to read.
380
+ # Corresponds to the JSON property `revisionRef`
381
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3RevisionRef]
382
+ attr_accessor :revision_ref
383
+
398
384
  # The revision reference specifies which revision on the document to read.
399
385
  # Corresponds to the JSON property `revisionReference`
400
386
  # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3RevisionReference]
@@ -407,6 +393,7 @@ module Google
407
393
  # Update properties of this object
408
394
  def update!(**args)
409
395
  @gcs_managed_doc_id = args[:gcs_managed_doc_id] if args.key?(:gcs_managed_doc_id)
396
+ @revision_ref = args[:revision_ref] if args.key?(:revision_ref)
410
397
  @revision_reference = args[:revision_reference] if args.key?(:revision_reference)
411
398
  end
412
399
  end
@@ -771,6 +758,44 @@ module Google
771
758
  end
772
759
  end
773
760
 
761
+ # The long running operation metadata for the ImportProcessorVersion method.
762
+ class GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata
763
+ include Google::Apis::Core::Hashable
764
+
765
+ # The common metadata for long running operations.
766
+ # Corresponds to the JSON property `commonMetadata`
767
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata]
768
+ attr_accessor :common_metadata
769
+
770
+ def initialize(**args)
771
+ update!(**args)
772
+ end
773
+
774
+ # Update properties of this object
775
+ def update!(**args)
776
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
777
+ end
778
+ end
779
+
780
+ # The response message for the ImportProcessorVersion method.
781
+ class GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse
782
+ include Google::Apis::Core::Hashable
783
+
784
+ # The destination processor version name.
785
+ # Corresponds to the JSON property `processorVersion`
786
+ # @return [String]
787
+ attr_accessor :processor_version
788
+
789
+ def initialize(**args)
790
+ update!(**args)
791
+ end
792
+
793
+ # Update properties of this object
794
+ def update!(**args)
795
+ @processor_version = args[:processor_version] if args.key?(:processor_version)
796
+ end
797
+ end
798
+
774
799
  # The metadata proto of ResyncDataset method.
775
800
  class GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata
776
801
  include Google::Apis::Core::Hashable
@@ -883,6 +908,39 @@ module Google
883
908
  end
884
909
  end
885
910
 
911
+ # The revision reference specifies which revision on the document to read.
912
+ class GoogleCloudDocumentaiUiv1beta3RevisionRef
913
+ include Google::Apis::Core::Hashable
914
+
915
+ # Reads the revision generated by the processor version. The format takes the
916
+ # full resource name of processor version. `projects/`project`/locations/`
917
+ # location`/processors/`processor`/processorVersions/`processorVersion``
918
+ # Corresponds to the JSON property `latestProcessorVersion`
919
+ # @return [String]
920
+ attr_accessor :latest_processor_version
921
+
922
+ # Reads the revision by the predefined case.
923
+ # Corresponds to the JSON property `revisionCase`
924
+ # @return [String]
925
+ attr_accessor :revision_case
926
+
927
+ # Reads the revision given by the id.
928
+ # Corresponds to the JSON property `revisionId`
929
+ # @return [String]
930
+ attr_accessor :revision_id
931
+
932
+ def initialize(**args)
933
+ update!(**args)
934
+ end
935
+
936
+ # Update properties of this object
937
+ def update!(**args)
938
+ @latest_processor_version = args[:latest_processor_version] if args.key?(:latest_processor_version)
939
+ @revision_case = args[:revision_case] if args.key?(:revision_case)
940
+ @revision_id = args[:revision_id] if args.key?(:revision_id)
941
+ end
942
+ end
943
+
886
944
  # The revision reference specifies which revision on the document to read.
887
945
  class GoogleCloudDocumentaiUiv1beta3RevisionReference
888
946
  include Google::Apis::Core::Hashable
@@ -3439,6 +3497,320 @@ module Google
3439
3497
  end
3440
3498
  end
3441
3499
 
3500
+ # Evaluates the given ProcessorVersion against the supplied documents.
3501
+ class GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest
3502
+ include Google::Apis::Core::Hashable
3503
+
3504
+ # The common config to specify a set of documents used as input.
3505
+ # Corresponds to the JSON property `evaluationDocuments`
3506
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchDocumentsInputConfig]
3507
+ attr_accessor :evaluation_documents
3508
+
3509
+ def initialize(**args)
3510
+ update!(**args)
3511
+ end
3512
+
3513
+ # Update properties of this object
3514
+ def update!(**args)
3515
+ @evaluation_documents = args[:evaluation_documents] if args.key?(:evaluation_documents)
3516
+ end
3517
+ end
3518
+
3519
+ # An evaluation of a ProcessorVersion's performance.
3520
+ class GoogleCloudDocumentaiV1Evaluation
3521
+ include Google::Apis::Core::Hashable
3522
+
3523
+ # Metrics across multiple confidence levels.
3524
+ # Corresponds to the JSON property `allEntitiesMetrics`
3525
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics]
3526
+ attr_accessor :all_entities_metrics
3527
+
3528
+ # The time that the evaluation was created.
3529
+ # Corresponds to the JSON property `createTime`
3530
+ # @return [String]
3531
+ attr_accessor :create_time
3532
+
3533
+ # Evaluation counters for the documents that were used.
3534
+ # Corresponds to the JSON property `documentCounters`
3535
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationCounters]
3536
+ attr_accessor :document_counters
3537
+
3538
+ # Metrics across confidence levels, for different entities.
3539
+ # Corresponds to the JSON property `entityMetrics`
3540
+ # @return [Hash<String,Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics>]
3541
+ attr_accessor :entity_metrics
3542
+
3543
+ # The KMS key name used for encryption.
3544
+ # Corresponds to the JSON property `kmsKeyName`
3545
+ # @return [String]
3546
+ attr_accessor :kms_key_name
3547
+
3548
+ # The KMS key version with which data is encrypted.
3549
+ # Corresponds to the JSON property `kmsKeyVersionName`
3550
+ # @return [String]
3551
+ attr_accessor :kms_key_version_name
3552
+
3553
+ # The resource name of the evaluation. Format: `projects/`project`/locations/`
3554
+ # location`/processors/`processor`/processorVersions/`processor_version`/
3555
+ # evaluations/`evaluation``
3556
+ # Corresponds to the JSON property `name`
3557
+ # @return [String]
3558
+ attr_accessor :name
3559
+
3560
+ def initialize(**args)
3561
+ update!(**args)
3562
+ end
3563
+
3564
+ # Update properties of this object
3565
+ def update!(**args)
3566
+ @all_entities_metrics = args[:all_entities_metrics] if args.key?(:all_entities_metrics)
3567
+ @create_time = args[:create_time] if args.key?(:create_time)
3568
+ @document_counters = args[:document_counters] if args.key?(:document_counters)
3569
+ @entity_metrics = args[:entity_metrics] if args.key?(:entity_metrics)
3570
+ @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
3571
+ @kms_key_version_name = args[:kms_key_version_name] if args.key?(:kms_key_version_name)
3572
+ @name = args[:name] if args.key?(:name)
3573
+ end
3574
+ end
3575
+
3576
+ # Evaluations metrics, at a specific confidence level.
3577
+ class GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics
3578
+ include Google::Apis::Core::Hashable
3579
+
3580
+ # The confidence level.
3581
+ # Corresponds to the JSON property `confidenceLevel`
3582
+ # @return [Float]
3583
+ attr_accessor :confidence_level
3584
+
3585
+ # Evaluation metrics, either in aggregate or about a specific entity.
3586
+ # Corresponds to the JSON property `metrics`
3587
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics]
3588
+ attr_accessor :metrics
3589
+
3590
+ def initialize(**args)
3591
+ update!(**args)
3592
+ end
3593
+
3594
+ # Update properties of this object
3595
+ def update!(**args)
3596
+ @confidence_level = args[:confidence_level] if args.key?(:confidence_level)
3597
+ @metrics = args[:metrics] if args.key?(:metrics)
3598
+ end
3599
+ end
3600
+
3601
+ # Evaluation counters for the documents that were used.
3602
+ class GoogleCloudDocumentaiV1EvaluationCounters
3603
+ include Google::Apis::Core::Hashable
3604
+
3605
+ # How many documents were used in the evaluation.
3606
+ # Corresponds to the JSON property `evaluatedDocumentsCount`
3607
+ # @return [Fixnum]
3608
+ attr_accessor :evaluated_documents_count
3609
+
3610
+ # How many documents were not included in the evaluation as Document AI failed
3611
+ # to process them.
3612
+ # Corresponds to the JSON property `failedDocumentsCount`
3613
+ # @return [Fixnum]
3614
+ attr_accessor :failed_documents_count
3615
+
3616
+ # How many documents were sent for evaluation.
3617
+ # Corresponds to the JSON property `inputDocumentsCount`
3618
+ # @return [Fixnum]
3619
+ attr_accessor :input_documents_count
3620
+
3621
+ # How many documents were not included in the evaluation as they didn't pass
3622
+ # validation.
3623
+ # Corresponds to the JSON property `invalidDocumentsCount`
3624
+ # @return [Fixnum]
3625
+ attr_accessor :invalid_documents_count
3626
+
3627
+ def initialize(**args)
3628
+ update!(**args)
3629
+ end
3630
+
3631
+ # Update properties of this object
3632
+ def update!(**args)
3633
+ @evaluated_documents_count = args[:evaluated_documents_count] if args.key?(:evaluated_documents_count)
3634
+ @failed_documents_count = args[:failed_documents_count] if args.key?(:failed_documents_count)
3635
+ @input_documents_count = args[:input_documents_count] if args.key?(:input_documents_count)
3636
+ @invalid_documents_count = args[:invalid_documents_count] if args.key?(:invalid_documents_count)
3637
+ end
3638
+ end
3639
+
3640
+ # Evaluation metrics, either in aggregate or about a specific entity.
3641
+ class GoogleCloudDocumentaiV1EvaluationMetrics
3642
+ include Google::Apis::Core::Hashable
3643
+
3644
+ # The calculated f1 score.
3645
+ # Corresponds to the JSON property `f1Score`
3646
+ # @return [Float]
3647
+ attr_accessor :f1_score
3648
+
3649
+ # The amount of false negatives.
3650
+ # Corresponds to the JSON property `falseNegativesCount`
3651
+ # @return [Fixnum]
3652
+ attr_accessor :false_negatives_count
3653
+
3654
+ # The amount of false positives.
3655
+ # Corresponds to the JSON property `falsePositivesCount`
3656
+ # @return [Fixnum]
3657
+ attr_accessor :false_positives_count
3658
+
3659
+ # The amount of documents with a ground truth occurrence.
3660
+ # Corresponds to the JSON property `groundTruthDocumentCount`
3661
+ # @return [Fixnum]
3662
+ attr_accessor :ground_truth_document_count
3663
+
3664
+ # The amount of occurrences in ground truth documents.
3665
+ # Corresponds to the JSON property `groundTruthOccurrencesCount`
3666
+ # @return [Fixnum]
3667
+ attr_accessor :ground_truth_occurrences_count
3668
+
3669
+ # The calculated precision.
3670
+ # Corresponds to the JSON property `precision`
3671
+ # @return [Float]
3672
+ attr_accessor :precision
3673
+
3674
+ # The amount of documents with a predicted occurrence.
3675
+ # Corresponds to the JSON property `predictedDocumentCount`
3676
+ # @return [Fixnum]
3677
+ attr_accessor :predicted_document_count
3678
+
3679
+ # The amount of occurrences in predicted documents.
3680
+ # Corresponds to the JSON property `predictedOccurrencesCount`
3681
+ # @return [Fixnum]
3682
+ attr_accessor :predicted_occurrences_count
3683
+
3684
+ # The calculated recall.
3685
+ # Corresponds to the JSON property `recall`
3686
+ # @return [Float]
3687
+ attr_accessor :recall
3688
+
3689
+ # The amount of documents that had an occurrence of this label.
3690
+ # Corresponds to the JSON property `totalDocumentsCount`
3691
+ # @return [Fixnum]
3692
+ attr_accessor :total_documents_count
3693
+
3694
+ # The amount of true positives.
3695
+ # Corresponds to the JSON property `truePositivesCount`
3696
+ # @return [Fixnum]
3697
+ attr_accessor :true_positives_count
3698
+
3699
+ def initialize(**args)
3700
+ update!(**args)
3701
+ end
3702
+
3703
+ # Update properties of this object
3704
+ def update!(**args)
3705
+ @f1_score = args[:f1_score] if args.key?(:f1_score)
3706
+ @false_negatives_count = args[:false_negatives_count] if args.key?(:false_negatives_count)
3707
+ @false_positives_count = args[:false_positives_count] if args.key?(:false_positives_count)
3708
+ @ground_truth_document_count = args[:ground_truth_document_count] if args.key?(:ground_truth_document_count)
3709
+ @ground_truth_occurrences_count = args[:ground_truth_occurrences_count] if args.key?(:ground_truth_occurrences_count)
3710
+ @precision = args[:precision] if args.key?(:precision)
3711
+ @predicted_document_count = args[:predicted_document_count] if args.key?(:predicted_document_count)
3712
+ @predicted_occurrences_count = args[:predicted_occurrences_count] if args.key?(:predicted_occurrences_count)
3713
+ @recall = args[:recall] if args.key?(:recall)
3714
+ @total_documents_count = args[:total_documents_count] if args.key?(:total_documents_count)
3715
+ @true_positives_count = args[:true_positives_count] if args.key?(:true_positives_count)
3716
+ end
3717
+ end
3718
+
3719
+ # Metrics across multiple confidence levels.
3720
+ class GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics
3721
+ include Google::Apis::Core::Hashable
3722
+
3723
+ # The calculated area under the precision recall curve (AUPRC), computed by
3724
+ # integrating over all confidence thresholds.
3725
+ # Corresponds to the JSON property `auprc`
3726
+ # @return [Float]
3727
+ attr_accessor :auprc
3728
+
3729
+ # The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only.
3730
+ # Corresponds to the JSON property `auprcExact`
3731
+ # @return [Float]
3732
+ attr_accessor :auprc_exact
3733
+
3734
+ # Metrics across confidence levels with fuzzy matching enabled.
3735
+ # Corresponds to the JSON property `confidenceLevelMetrics`
3736
+ # @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics>]
3737
+ attr_accessor :confidence_level_metrics
3738
+
3739
+ # Metrics across confidence levels with only exact matching.
3740
+ # Corresponds to the JSON property `confidenceLevelMetricsExact`
3741
+ # @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics>]
3742
+ attr_accessor :confidence_level_metrics_exact
3743
+
3744
+ # The Estimated Calibration Error (ECE) of the confidence of the predicted
3745
+ # entities.
3746
+ # Corresponds to the JSON property `estimatedCalibrationError`
3747
+ # @return [Float]
3748
+ attr_accessor :estimated_calibration_error
3749
+
3750
+ # The ECE for the predicted entities with fuzzy matching disabled, i.e., exact
3751
+ # matching only.
3752
+ # Corresponds to the JSON property `estimatedCalibrationErrorExact`
3753
+ # @return [Float]
3754
+ attr_accessor :estimated_calibration_error_exact
3755
+
3756
+ # The metrics type for the label.
3757
+ # Corresponds to the JSON property `metricsType`
3758
+ # @return [String]
3759
+ attr_accessor :metrics_type
3760
+
3761
+ def initialize(**args)
3762
+ update!(**args)
3763
+ end
3764
+
3765
+ # Update properties of this object
3766
+ def update!(**args)
3767
+ @auprc = args[:auprc] if args.key?(:auprc)
3768
+ @auprc_exact = args[:auprc_exact] if args.key?(:auprc_exact)
3769
+ @confidence_level_metrics = args[:confidence_level_metrics] if args.key?(:confidence_level_metrics)
3770
+ @confidence_level_metrics_exact = args[:confidence_level_metrics_exact] if args.key?(:confidence_level_metrics_exact)
3771
+ @estimated_calibration_error = args[:estimated_calibration_error] if args.key?(:estimated_calibration_error)
3772
+ @estimated_calibration_error_exact = args[:estimated_calibration_error_exact] if args.key?(:estimated_calibration_error_exact)
3773
+ @metrics_type = args[:metrics_type] if args.key?(:metrics_type)
3774
+ end
3775
+ end
3776
+
3777
+ # Gives a short summary of an evaluation, and links to the evaluation itself.
3778
+ class GoogleCloudDocumentaiV1EvaluationReference
3779
+ include Google::Apis::Core::Hashable
3780
+
3781
+ # Evaluation metrics, either in aggregate or about a specific entity.
3782
+ # Corresponds to the JSON property `aggregateMetrics`
3783
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics]
3784
+ attr_accessor :aggregate_metrics
3785
+
3786
+ # Evaluation metrics, either in aggregate or about a specific entity.
3787
+ # Corresponds to the JSON property `aggregateMetricsExact`
3788
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics]
3789
+ attr_accessor :aggregate_metrics_exact
3790
+
3791
+ # The resource name of the evaluation.
3792
+ # Corresponds to the JSON property `evaluation`
3793
+ # @return [String]
3794
+ attr_accessor :evaluation
3795
+
3796
+ # The resource name of the Long Running Operation for the evaluation.
3797
+ # Corresponds to the JSON property `operation`
3798
+ # @return [String]
3799
+ attr_accessor :operation
3800
+
3801
+ def initialize(**args)
3802
+ update!(**args)
3803
+ end
3804
+
3805
+ # Update properties of this object
3806
+ def update!(**args)
3807
+ @aggregate_metrics = args[:aggregate_metrics] if args.key?(:aggregate_metrics)
3808
+ @aggregate_metrics_exact = args[:aggregate_metrics_exact] if args.key?(:aggregate_metrics_exact)
3809
+ @evaluation = args[:evaluation] if args.key?(:evaluation)
3810
+ @operation = args[:operation] if args.key?(:operation)
3811
+ end
3812
+ end
3813
+
3442
3814
  # Response message for fetch processor types.
3443
3815
  class GoogleCloudDocumentaiV1FetchProcessorTypesResponse
3444
3816
  include Google::Apis::Core::Hashable
@@ -3555,6 +3927,32 @@ module Google
3555
3927
  end
3556
3928
  end
3557
3929
 
3930
+ # The response from ListEvaluations.
3931
+ class GoogleCloudDocumentaiV1ListEvaluationsResponse
3932
+ include Google::Apis::Core::Hashable
3933
+
3934
+ # The evaluations requested.
3935
+ # Corresponds to the JSON property `evaluations`
3936
+ # @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Evaluation>]
3937
+ attr_accessor :evaluations
3938
+
3939
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
3940
+ # field is omitted, there are no subsequent pages.
3941
+ # Corresponds to the JSON property `nextPageToken`
3942
+ # @return [String]
3943
+ attr_accessor :next_page_token
3944
+
3945
+ def initialize(**args)
3946
+ update!(**args)
3947
+ end
3948
+
3949
+ # Update properties of this object
3950
+ def update!(**args)
3951
+ @evaluations = args[:evaluations] if args.key?(:evaluations)
3952
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
3953
+ end
3954
+ end
3955
+
3558
3956
  # Response message for list processor types.
3559
3957
  class GoogleCloudDocumentaiV1ListProcessorTypesResponse
3560
3958
  include Google::Apis::Core::Hashable
@@ -3916,6 +4314,11 @@ module Google
3916
4314
  # @return [String]
3917
4315
  attr_accessor :kms_key_version_name
3918
4316
 
4317
+ # Gives a short summary of an evaluation, and links to the evaluation itself.
4318
+ # Corresponds to the JSON property `latestEvaluation`
4319
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationReference]
4320
+ attr_accessor :latest_evaluation
4321
+
3919
4322
  # The resource name of the processor version. Format: `projects/`project`/
3920
4323
  # locations/`location`/processors/`processor`/processorVersions/`
3921
4324
  # processor_version``
@@ -3941,6 +4344,7 @@ module Google
3941
4344
  @google_managed = args[:google_managed] if args.key?(:google_managed)
3942
4345
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
3943
4346
  @kms_key_version_name = args[:kms_key_version_name] if args.key?(:kms_key_version_name)
4347
+ @latest_evaluation = args[:latest_evaluation] if args.key?(:latest_evaluation)
3944
4348
  @name = args[:name] if args.key?(:name)
3945
4349
  @state = args[:state] if args.key?(:state)
3946
4350
  end
@@ -4148,6 +4552,74 @@ module Google
4148
4552
  end
4149
4553
  end
4150
4554
 
4555
+ # Request message for the create processor version method.
4556
+ class GoogleCloudDocumentaiV1TrainProcessorVersionRequest
4557
+ include Google::Apis::Core::Hashable
4558
+
4559
+ # Optional. The processor version to use as a base for training. This processor
4560
+ # version must be a child of `parent`. Format: `projects/`project`/locations/`
4561
+ # location`/processors/`processor`/processorVersions/`processorVersion``.
4562
+ # Corresponds to the JSON property `baseProcessorVersion`
4563
+ # @return [String]
4564
+ attr_accessor :base_processor_version
4565
+
4566
+ # The schema defines the output of the processed document by a processor.
4567
+ # Corresponds to the JSON property `documentSchema`
4568
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchema]
4569
+ attr_accessor :document_schema
4570
+
4571
+ # The input data used to train a new `ProcessorVersion`.
4572
+ # Corresponds to the JSON property `inputData`
4573
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData]
4574
+ attr_accessor :input_data
4575
+
4576
+ # A processor version is an implementation of a processor. Each processor can
4577
+ # have multiple versions, pre-trained by Google internally or up-trained by the
4578
+ # customer. At a time, a processor can only have one default version version. So
4579
+ # the processor's behavior (when processing documents) is defined by a default
4580
+ # version
4581
+ # Corresponds to the JSON property `processorVersion`
4582
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ProcessorVersion]
4583
+ attr_accessor :processor_version
4584
+
4585
+ def initialize(**args)
4586
+ update!(**args)
4587
+ end
4588
+
4589
+ # Update properties of this object
4590
+ def update!(**args)
4591
+ @base_processor_version = args[:base_processor_version] if args.key?(:base_processor_version)
4592
+ @document_schema = args[:document_schema] if args.key?(:document_schema)
4593
+ @input_data = args[:input_data] if args.key?(:input_data)
4594
+ @processor_version = args[:processor_version] if args.key?(:processor_version)
4595
+ end
4596
+ end
4597
+
4598
+ # The input data used to train a new `ProcessorVersion`.
4599
+ class GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData
4600
+ include Google::Apis::Core::Hashable
4601
+
4602
+ # The common config to specify a set of documents used as input.
4603
+ # Corresponds to the JSON property `testDocuments`
4604
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchDocumentsInputConfig]
4605
+ attr_accessor :test_documents
4606
+
4607
+ # The common config to specify a set of documents used as input.
4608
+ # Corresponds to the JSON property `trainingDocuments`
4609
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchDocumentsInputConfig]
4610
+ attr_accessor :training_documents
4611
+
4612
+ def initialize(**args)
4613
+ update!(**args)
4614
+ end
4615
+
4616
+ # Update properties of this object
4617
+ def update!(**args)
4618
+ @test_documents = args[:test_documents] if args.key?(:test_documents)
4619
+ @training_documents = args[:training_documents] if args.key?(:training_documents)
4620
+ end
4621
+ end
4622
+
4151
4623
  # The long running operation metadata for the undeploy processor version method.
4152
4624
  class GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata
4153
4625
  include Google::Apis::Core::Hashable
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DocumentaiV1
18
18
  # Version of the google-apis-documentai_v1 gem
19
- GEM_VERSION = "0.54.0"
19
+ GEM_VERSION = "0.56.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.11.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20230106"
25
+ REVISION = "20230120"
26
26
  end
27
27
  end
28
28
  end
@@ -70,12 +70,6 @@ module Google
70
70
  include Google::Apis::Core::JsonObjectSupport
71
71
  end
72
72
 
73
- class GoogleCloudDocumentaiUiv1beta3DeleteDataLabelingJobOperationMetadata
74
- class Representation < Google::Apis::Core::JsonRepresentation; end
75
-
76
- include Google::Apis::Core::JsonObjectSupport
77
- end
78
-
79
73
  class GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata
80
74
  class Representation < Google::Apis::Core::JsonRepresentation; end
81
75
 
@@ -214,6 +208,18 @@ module Google
214
208
  include Google::Apis::Core::JsonObjectSupport
215
209
  end
216
210
 
211
+ class GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata
212
+ class Representation < Google::Apis::Core::JsonRepresentation; end
213
+
214
+ include Google::Apis::Core::JsonObjectSupport
215
+ end
216
+
217
+ class GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse
218
+ class Representation < Google::Apis::Core::JsonRepresentation; end
219
+
220
+ include Google::Apis::Core::JsonObjectSupport
221
+ end
222
+
217
223
  class GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata
218
224
  class Representation < Google::Apis::Core::JsonRepresentation; end
219
225
 
@@ -238,6 +244,12 @@ module Google
238
244
  include Google::Apis::Core::JsonObjectSupport
239
245
  end
240
246
 
247
+ class GoogleCloudDocumentaiUiv1beta3RevisionRef
248
+ class Representation < Google::Apis::Core::JsonRepresentation; end
249
+
250
+ include Google::Apis::Core::JsonObjectSupport
251
+ end
252
+
241
253
  class GoogleCloudDocumentaiUiv1beta3RevisionReference
242
254
  class Representation < Google::Apis::Core::JsonRepresentation; end
243
255
 
@@ -682,6 +694,48 @@ module Google
682
694
  include Google::Apis::Core::JsonObjectSupport
683
695
  end
684
696
 
697
+ class GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest
698
+ class Representation < Google::Apis::Core::JsonRepresentation; end
699
+
700
+ include Google::Apis::Core::JsonObjectSupport
701
+ end
702
+
703
+ class GoogleCloudDocumentaiV1Evaluation
704
+ class Representation < Google::Apis::Core::JsonRepresentation; end
705
+
706
+ include Google::Apis::Core::JsonObjectSupport
707
+ end
708
+
709
+ class GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics
710
+ class Representation < Google::Apis::Core::JsonRepresentation; end
711
+
712
+ include Google::Apis::Core::JsonObjectSupport
713
+ end
714
+
715
+ class GoogleCloudDocumentaiV1EvaluationCounters
716
+ class Representation < Google::Apis::Core::JsonRepresentation; end
717
+
718
+ include Google::Apis::Core::JsonObjectSupport
719
+ end
720
+
721
+ class GoogleCloudDocumentaiV1EvaluationMetrics
722
+ class Representation < Google::Apis::Core::JsonRepresentation; end
723
+
724
+ include Google::Apis::Core::JsonObjectSupport
725
+ end
726
+
727
+ class GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics
728
+ class Representation < Google::Apis::Core::JsonRepresentation; end
729
+
730
+ include Google::Apis::Core::JsonObjectSupport
731
+ end
732
+
733
+ class GoogleCloudDocumentaiV1EvaluationReference
734
+ class Representation < Google::Apis::Core::JsonRepresentation; end
735
+
736
+ include Google::Apis::Core::JsonObjectSupport
737
+ end
738
+
685
739
  class GoogleCloudDocumentaiV1FetchProcessorTypesResponse
686
740
  class Representation < Google::Apis::Core::JsonRepresentation; end
687
741
 
@@ -712,6 +766,12 @@ module Google
712
766
  include Google::Apis::Core::JsonObjectSupport
713
767
  end
714
768
 
769
+ class GoogleCloudDocumentaiV1ListEvaluationsResponse
770
+ class Representation < Google::Apis::Core::JsonRepresentation; end
771
+
772
+ include Google::Apis::Core::JsonObjectSupport
773
+ end
774
+
715
775
  class GoogleCloudDocumentaiV1ListProcessorTypesResponse
716
776
  class Representation < Google::Apis::Core::JsonRepresentation; end
717
777
 
@@ -820,6 +880,18 @@ module Google
820
880
  include Google::Apis::Core::JsonObjectSupport
821
881
  end
822
882
 
883
+ class GoogleCloudDocumentaiV1TrainProcessorVersionRequest
884
+ class Representation < Google::Apis::Core::JsonRepresentation; end
885
+
886
+ include Google::Apis::Core::JsonObjectSupport
887
+ end
888
+
889
+ class GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData
890
+ class Representation < Google::Apis::Core::JsonRepresentation; end
891
+
892
+ include Google::Apis::Core::JsonObjectSupport
893
+ end
894
+
823
895
  class GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata
824
896
  class Representation < Google::Apis::Core::JsonRepresentation; end
825
897
 
@@ -1705,14 +1777,6 @@ module Google
1705
1777
  end
1706
1778
  end
1707
1779
 
1708
- class GoogleCloudDocumentaiUiv1beta3DeleteDataLabelingJobOperationMetadata
1709
- # @private
1710
- class Representation < Google::Apis::Core::JsonRepresentation
1711
- property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation
1712
-
1713
- end
1714
- end
1715
-
1716
1780
  class GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata
1717
1781
  # @private
1718
1782
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1770,6 +1834,8 @@ module Google
1770
1834
  class Representation < Google::Apis::Core::JsonRepresentation
1771
1835
  property :gcs_managed_doc_id, as: 'gcsManagedDocId', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3DocumentIdGcsManagedDocumentId, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3DocumentIdGcsManagedDocumentId::Representation
1772
1836
 
1837
+ property :revision_ref, as: 'revisionRef', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3RevisionRef, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3RevisionRef::Representation
1838
+
1773
1839
  property :revision_reference, as: 'revisionReference', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3RevisionReference, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3RevisionReference::Representation
1774
1840
 
1775
1841
  end
@@ -1902,6 +1968,21 @@ module Google
1902
1968
  end
1903
1969
  end
1904
1970
 
1971
+ class GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata
1972
+ # @private
1973
+ class Representation < Google::Apis::Core::JsonRepresentation
1974
+ property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation
1975
+
1976
+ end
1977
+ end
1978
+
1979
+ class GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse
1980
+ # @private
1981
+ class Representation < Google::Apis::Core::JsonRepresentation
1982
+ property :processor_version, as: 'processorVersion'
1983
+ end
1984
+ end
1985
+
1905
1986
  class GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata
1906
1987
  # @private
1907
1988
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1940,6 +2021,15 @@ module Google
1940
2021
  end
1941
2022
  end
1942
2023
 
2024
+ class GoogleCloudDocumentaiUiv1beta3RevisionRef
2025
+ # @private
2026
+ class Representation < Google::Apis::Core::JsonRepresentation
2027
+ property :latest_processor_version, as: 'latestProcessorVersion'
2028
+ property :revision_case, as: 'revisionCase'
2029
+ property :revision_id, as: 'revisionId'
2030
+ end
2031
+ end
2032
+
1943
2033
  class GoogleCloudDocumentaiUiv1beta3RevisionReference
1944
2034
  # @private
1945
2035
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2714,6 +2804,93 @@ module Google
2714
2804
  end
2715
2805
  end
2716
2806
 
2807
+ class GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest
2808
+ # @private
2809
+ class Representation < Google::Apis::Core::JsonRepresentation
2810
+ property :evaluation_documents, as: 'evaluationDocuments', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchDocumentsInputConfig, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchDocumentsInputConfig::Representation
2811
+
2812
+ end
2813
+ end
2814
+
2815
+ class GoogleCloudDocumentaiV1Evaluation
2816
+ # @private
2817
+ class Representation < Google::Apis::Core::JsonRepresentation
2818
+ property :all_entities_metrics, as: 'allEntitiesMetrics', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics::Representation
2819
+
2820
+ property :create_time, as: 'createTime'
2821
+ property :document_counters, as: 'documentCounters', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationCounters, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationCounters::Representation
2822
+
2823
+ hash :entity_metrics, as: 'entityMetrics', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics::Representation
2824
+
2825
+ property :kms_key_name, as: 'kmsKeyName'
2826
+ property :kms_key_version_name, as: 'kmsKeyVersionName'
2827
+ property :name, as: 'name'
2828
+ end
2829
+ end
2830
+
2831
+ class GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics
2832
+ # @private
2833
+ class Representation < Google::Apis::Core::JsonRepresentation
2834
+ property :confidence_level, as: 'confidenceLevel'
2835
+ property :metrics, as: 'metrics', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics::Representation
2836
+
2837
+ end
2838
+ end
2839
+
2840
+ class GoogleCloudDocumentaiV1EvaluationCounters
2841
+ # @private
2842
+ class Representation < Google::Apis::Core::JsonRepresentation
2843
+ property :evaluated_documents_count, as: 'evaluatedDocumentsCount'
2844
+ property :failed_documents_count, as: 'failedDocumentsCount'
2845
+ property :input_documents_count, as: 'inputDocumentsCount'
2846
+ property :invalid_documents_count, as: 'invalidDocumentsCount'
2847
+ end
2848
+ end
2849
+
2850
+ class GoogleCloudDocumentaiV1EvaluationMetrics
2851
+ # @private
2852
+ class Representation < Google::Apis::Core::JsonRepresentation
2853
+ property :f1_score, as: 'f1Score'
2854
+ property :false_negatives_count, as: 'falseNegativesCount'
2855
+ property :false_positives_count, as: 'falsePositivesCount'
2856
+ property :ground_truth_document_count, as: 'groundTruthDocumentCount'
2857
+ property :ground_truth_occurrences_count, as: 'groundTruthOccurrencesCount'
2858
+ property :precision, as: 'precision'
2859
+ property :predicted_document_count, as: 'predictedDocumentCount'
2860
+ property :predicted_occurrences_count, as: 'predictedOccurrencesCount'
2861
+ property :recall, as: 'recall'
2862
+ property :total_documents_count, as: 'totalDocumentsCount'
2863
+ property :true_positives_count, as: 'truePositivesCount'
2864
+ end
2865
+ end
2866
+
2867
+ class GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics
2868
+ # @private
2869
+ class Representation < Google::Apis::Core::JsonRepresentation
2870
+ property :auprc, as: 'auprc'
2871
+ property :auprc_exact, as: 'auprcExact'
2872
+ collection :confidence_level_metrics, as: 'confidenceLevelMetrics', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics::Representation
2873
+
2874
+ collection :confidence_level_metrics_exact, as: 'confidenceLevelMetricsExact', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics::Representation
2875
+
2876
+ property :estimated_calibration_error, as: 'estimatedCalibrationError'
2877
+ property :estimated_calibration_error_exact, as: 'estimatedCalibrationErrorExact'
2878
+ property :metrics_type, as: 'metricsType'
2879
+ end
2880
+ end
2881
+
2882
+ class GoogleCloudDocumentaiV1EvaluationReference
2883
+ # @private
2884
+ class Representation < Google::Apis::Core::JsonRepresentation
2885
+ property :aggregate_metrics, as: 'aggregateMetrics', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics::Representation
2886
+
2887
+ property :aggregate_metrics_exact, as: 'aggregateMetricsExact', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics::Representation
2888
+
2889
+ property :evaluation, as: 'evaluation'
2890
+ property :operation, as: 'operation'
2891
+ end
2892
+ end
2893
+
2717
2894
  class GoogleCloudDocumentaiV1FetchProcessorTypesResponse
2718
2895
  # @private
2719
2896
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2754,6 +2931,15 @@ module Google
2754
2931
  end
2755
2932
  end
2756
2933
 
2934
+ class GoogleCloudDocumentaiV1ListEvaluationsResponse
2935
+ # @private
2936
+ class Representation < Google::Apis::Core::JsonRepresentation
2937
+ collection :evaluations, as: 'evaluations', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Evaluation, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Evaluation::Representation
2938
+
2939
+ property :next_page_token, as: 'nextPageToken'
2940
+ end
2941
+ end
2942
+
2757
2943
  class GoogleCloudDocumentaiV1ListProcessorTypesResponse
2758
2944
  # @private
2759
2945
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2858,6 +3044,8 @@ module Google
2858
3044
  property :google_managed, as: 'googleManaged'
2859
3045
  property :kms_key_name, as: 'kmsKeyName'
2860
3046
  property :kms_key_version_name, as: 'kmsKeyVersionName'
3047
+ property :latest_evaluation, as: 'latestEvaluation', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationReference, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationReference::Representation
3048
+
2861
3049
  property :name, as: 'name'
2862
3050
  property :state, as: 'state'
2863
3051
  end
@@ -2930,6 +3118,29 @@ module Google
2930
3118
  end
2931
3119
  end
2932
3120
 
3121
+ class GoogleCloudDocumentaiV1TrainProcessorVersionRequest
3122
+ # @private
3123
+ class Representation < Google::Apis::Core::JsonRepresentation
3124
+ property :base_processor_version, as: 'baseProcessorVersion'
3125
+ property :document_schema, as: 'documentSchema', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchema, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchema::Representation
3126
+
3127
+ property :input_data, as: 'inputData', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData::Representation
3128
+
3129
+ property :processor_version, as: 'processorVersion', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ProcessorVersion, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ProcessorVersion::Representation
3130
+
3131
+ end
3132
+ end
3133
+
3134
+ class GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData
3135
+ # @private
3136
+ class Representation < Google::Apis::Core::JsonRepresentation
3137
+ property :test_documents, as: 'testDocuments', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchDocumentsInputConfig, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchDocumentsInputConfig::Representation
3138
+
3139
+ property :training_documents, as: 'trainingDocuments', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchDocumentsInputConfig, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchDocumentsInputConfig::Representation
3140
+
3141
+ end
3142
+ end
3143
+
2933
3144
  class GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata
2934
3145
  # @private
2935
3146
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -820,6 +820,42 @@ module Google
820
820
  execute_or_queue_command(command, &block)
821
821
  end
822
822
 
823
+ # Evaluates a ProcessorVersion against annotated documents, producing an
824
+ # Evaluation.
825
+ # @param [String] processor_version
826
+ # Required. The resource name of the ProcessorVersion to evaluate. `projects/`
827
+ # project`/locations/`location`/processors/`processor`/processorVersions/`
828
+ # processorVersion``
829
+ # @param [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest] google_cloud_documentai_v1_evaluate_processor_version_request_object
830
+ # @param [String] fields
831
+ # Selector specifying which fields to include in a partial response.
832
+ # @param [String] quota_user
833
+ # Available to use for quota purposes for server-side applications. Can be any
834
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
835
+ # @param [Google::Apis::RequestOptions] options
836
+ # Request-specific options
837
+ #
838
+ # @yield [result, err] Result & error if block supplied
839
+ # @yieldparam result [Google::Apis::DocumentaiV1::GoogleLongrunningOperation] parsed result object
840
+ # @yieldparam err [StandardError] error object if request failed
841
+ #
842
+ # @return [Google::Apis::DocumentaiV1::GoogleLongrunningOperation]
843
+ #
844
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
845
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
846
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
847
+ def evaluate_project_location_processor_processor_version_processor_version(processor_version, google_cloud_documentai_v1_evaluate_processor_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
848
+ command = make_simple_command(:post, 'v1/{+processorVersion}:evaluateProcessorVersion', options)
849
+ command.request_representation = Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest::Representation
850
+ command.request_object = google_cloud_documentai_v1_evaluate_processor_version_request_object
851
+ command.response_representation = Google::Apis::DocumentaiV1::GoogleLongrunningOperation::Representation
852
+ command.response_class = Google::Apis::DocumentaiV1::GoogleLongrunningOperation
853
+ command.params['processorVersion'] = processor_version unless processor_version.nil?
854
+ command.query['fields'] = fields unless fields.nil?
855
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
856
+ execute_or_queue_command(command, &block)
857
+ end
858
+
823
859
  # Gets a processor version detail.
824
860
  # @param [String] name
825
861
  # Required. The processor resource name.
@@ -927,6 +963,42 @@ module Google
927
963
  execute_or_queue_command(command, &block)
928
964
  end
929
965
 
966
+ # Trains a new processor version. Operation metadata is returned as
967
+ # cloud_documentai_core.TrainProcessorVersionMetadata.
968
+ # @param [String] parent
969
+ # Required. The parent (project, location and processor) to create the new
970
+ # version for. Format: `projects/`project`/locations/`location`/processors/`
971
+ # processor``.
972
+ # @param [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1TrainProcessorVersionRequest] google_cloud_documentai_v1_train_processor_version_request_object
973
+ # @param [String] fields
974
+ # Selector specifying which fields to include in a partial response.
975
+ # @param [String] quota_user
976
+ # Available to use for quota purposes for server-side applications. Can be any
977
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
978
+ # @param [Google::Apis::RequestOptions] options
979
+ # Request-specific options
980
+ #
981
+ # @yield [result, err] Result & error if block supplied
982
+ # @yieldparam result [Google::Apis::DocumentaiV1::GoogleLongrunningOperation] parsed result object
983
+ # @yieldparam err [StandardError] error object if request failed
984
+ #
985
+ # @return [Google::Apis::DocumentaiV1::GoogleLongrunningOperation]
986
+ #
987
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
988
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
989
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
990
+ def train_project_location_processor_processor_version(parent, google_cloud_documentai_v1_train_processor_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
991
+ command = make_simple_command(:post, 'v1/{+parent}/processorVersions:train', options)
992
+ command.request_representation = Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1TrainProcessorVersionRequest::Representation
993
+ command.request_object = google_cloud_documentai_v1_train_processor_version_request_object
994
+ command.response_representation = Google::Apis::DocumentaiV1::GoogleLongrunningOperation::Representation
995
+ command.response_class = Google::Apis::DocumentaiV1::GoogleLongrunningOperation
996
+ command.params['parent'] = parent unless parent.nil?
997
+ command.query['fields'] = fields unless fields.nil?
998
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
999
+ execute_or_queue_command(command, &block)
1000
+ end
1001
+
930
1002
  # Undeploys the processor version.
931
1003
  # @param [String] name
932
1004
  # Required. The processor version resource name to be undeployed.
@@ -960,6 +1032,78 @@ module Google
960
1032
  execute_or_queue_command(command, &block)
961
1033
  end
962
1034
 
1035
+ # Retrieves a specific evaluation.
1036
+ # @param [String] name
1037
+ # Required. The resource name of the Evaluation to get. `projects/`project`/
1038
+ # locations/`location`/processors/`processor`/processorVersions/`
1039
+ # processorVersion`/evaluations/`evaluation``
1040
+ # @param [String] fields
1041
+ # Selector specifying which fields to include in a partial response.
1042
+ # @param [String] quota_user
1043
+ # Available to use for quota purposes for server-side applications. Can be any
1044
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1045
+ # @param [Google::Apis::RequestOptions] options
1046
+ # Request-specific options
1047
+ #
1048
+ # @yield [result, err] Result & error if block supplied
1049
+ # @yieldparam result [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Evaluation] parsed result object
1050
+ # @yieldparam err [StandardError] error object if request failed
1051
+ #
1052
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Evaluation]
1053
+ #
1054
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1055
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1056
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1057
+ def get_project_location_processor_processor_version_evaluation(name, fields: nil, quota_user: nil, options: nil, &block)
1058
+ command = make_simple_command(:get, 'v1/{+name}', options)
1059
+ command.response_representation = Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Evaluation::Representation
1060
+ command.response_class = Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Evaluation
1061
+ command.params['name'] = name unless name.nil?
1062
+ command.query['fields'] = fields unless fields.nil?
1063
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1064
+ execute_or_queue_command(command, &block)
1065
+ end
1066
+
1067
+ # Retrieves a set of evaluations for a given processor version.
1068
+ # @param [String] parent
1069
+ # Required. The resource name of the ProcessorVersion to list evaluations for. `
1070
+ # projects/`project`/locations/`location`/processors/`processor`/
1071
+ # processorVersions/`processorVersion``
1072
+ # @param [Fixnum] page_size
1073
+ # The standard list page size. If unspecified, at most 5 evaluations will be
1074
+ # returned. The maximum value is 100; values above 100 will be coerced to 100.
1075
+ # @param [String] page_token
1076
+ # A page token, received from a previous `ListEvaluations` call. Provide this to
1077
+ # retrieve the subsequent page.
1078
+ # @param [String] fields
1079
+ # Selector specifying which fields to include in a partial response.
1080
+ # @param [String] quota_user
1081
+ # Available to use for quota purposes for server-side applications. Can be any
1082
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1083
+ # @param [Google::Apis::RequestOptions] options
1084
+ # Request-specific options
1085
+ #
1086
+ # @yield [result, err] Result & error if block supplied
1087
+ # @yieldparam result [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ListEvaluationsResponse] parsed result object
1088
+ # @yieldparam err [StandardError] error object if request failed
1089
+ #
1090
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ListEvaluationsResponse]
1091
+ #
1092
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1093
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1094
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1095
+ def list_project_location_processor_processor_version_evaluations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1096
+ command = make_simple_command(:get, 'v1/{+parent}/evaluations', options)
1097
+ command.response_representation = Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ListEvaluationsResponse::Representation
1098
+ command.response_class = Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ListEvaluationsResponse
1099
+ command.params['parent'] = parent unless parent.nil?
1100
+ command.query['pageSize'] = page_size unless page_size.nil?
1101
+ command.query['pageToken'] = page_token unless page_token.nil?
1102
+ command.query['fields'] = fields unless fields.nil?
1103
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1104
+ execute_or_queue_command(command, &block)
1105
+ end
1106
+
963
1107
  # Gets the latest state of a long-running operation. Clients can use this method
964
1108
  # to poll the operation result at intervals as recommended by the API service.
965
1109
  # @param [String] name
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-documentai_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.54.0
4
+ version: 0.56.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: 2023-01-15 00:00:00.000000000 Z
11
+ date: 2023-01-29 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-documentai_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1/v0.54.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1/v0.56.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-documentai_v1
63
63
  post_install_message:
64
64
  rdoc_options: []