google-apis-documentai_v1 0.54.0 → 0.55.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d447c0eab599df90a2f7fc4c7aa351ca86150d9eb2b2549a611ffde0f1d11dc4
4
- data.tar.gz: 0f0a6dfaeb72abaa55974f885241ab78b91710339a71e881282ae613a7666d7b
3
+ metadata.gz: cfb63fb2719e8b59ef6682a6e1ade5c020a294854a02e95e040b88eb1a644899
4
+ data.tar.gz: 364b8eee4b663b9fd4a39170f5e2beb1786977a767eb92dce62cf96bcabcce0d
5
5
  SHA512:
6
- metadata.gz: 8b5bca68c6c4004772aad3c34676ddb7b780f358b933be4e37a1aae0bc98e14f29aeb0167decbc53d9ae5a95acaa61052df9f39ab58275aa484553a43b0583e1
7
- data.tar.gz: b808c8f96cb7454e22b3bf06f4fc7d0c45b63724722012c02c56b70056f852d8054b847ebad5ca7eaf4844d21daebf24c4356595f51e1e64b451b9cb6301aaad
6
+ metadata.gz: 1cf8ddd53de846897095b7523591de142d1b17447abd7a7bc9c85d777557ab4166c32fd6ac323a939559312c4f5ad92647cef3207e95d78e56382887b13438e6
7
+ data.tar.gz: 463447d87da942148ef7534d9a15e2fdf1717448d7f7de08f3041f6a829178a25187eb2d3ef9b5f153a19f36d14e85f594ba2ac3896772abf60f9d9873ae0df3
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-documentai_v1
2
2
 
3
+ ### v0.55.0 (2023-01-22)
4
+
5
+ * Regenerated from discovery document revision 20230113
6
+
3
7
  ### v0.54.0 (2023-01-15)
4
8
 
5
9
  * Regenerated from discovery document revision 20230106
@@ -395,6 +395,11 @@ module Google
395
395
  # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3DocumentIdGcsManagedDocumentId]
396
396
  attr_accessor :gcs_managed_doc_id
397
397
 
398
+ # The revision reference specifies which revision on the document to read.
399
+ # Corresponds to the JSON property `revisionRef`
400
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3RevisionRef]
401
+ attr_accessor :revision_ref
402
+
398
403
  # The revision reference specifies which revision on the document to read.
399
404
  # Corresponds to the JSON property `revisionReference`
400
405
  # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3RevisionReference]
@@ -407,6 +412,7 @@ module Google
407
412
  # Update properties of this object
408
413
  def update!(**args)
409
414
  @gcs_managed_doc_id = args[:gcs_managed_doc_id] if args.key?(:gcs_managed_doc_id)
415
+ @revision_ref = args[:revision_ref] if args.key?(:revision_ref)
410
416
  @revision_reference = args[:revision_reference] if args.key?(:revision_reference)
411
417
  end
412
418
  end
@@ -883,6 +889,39 @@ module Google
883
889
  end
884
890
  end
885
891
 
892
+ # The revision reference specifies which revision on the document to read.
893
+ class GoogleCloudDocumentaiUiv1beta3RevisionRef
894
+ include Google::Apis::Core::Hashable
895
+
896
+ # Reads the revision generated by the processor version. The format takes the
897
+ # full resource name of processor version. `projects/`project`/locations/`
898
+ # location`/processors/`processor`/processorVersions/`processorVersion``
899
+ # Corresponds to the JSON property `latestProcessorVersion`
900
+ # @return [String]
901
+ attr_accessor :latest_processor_version
902
+
903
+ # Reads the revision by the predefined case.
904
+ # Corresponds to the JSON property `revisionCase`
905
+ # @return [String]
906
+ attr_accessor :revision_case
907
+
908
+ # Reads the revision given by the id.
909
+ # Corresponds to the JSON property `revisionId`
910
+ # @return [String]
911
+ attr_accessor :revision_id
912
+
913
+ def initialize(**args)
914
+ update!(**args)
915
+ end
916
+
917
+ # Update properties of this object
918
+ def update!(**args)
919
+ @latest_processor_version = args[:latest_processor_version] if args.key?(:latest_processor_version)
920
+ @revision_case = args[:revision_case] if args.key?(:revision_case)
921
+ @revision_id = args[:revision_id] if args.key?(:revision_id)
922
+ end
923
+ end
924
+
886
925
  # The revision reference specifies which revision on the document to read.
887
926
  class GoogleCloudDocumentaiUiv1beta3RevisionReference
888
927
  include Google::Apis::Core::Hashable
@@ -3439,6 +3478,320 @@ module Google
3439
3478
  end
