google-cloud-document_ai-v1 0.9.0 → 0.10.0

data/proto_docs/google/cloud/documentai/v1/evaluation.rb

@@ -0,0 +1,199 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module DocumentAI
+      module V1
+        # Gives a short summary of an evaluation, and links to the evaluation itself.
+        # @!attribute [rw] operation
+        #   @return [::String]
+        #     The resource name of the Long Running Operation for the evaluation.
+        # @!attribute [rw] evaluation
+        #   @return [::String]
+        #     The resource name of the evaluation.
+        # @!attribute [rw] aggregate_metrics
+        #   @return [::Google::Cloud::DocumentAI::V1::Evaluation::Metrics]
+        #     An aggregate of the statistics for the evaluation with fuzzy matching on.
+        # @!attribute [rw] aggregate_metrics_exact
+        #   @return [::Google::Cloud::DocumentAI::V1::Evaluation::Metrics]
+        #     An aggregate of the statistics for the evaluation with fuzzy matching off.
+        class EvaluationReference
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # An evaluation of a ProcessorVersion's performance.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     The resource name of the evaluation.
+        #     Format:
+        #     `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}`
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The time that the evaluation was created.
+        # @!attribute [rw] document_counters
+        #   @return [::Google::Cloud::DocumentAI::V1::Evaluation::Counters]
+        #     Counters for the documents used in the evaluation.
+        # @!attribute [rw] all_entities_metrics
+        #   @return [::Google::Cloud::DocumentAI::V1::Evaluation::MultiConfidenceMetrics]
+        #     Metrics for all the entities in aggregate.
+        # @!attribute [rw] entity_metrics
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DocumentAI::V1::Evaluation::MultiConfidenceMetrics}]
+        #     Metrics across confidence levels, for different entities.
+        # @!attribute [rw] kms_key_name
+        #   @return [::String]
+        #     The KMS key name used for encryption.
+        # @!attribute [rw] kms_key_version_name
+        #   @return [::String]
+        #     The KMS key version with which data is encrypted.
+        class Evaluation
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Evaluation counters for the documents that were used.
+          # @!attribute [rw] input_documents_count
+          #   @return [::Integer]
+          #     How many documents were sent for evaluation.
+          # @!attribute [rw] invalid_documents_count
+          #   @return [::Integer]
+          #     How many documents were not included in the evaluation as they didn't
+          #     pass validation.
+          # @!attribute [rw] failed_documents_count
+          #   @return [::Integer]
+          #     How many documents were not included in the evaluation as Document AI
+          #     failed to process them.
+          # @!attribute [rw] evaluated_documents_count
+          #   @return [::Integer]
+          #     How many documents were used in the evaluation.
+          class Counters
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Evaluation metrics, either in aggregate or about a specific entity.
+          # @!attribute [rw] precision
+          #   @return [::Float]
+          #     The calculated precision.
+          # @!attribute [rw] recall
+          #   @return [::Float]
+          #     The calculated recall.
+          # @!attribute [rw] f1_score
+          #   @return [::Float]
+          #     The calculated f1 score.
+          # @!attribute [rw] predicted_occurrences_count
+          #   @return [::Integer]
+          #     The amount of occurrences in predicted documents.
+          # @!attribute [rw] ground_truth_occurrences_count
+          #   @return [::Integer]
+          #     The amount of occurrences in ground truth documents.
+          # @!attribute [rw] predicted_document_count
+          #   @return [::Integer]
+          #     The amount of documents with a predicted occurrence.
+          # @!attribute [rw] ground_truth_document_count
+          #   @return [::Integer]
+          #     The amount of documents with a ground truth occurrence.
+          # @!attribute [rw] true_positives_count
+          #   @return [::Integer]
+          #     The amount of true positives.
+          # @!attribute [rw] false_positives_count
+          #   @return [::Integer]
+          #     The amount of false positives.
+          # @!attribute [rw] false_negatives_count
+          #   @return [::Integer]
+          #     The amount of false negatives.
+          # @!attribute [rw] total_documents_count
+          #   @return [::Integer]
+          #     The amount of documents that had an occurrence of this label.
+          class Metrics
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Evaluations metrics, at a specific confidence level.
+          # @!attribute [rw] confidence_level
+          #   @return [::Float]
+          #     The confidence level.
+          # @!attribute [rw] metrics
+          #   @return [::Google::Cloud::DocumentAI::V1::Evaluation::Metrics]
+          #     The metrics at the specific confidence level.
+          class ConfidenceLevelMetrics
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Metrics across multiple confidence levels.
+          # @!attribute [rw] confidence_level_metrics
+          #   @return [::Array<::Google::Cloud::DocumentAI::V1::Evaluation::ConfidenceLevelMetrics>]
+          #     Metrics across confidence levels with fuzzy matching enabled.
+          # @!attribute [rw] confidence_level_metrics_exact
+          #   @return [::Array<::Google::Cloud::DocumentAI::V1::Evaluation::ConfidenceLevelMetrics>]
+          #     Metrics across confidence levels with only exact matching.
+          # @!attribute [rw] auprc
+          #   @return [::Float]
+          #     The calculated area under the precision recall curve (AUPRC), computed by
+          #     integrating over all confidence thresholds.
+          # @!attribute [rw] estimated_calibration_error
+          #   @return [::Float]
+          #     The Estimated Calibration Error (ECE) of the confidence of the predicted
+          #     entities.
+          # @!attribute [rw] auprc_exact
+          #   @return [::Float]
+          #     The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching
+          #     only.
+          # @!attribute [rw] estimated_calibration_error_exact
+          #   @return [::Float]
+          #     The ECE for the predicted entities with fuzzy matching disabled, i.e.,
+          #     exact matching only.
+          # @!attribute [rw] metrics_type
+          #   @return [::Google::Cloud::DocumentAI::V1::Evaluation::MultiConfidenceMetrics::MetricsType]
+          #     The metrics type for the label.
+          class MultiConfidenceMetrics
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # A type that determines how metrics should be interpreted.
+            module MetricsType
+              # The metrics type is unspecified. By default, metrics without a
+              # particular specification are for leaf entity types (i.e., top-level
+              # entity types without child types, or child types which are not
+              # parent types themselves).
+              METRICS_TYPE_UNSPECIFIED = 0
+
+              # Indicates whether metrics for this particular label type represent an
+              # aggregate of metrics for other types instead of being based on actual
+              # TP/FP/FN values for the label type. Metrics for parent (i.e., non-leaf)
+              # entity types are an aggregate of metrics for their children.
+              AGGREGATE = 1
+            end
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::DocumentAI::V1::Evaluation::MultiConfidenceMetrics]
+          class EntityMetricsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/documentai/v1/processor.rb