3440
3479
  end
3441
3480
 
3481
+ # Evaluates the given ProcessorVersion against the supplied documents.
3482
+ class GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest
3483
+ include Google::Apis::Core::Hashable
3484
+
3485
+ # The common config to specify a set of documents used as input.
3486
+ # Corresponds to the JSON property `evaluationDocuments`
3487
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchDocumentsInputConfig]
3488
+ attr_accessor :evaluation_documents
3489
+
3490
+ def initialize(**args)
3491
+ update!(**args)
3492
+ end
3493
+
3494
+ # Update properties of this object
3495
+ def update!(**args)
3496
+ @evaluation_documents = args[:evaluation_documents] if args.key?(:evaluation_documents)
3497
+ end
3498
+ end
3499
+
3500
+ # An evaluation of a ProcessorVersion's performance.
3501
+ class GoogleCloudDocumentaiV1Evaluation
3502
+ include Google::Apis::Core::Hashable
3503
+
3504
+ # Metrics across multiple confidence levels.
3505
+ # Corresponds to the JSON property `allEntitiesMetrics`
3506
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics]
3507
+ attr_accessor :all_entities_metrics
3508
+
3509
+ # The time that the evaluation was created.
3510
+ # Corresponds to the JSON property `createTime`
3511
+ # @return [String]
3512
+ attr_accessor :create_time
3513
+
3514
+ # Evaluation counters for the documents that were used.
3515
+ # Corresponds to the JSON property `documentCounters`
3516
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationCounters]
3517
+ attr_accessor :document_counters
3518
+
3519
+ # Metrics across confidence levels, for different entities.
3520
+ # Corresponds to the JSON property `entityMetrics`
3521
+ # @return [Hash<String,Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics>]
3522
+ attr_accessor :entity_metrics
3523
+
3524
+ # The KMS key name used for encryption.
3525
+ # Corresponds to the JSON property `kmsKeyName`
3526
+ # @return [String]
3527
+ attr_accessor :kms_key_name
3528
+
3529
+ # The KMS key version with which data is encrypted.
3530
+ # Corresponds to the JSON property `kmsKeyVersionName`
3531
+ # @return [String]
3532
+ attr_accessor :kms_key_version_name
3533
+
3534
+ # The resource name of the evaluation. Format: `projects/`project`/locations/`
3535
+ # location`/processors/`processor`/processorVersions/`processor_version`/
3536
+ # evaluations/`evaluation``
3537
+ # Corresponds to the JSON property `name`
3538
+ # @return [String]
3539
+ attr_accessor :name
3540
+
3541
+ def initialize(**args)
3542
+ update!(**args)
3543
+ end
3544
+
3545
+ # Update properties of this object
3546
+ def update!(**args)
3547
+ @all_entities_metrics = args[:all_entities_metrics] if args.key?(:all_entities_metrics)
3548
+ @create_time = args[:create_time] if args.key?(:create_time)
3549
+ @document_counters = args[:document_counters] if args.key?(:document_counters)
3550
+ @entity_metrics = args[:entity_metrics] if args.key?(:entity_metrics)
3551
+ @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
3552
+ @kms_key_version_name = args[:kms_key_version_name] if args.key?(:kms_key_version_name)
3553
+ @name = args[:name] if args.key?(:name)
3554
+ end
3555
+ end
3556
+
3557
+ # Evaluations metrics, at a specific confidence level.
3558
+ class GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics
3559
+ include Google::Apis::Core::Hashable
3560
+
3561
+ # The confidence level.
3562
+ # Corresponds to the JSON property `confidenceLevel`
3563
+ # @return [Float]
3564
+ attr_accessor :confidence_level
3565
+
3566
+ # Evaluation metrics, either in aggregate or about a specific entity.
3567
+ # Corresponds to the JSON property `metrics`
3568
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics]
3569
+ attr_accessor :metrics
3570
+
3571
+ def initialize(**args)
3572
+ update!(**args)
3573
+ end
3574
+
3575
+ # Update properties of this object
3576
+ def update!(**args)
3577
+ @confidence_level = args[:confidence_level] if args.key?(:confidence_level)
3578
+ @metrics = args[:metrics] if args.key?(:metrics)
3579
+ end
3580
+ end
3581
+
3582
+ # Evaluation counters for the documents that were used.
3583
+ class GoogleCloudDocumentaiV1EvaluationCounters
3584
+ include Google::Apis::Core::Hashable
3585
+
3586
+ # How many documents were used in the evaluation.
3587
+ # Corresponds to the JSON property `evaluatedDocumentsCount`
3588
+ # @return [Fixnum]
3589
+ attr_accessor :evaluated_documents_count
3590
+
3591
+ # How many documents were not included in the evaluation as Document AI failed
3592
+ # to process them.
3593
+ # Corresponds to the JSON property `failedDocumentsCount`
3594
+ # @return [Fixnum]
3595
+ attr_accessor :failed_documents_count
3596
+
3597
+ # How many documents were sent for evaluation.
3598
+ # Corresponds to the JSON property `inputDocumentsCount`
3599
+ # @return [Fixnum]
3600
+ attr_accessor :input_documents_count
3601
+
3602
+ # How many documents were not included in the evaluation as they didn't pass
3603
+ # validation.
3604
+ # Corresponds to the JSON property `invalidDocumentsCount`
3605
+ # @return [Fixnum]
3606
+ attr_accessor :invalid_documents_count
3607
+
3608
+ def initialize(**args)
3609
+ update!(**args)
3610
+ end
3611
+
3612
+ # Update properties of this object
3613
+ def update!(**args)
3614
+ @evaluated_documents_count = args[:evaluated_documents_count] if args.key?(:evaluated_documents_count)
3615
+ @failed_documents_count = args[:failed_documents_count] if args.key?(:failed_documents_count)
3616
+ @input_documents_count = args[:input_documents_count] if args.key?(:input_documents_count)
3617
+ @invalid_documents_count = args[:invalid_documents_count] if args.key?(:invalid_documents_count)
3618
+ end
3619
+ end
3620
+
3621
+ # Evaluation metrics, either in aggregate or about a specific entity.
3622
+ class GoogleCloudDocumentaiV1EvaluationMetrics
3623
+ include Google::Apis::Core::Hashable
3624
+
3625
+ # The calculated f1 score.
3626
+ # Corresponds to the JSON property `f1Score`
3627
+ # @return [Float]
3628
+ attr_accessor :f1_score
3629
+
3630
+ # The amount of false negatives.
3631
+ # Corresponds to the JSON property `falseNegativesCount`
3632
+ # @return [Fixnum]
3633
+ attr_accessor :false_negatives_count
3634
+
3635
+ # The amount of false positives.
3636
+ # Corresponds to the JSON property `falsePositivesCount`
3637
+ # @return [Fixnum]
3638
+ attr_accessor :false_positives_count
3639
+
3640
+ # The amount of documents with a ground truth occurrence.
3641
+ # Corresponds to the JSON property `groundTruthDocumentCount`
3642
+ # @return [Fixnum]
3643
+ attr_accessor :ground_truth_document_count
3644
+
3645
+ # The amount of occurrences in ground truth documents.
3646
+ # Corresponds to the JSON property `groundTruthOccurrencesCount`
3647
+ # @return [Fixnum]
3648
+ attr_accessor :ground_truth_occurrences_count
3649
+
3650
+ # The calculated precision.
3651
+ # Corresponds to the JSON property `precision`
3652
+ # @return [Float]
3653
+ attr_accessor :precision
3654
+
3655
+ # The amount of documents with a predicted occurrence.
3656
+ # Corresponds to the JSON property `predictedDocumentCount`
3657
+ # @return [Fixnum]
3658
+ attr_accessor :predicted_document_count
3659
+
3660
+ # The amount of occurrences in predicted documents.
3661
+ # Corresponds to the JSON property `predictedOccurrencesCount`
3662
+ # @return [Fixnum]
3663
+ attr_accessor :predicted_occurrences_count
3664
+
3665
+ # The calculated recall.
3666
+ # Corresponds to the JSON property `recall`
3667
+ # @return [Float]
3668
+ attr_accessor :recall
3669
+
3670
+ # The amount of documents that had an occurrence of this label.
3671
+ # Corresponds to the JSON property `totalDocumentsCount`
3672
+ # @return [Fixnum]
3673
+ attr_accessor :total_documents_count
3674
+
3675
+ # The amount of true positives.
3676
+ # Corresponds to the JSON property `truePositivesCount`
3677
+ # @return [Fixnum]
3678
+ attr_accessor :true_positives_count
3679
+
3680
+ def initialize(**args)
3681
+ update!(**args)
3682
+ end
3683
+
3684
+ # Update properties of this object
3685
+ def update!(**args)
3686
+ @f1_score = args[:f1_score] if args.key?(:f1_score)
3687
+ @false_negatives_count = args[:false_negatives_count] if args.key?(:false_negatives_count)
3688
+ @false_positives_count = args[:false_positives_count] if args.key?(:false_positives_count)
3689
+ @ground_truth_document_count = args[:ground_truth_document_count] if args.key?(:ground_truth_document_count)
3690
+ @ground_truth_occurrences_count = args[:ground_truth_occurrences_count] if args.key?(:ground_truth_occurrences_count)
3691
+ @precision = args[:precision] if args.key?(:precision)
3692
+ @predicted_document_count = args[:predicted_document_count] if args.key?(:predicted_document_count)
3693
+ @predicted_occurrences_count = args[:predicted_occurrences_count] if args.key?(:predicted_occurrences_count)
3694
+ @recall = args[:recall] if args.key?(:recall)
3695
+ @total_documents_count = args[:total_documents_count] if args.key?(:total_documents_count)
3696
+ @true_positives_count = args[:true_positives_count] if args.key?(:true_positives_count)
3697
+ end
3698
+ end
3699
+
3700
+ # Metrics across multiple confidence levels.
3701
+ class GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics
3702
+ include Google::Apis::Core::Hashable
3703
+
3704
+ # The calculated area under the precision recall curve (AUPRC), computed by
3705
+ # integrating over all confidence thresholds.
3706
+ # Corresponds to the JSON property `auprc`
3707
+ # @return [Float]
3708
+ attr_accessor :auprc
3709
+
3710
+ # The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only.
3711
+ # Corresponds to the JSON property `auprcExact`
3712
+ # @return [Float]
3713
+ attr_accessor :auprc_exact
3714
+
3715
+ # Metrics across confidence levels with fuzzy matching enabled.
3716
+ # Corresponds to the JSON property `confidenceLevelMetrics`
3717
+ # @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics>]
3718
+ attr_accessor :confidence_level_metrics
3719
+
3720
+ # Metrics across confidence levels with only exact matching.
3721
+ # Corresponds to the JSON property `confidenceLevelMetricsExact`
3722
+ # @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics>]
3723
+ attr_accessor :confidence_level_metrics_exact
3724
+
3725
+ # The Estimated Calibration Error (ECE) of the confidence of the predicted
3726
+ # entities.
3727
+ # Corresponds to the JSON property `estimatedCalibrationError`
3728
+ # @return [Float]
3729
+ attr_accessor :estimated_calibration_error
3730
+
3731
+ # The ECE for the predicted entities with fuzzy matching disabled, i.e., exact
3732
+ # matching only.
3733
+ # Corresponds to the JSON property `estimatedCalibrationErrorExact`
3734
+ # @return [Float]
3735
+ attr_accessor :estimated_calibration_error_exact
3736
+
3737
+ # The metrics type for the label.
3738
+ # Corresponds to the JSON property `metricsType`
3739
+ # @return [String]
3740
+ attr_accessor :metrics_type
3741
+
3742
+ def initialize(**args)
3743
+ update!(**args)
3744
+ end
3745
+
3746
+ # Update properties of this object
3747
+ def update!(**args)
3748
+ @auprc = args[:auprc] if args.key?(:auprc)
3749
+ @auprc_exact = args[:auprc_exact] if args.key?(:auprc_exact)
3750
+ @confidence_level_metrics = args[:confidence_level_metrics] if args.key?(:confidence_level_metrics)
3751
+ @confidence_level_metrics_exact = args[:confidence_level_metrics_exact] if args.key?(:confidence_level_metrics_exact)
3752
+ @estimated_calibration_error = args[:estimated_calibration_error] if args.key?(:estimated_calibration_error)
3753
+ @estimated_calibration_error_exact = args[:estimated_calibration_error_exact] if args.key?(:estimated_calibration_error_exact)
3754
+ @metrics_type = args[:metrics_type] if args.key?(:metrics_type)
3755
+ end
3756
+ end
3757
+
3758
+ # Gives a short summary of an evaluation, and links to the evaluation itself.
3759
+ class GoogleCloudDocumentaiV1EvaluationReference
3760
+ include Google::Apis::Core::Hashable
3761
+
3762
+ # Evaluation metrics, either in aggregate or about a specific entity.
3763
+ # Corresponds to the JSON property `aggregateMetrics`
3764
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics]
3765
+ attr_accessor :aggregate_metrics
3766
+
3767
+ # Evaluation metrics, either in aggregate or about a specific entity.
3768
+ # Corresponds to the JSON property `aggregateMetricsExact`
3769
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics]
3770
+ attr_accessor :aggregate_metrics_exact
3771
+
3772
+ # The resource name of the evaluation.
3773
+ # Corresponds to the JSON property `evaluation`
3774
+ # @return [String]
3775
+ attr_accessor :evaluation
3776
+
3777
+ # The resource name of the Long Running Operation for the evaluation.
3778
+ # Corresponds to the JSON property `operation`
3779
+ # @return [String]
3780
+ attr_accessor :operation
3781
+
3782
+ def initialize(**args)
3783
+ update!(**args)
3784
+ end
3785
+
3786
+ # Update properties of this object
3787
+ def update!(**args)
3788
+ @aggregate_metrics = args[:aggregate_metrics] if args.key?(:aggregate_metrics)
3789
+ @aggregate_metrics_exact = args[:aggregate_metrics_exact] if args.key?(:aggregate_metrics_exact)
3790
+ @evaluation = args[:evaluation] if args.key?(:evaluation)
3791
+ @operation = args[:operation] if args.key?(:operation)
3792
+ end
3793
+ end
3794
+
3442
3795
  # Response message for fetch processor types.
3443
3796
  class GoogleCloudDocumentaiV1FetchProcessorTypesResponse
3444
3797
  include Google::Apis::Core::Hashable
@@ -3555,6 +3908,32 @@ module Google
3555
3908
  end
3556
3909
  end
3557
3910
 
3911
+ # The response from ListEvaluations.
3912
+ class GoogleCloudDocumentaiV1ListEvaluationsResponse
3913
+ include Google::Apis::Core::Hashable
3914
+
3915
+ # The evaluations requested.
3916
+ # Corresponds to the JSON property `evaluations`
3917
+ # @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Evaluation>]
3918
+ attr_accessor :evaluations
3919
+
3920
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
3921
+ # field is omitted, there are no subsequent pages.
3922
+ # Corresponds to the JSON property `nextPageToken`
3923
+ # @return [String]
3924
+ attr_accessor :next_page_token
3925
+
3926
+ def initialize(**args)
3927
+ update!(**args)
3928
+ end
3929
+
3930
+ # Update properties of this object
3931
+ def update!(**args)
3932
+ @evaluations = args[:evaluations] if args.key?(:evaluations)
3933
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
3934
+ end
3935
+ end
3936
+
3558
3937
  # Response message for list processor types.
3559
3938
  class GoogleCloudDocumentaiV1ListProcessorTypesResponse