@@ -43,6 +43,9 @@ module Google
         # @!attribute [rw] create_time
         #   @return [::Google::Protobuf::Timestamp]
         #     The time the processor version was created.
+        # @!attribute [rw] latest_evaluation
+        #   @return [::Google::Cloud::DocumentAI::V1::EvaluationReference]
+        #     The most recently invoked evaluation for the processor version.
         # @!attribute [rw] kms_key_name
         #   @return [::String]
         #     The KMS key name used for encryption.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-document_ai-v1
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-20 00:00:00.000000000 Z
+date: 2023-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.17.1
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.17.1
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -60,7 +60,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -70,14 +70,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.26.1
+        version: 1.26.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.26.1
+        version: 1.26.3
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -204,6 +204,7 @@ files:
 - lib/google/cloud/documentai/v1/document_processor_service_pb.rb
 - lib/google/cloud/documentai/v1/document_processor_service_services_pb.rb
 - lib/google/cloud/documentai/v1/document_schema_pb.rb
+- lib/google/cloud/documentai/v1/evaluation_pb.rb
 - lib/google/cloud/documentai/v1/geometry_pb.rb
 - lib/google/cloud/documentai/v1/operation_metadata_pb.rb
 - lib/google/cloud/documentai/v1/processor_pb.rb
@@ -218,6 +219,7 @@ files:
 - proto_docs/google/cloud/documentai/v1/document_io.rb
 - proto_docs/google/cloud/documentai/v1/document_processor_service.rb
 - proto_docs/google/cloud/documentai/v1/document_schema.rb
+- proto_docs/google/cloud/documentai/v1/evaluation.rb
 - proto_docs/google/cloud/documentai/v1/geometry.rb
 - proto_docs/google/cloud/documentai/v1/operation_metadata.rb
 - proto_docs/google/cloud/documentai/v1/processor.rb