3560
3939
  include Google::Apis::Core::Hashable
@@ -3916,6 +4295,11 @@ module Google
3916
4295
  # @return [String]
3917
4296
  attr_accessor :kms_key_version_name
3918
4297
 
4298
+ # Gives a short summary of an evaluation, and links to the evaluation itself.
4299
+ # Corresponds to the JSON property `latestEvaluation`
4300
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationReference]
4301
+ attr_accessor :latest_evaluation
4302
+
3919
4303
  # The resource name of the processor version. Format: `projects/`project`/
3920
4304
  # locations/`location`/processors/`processor`/processorVersions/`
3921
4305
  # processor_version``
@@ -3941,6 +4325,7 @@ module Google
3941
4325
  @google_managed = args[:google_managed] if args.key?(:google_managed)
3942
4326
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
3943
4327
  @kms_key_version_name = args[:kms_key_version_name] if args.key?(:kms_key_version_name)
4328
+ @latest_evaluation = args[:latest_evaluation] if args.key?(:latest_evaluation)
3944
4329
  @name = args[:name] if args.key?(:name)
3945
4330
  @state = args[:state] if args.key?(:state)
3946
4331
  end
@@ -4148,6 +4533,74 @@ module Google
4148
4533
  end
4149
4534
  end
4150
4535
 
4536
+ # Request message for the create processor version method.
4537
+ class GoogleCloudDocumentaiV1TrainProcessorVersionRequest
4538
+ include Google::Apis::Core::Hashable
4539
+
4540
+ # Optional. The processor version to use as a base for training. This processor
4541
+ # version must be a child of `parent`. Format: `projects/`project`/locations/`
4542
+ # location`/processors/`processor`/processorVersions/`processorVersion``.
4543
+ # Corresponds to the JSON property `baseProcessorVersion`
4544
+ # @return [String]
4545
+ attr_accessor :base_processor_version
4546
+
4547
+ # The schema defines the output of the processed document by a processor.
4548
+ # Corresponds to the JSON property `documentSchema`
4549
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchema]
4550
+ attr_accessor :document_schema
4551
+
4552
+ # The input data used to train a new `ProcessorVersion`.
4553
+ # Corresponds to the JSON property `inputData`
4554
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData]
4555
+ attr_accessor :input_data
4556
+
4557
+ # A processor version is an implementation of a processor. Each processor can
4558
+ # have multiple versions, pre-trained by Google internally or up-trained by the
4559
+ # customer. At a time, a processor can only have one default version version. So
4560
+ # the processor's behavior (when processing documents) is defined by a default
4561
+ # version
4562
+ # Corresponds to the JSON property `processorVersion`
4563
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ProcessorVersion]
4564
+ attr_accessor :processor_version
4565
+
4566
+ def initialize(**args)
4567
+ update!(**args)
4568
+ end
4569
+
4570
+ # Update properties of this object
4571
+ def update!(**args)
4572
+ @base_processor_version = args[:base_processor_version] if args.key?(:base_processor_version)
4573
+ @document_schema = args[:document_schema] if args.key?(:document_schema)
4574
+ @input_data = args[:input_data] if args.key?(:input_data)
4575
+ @processor_version = args[:processor_version] if args.key?(:processor_version)
4576
+ end
4577
+ end
4578
+
4579
+ # The input data used to train a new `ProcessorVersion`.
4580
+ class GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData
4581
+ include Google::Apis::Core::Hashable
4582
+
4583
+ # The common config to specify a set of documents used as input.
4584
+ # Corresponds to the JSON property `testDocuments`
4585
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchDocumentsInputConfig]
4586
+ attr_accessor :test_documents
4587
+
4588
+ # The common config to specify a set of documents used as input.
4589
+ # Corresponds to the JSON property `trainingDocuments`
4590
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchDocumentsInputConfig]
4591
+ attr_accessor :training_documents
4592
+
4593
+ def initialize(**args)
4594
+ update!(**args)
4595
+ end
4596
+
4597
+ # Update properties of this object
4598
+ def update!(**args)
4599
+ @test_documents = args[:test_documents] if args.key?(:test_documents)
4600
+ @training_documents = args[:training_documents] if args.key?(:training_documents)
4601
+ end
4602
+ end
4603
+
4151
4604
  # The long running operation metadata for the undeploy processor version method.
4152
4605
  class GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata
4153
4606
  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.55.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 = "20230113"
26
26
  end
27
27
  end
28
28
  end
@@ -238,6 +238,12 @@ module Google
238
238
  include Google::Apis::Core::JsonObjectSupport
239
239
  end
240
240
 
241
+ class GoogleCloudDocumentaiUiv1beta3RevisionRef
242
+ class Representation < Google::Apis::Core::JsonRepresentation; end
243
+
244
+ include Google::Apis::Core::JsonObjectSupport
245
+ end
246
+
241
247
  class GoogleCloudDocumentaiUiv1beta3RevisionReference
242
248
  class Representation < Google::Apis::Core::JsonRepresentation; end
243
249
 
@@ -682,6 +688,48 @@ module Google
682
688
  include Google::Apis::Core::JsonObjectSupport
683
689
  end
684
690
 
691
+ class GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest
692
+ class Representation < Google::Apis::Core::JsonRepresentation; end
693
+
694
+ include Google::Apis::Core::JsonObjectSupport
695
+ end
696
+
697
+ class GoogleCloudDocumentaiV1Evaluation
698
+ class Representation < Google::Apis::Core::JsonRepresentation; end
699
+
700
+ include Google::Apis::Core::JsonObjectSupport
701
+ end
702
+
703
+ class GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics
704
+ class Representation < Google::Apis::Core::JsonRepresentation; end
705
+
706
+ include Google::Apis::Core::JsonObjectSupport
707
+ end
708
+
709
+ class GoogleCloudDocumentaiV1EvaluationCounters
710
+ class Representation < Google::Apis::Core::JsonRepresentation; end
711
+
712
+ include Google::Apis::Core::JsonObjectSupport
713
+ end
714
+
715
+ class GoogleCloudDocumentaiV1EvaluationMetrics
716
+ class Representation < Google::Apis::Core::JsonRepresentation; end
717
+
718
+ include Google::Apis::Core::JsonObjectSupport
719
+ end
720
+
721
+ class GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics
722
+ class Representation < Google::Apis::Core::JsonRepresentation; end
723
+
724
+ include Google::Apis::Core::JsonObjectSupport
725
+ end
726
+
727
+ class GoogleCloudDocumentaiV1EvaluationReference
728
+ class Representation < Google::Apis::Core::JsonRepresentation; end
729
+
730
+ include Google::Apis::Core::JsonObjectSupport
731
+ end
732
+
685
733
  class GoogleCloudDocumentaiV1FetchProcessorTypesResponse
686
734
  class Representation < Google::Apis::Core::JsonRepresentation; end
687
735
 
@@ -712,6 +760,12 @@ module Google
712
760
  include Google::Apis::Core::JsonObjectSupport
713
761
  end
714
762
 
763
+ class GoogleCloudDocumentaiV1ListEvaluationsResponse
764
+ class Representation < Google::Apis::Core::JsonRepresentation; end
765
+
766
+ include Google::Apis::Core::JsonObjectSupport
767
+ end
768
+
715
769
  class GoogleCloudDocumentaiV1ListProcessorTypesResponse
716
770
  class Representation < Google::Apis::Core::JsonRepresentation; end
717
771
 
@@ -820,6 +874,18 @@ module Google
820
874
  include Google::Apis::Core::JsonObjectSupport
821
875
  end
822
876
 
877
+ class GoogleCloudDocumentaiV1TrainProcessorVersionRequest
878
+ class Representation < Google::Apis::Core::JsonRepresentation; end
879
+
880
+ include Google::Apis::Core::JsonObjectSupport
881
+ end
882
+
883
+ class GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData
884
+ class Representation < Google::Apis::Core::JsonRepresentation; end
885
+
886
+ include Google::Apis::Core::JsonObjectSupport
887
+ end
888
+
823
889
  class GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata
824
890
  class Representation < Google::Apis::Core::JsonRepresentation; end
825
891
 
@@ -1770,6 +1836,8 @@ module Google
1770
1836
  class Representation < Google::Apis::Core::JsonRepresentation
1771
1837
  property :gcs_managed_doc_id, as: 'gcsManagedDocId', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3DocumentIdGcsManagedDocumentId, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3DocumentIdGcsManagedDocumentId::Representation
1772
1838
 
1839
+ property :revision_ref, as: 'revisionRef', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3RevisionRef, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3RevisionRef::Representation
1840
+
1773
1841
  property :revision_reference, as: 'revisionReference', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3RevisionReference, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiUiv1beta3RevisionReference::Representation
1774
1842
 
1775
1843
  end
@@ -1940,6 +2008,15 @@ module Google
1940
2008
  end
1941
2009
  end
1942
2010
 
2011
+ class GoogleCloudDocumentaiUiv1beta3RevisionRef
2012
+ # @private
2013
+ class Representation < Google::Apis::Core::JsonRepresentation
2014
+ property :latest_processor_version, as: 'latestProcessorVersion'
2015
+ property :revision_case, as: 'revisionCase'
2016
+ property :revision_id, as: 'revisionId'
2017
+ end
2018
+ end
2019
+
1943
2020
  class GoogleCloudDocumentaiUiv1beta3RevisionReference
1944
2021
  # @private
1945
2022
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2714,6 +2791,93 @@ module Google
2714
2791
  end
2715
2792
  end
2716
2793
 
2794
+ class GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest
2795
+ # @private
2796
+ class Representation < Google::Apis::Core::JsonRepresentation
2797
+ property :evaluation_documents, as: 'evaluationDocuments', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchDocumentsInputConfig, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchDocumentsInputConfig::Representation
2798
+
2799
+ end
2800
+ end
2801
+
2802
+ class GoogleCloudDocumentaiV1Evaluation
2803
+ # @private
2804
+ class Representation < Google::Apis::Core::JsonRepresentation
2805
+ property :all_entities_metrics, as: 'allEntitiesMetrics', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics::Representation
2806
+
2807
+ property :create_time, as: 'createTime'
2808
+ property :document_counters, as: 'documentCounters', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationCounters, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationCounters::Representation
2809
+
2810
+ hash :entity_metrics, as: 'entityMetrics', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics::Representation
2811
+
2812
+ property :kms_key_name, as: 'kmsKeyName'
2813
+ property :kms_key_version_name, as: 'kmsKeyVersionName'
2814
+ property :name, as: 'name'
2815
+ end
2816
+ end
2817
+
2818
+ class GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics
2819
+ # @private
2820
+ class Representation < Google::Apis::Core::JsonRepresentation
2821
+ property :confidence_level, as: 'confidenceLevel'
2822
+ property :metrics, as: 'metrics', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics::Representation
2823
+
2824
+ end
2825
+ end
2826
+
2827
+ class GoogleCloudDocumentaiV1EvaluationCounters
2828
+ # @private
2829
+ class Representation < Google::Apis::Core::JsonRepresentation
2830
+ property :evaluated_documents_count, as: 'evaluatedDocumentsCount'
2831
+ property :failed_documents_count, as: 'failedDocumentsCount'
2832
+ property :input_documents_count, as: 'inputDocumentsCount'
2833
+ property :invalid_documents_count, as: 'invalidDocumentsCount'
2834
+ end
2835
+ end
2836
+
2837
+ class GoogleCloudDocumentaiV1EvaluationMetrics
2838
+ # @private
2839
+ class Representation < Google::Apis::Core::JsonRepresentation
2840
+ property :f1_score, as: 'f1Score'
2841
+ property :false_negatives_count, as: 'falseNegativesCount'
2842
+ property :false_positives_count, as: 'falsePositivesCount'
2843
+ property :ground_truth_document_count, as: 'groundTruthDocumentCount'
2844
+ property :ground_truth_occurrences_count, as: 'groundTruthOccurrencesCount'
2845
+ property :precision, as: 'precision'
2846
+ property :predicted_document_count, as: 'predictedDocumentCount'
2847
+ property :predicted_occurrences_count, as: 'predictedOccurrencesCount'
2848
+ property :recall, as: 'recall'
2849
+ property :total_documents_count, as: 'totalDocumentsCount'
2850
+ property :true_positives_count, as: 'truePositivesCount'
2851
+ end
2852
+ end
2853
+
2854
+ class GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics
2855
+ # @private
2856
+ class Representation < Google::Apis::Core::JsonRepresentation
2857
+ property :auprc, as: 'auprc'
2858
+ property :auprc_exact, as: 'auprcExact'
2859
+ collection :confidence_level_metrics, as: 'confidenceLevelMetrics', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics::Representation
2860
+
2861
+ collection :confidence_level_metrics_exact, as: 'confidenceLevelMetricsExact', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics::Representation
2862
+
2863
+ property :estimated_calibration_error, as: 'estimatedCalibrationError'
2864
+ property :estimated_calibration_error_exact, as: 'estimatedCalibrationErrorExact'
2865
+ property :metrics_type, as: 'metricsType'
2866
+ end
2867
+ end
2868
+
2869
+ class GoogleCloudDocumentaiV1EvaluationReference
2870
+ # @private
2871
+ class Representation < Google::Apis::Core::JsonRepresentation
2872
+ property :aggregate_metrics, as: 'aggregateMetrics', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics::Representation
2873
+
2874
+ property :aggregate_metrics_exact, as: 'aggregateMetricsExact', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics::Representation
2875
+
2876
+ property :evaluation, as: 'evaluation'
2877
+ property :operation, as: 'operation'
2878
+ end
2879
+ end
2880
+
2717
2881
  class GoogleCloudDocumentaiV1FetchProcessorTypesResponse
2718
2882
  # @private
2719
2883
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2754,6 +2918,15 @@ module Google
2754
2918
  end
2755
2919
  end
2756
2920
 
2921
+ class GoogleCloudDocumentaiV1ListEvaluationsResponse
2922
+ # @private
2923
+ class Representation < Google::Apis::Core::JsonRepresentation
2924
+ collection :evaluations, as: 'evaluations', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Evaluation, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Evaluation::Representation
2925
+
2926
+ property :next_page_token, as: 'nextPageToken'
2927
+ end
2928
+ end
2929
+
2757
2930
  class GoogleCloudDocumentaiV1ListProcessorTypesResponse
2758
2931
  # @private
2759
2932
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2858,6 +3031,8 @@ module Google
2858
3031
  property :google_managed, as: 'googleManaged'
2859
3032
  property :kms_key_name, as: 'kmsKeyName'
2860
3033
  property :kms_key_version_name, as: 'kmsKeyVersionName'
3034
+ property :latest_evaluation, as: 'latestEvaluation', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationReference, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationReference::Representation
3035
+
2861
3036
  property :name, as: 'name'
2862
3037
  property :state, as: 'state'
2863
3038
  end
@@ -2930,6 +3105,29 @@ module Google
2930
3105
  end
2931
3106
  end
2932
3107
 
3108
+ class GoogleCloudDocumentaiV1TrainProcessorVersionRequest
3109
+ # @private
3110
+ class Representation < Google::Apis::Core::JsonRepresentation
3111
+ property :base_processor_version, as: 'baseProcessorVersion'
3112
+ property :document_schema, as: 'documentSchema', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchema, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchema::Representation
3113
+
3114
+ property :input_data, as: 'inputData', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData::Representation
3115
+
3116
+ property :processor_version, as: 'processorVersion', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ProcessorVersion, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ProcessorVersion::Representation
3117
+
3118
+ end
3119
+ end
3120
+
3121
+ class GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData
3122
+ # @private
3123
+ class Representation < Google::Apis::Core::JsonRepresentation
3124
+ property :test_documents, as: 'testDocuments', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchDocumentsInputConfig, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchDocumentsInputConfig::Representation
3125
+
3126
+ property :training_documents, as: 'trainingDocuments', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchDocumentsInputConfig, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchDocumentsInputConfig::Representation
3127
+
3128
+ end
3129
+ end
3130
+
2933
3131
  class GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata
2934
3132
  # @private
2935
3133
  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.55.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-22 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.55.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: []