google-cloud-document_ai-v1beta3 0.13.0 → 0.14.0

data/proto_docs/google/cloud/documentai/v1beta3/document.rb

@@ -60,9 +60,9 @@ module Google
         #     Placeholder.  Relationship among {::Google::Cloud::DocumentAI::V1beta3::Document#entities Document.entities}.
         # @!attribute [rw] text_changes
         #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::TextChange>]
-        #     Placeholder.  A list of text corrections made to [Document.text].  This is
-        #     usually used for annotating corrections to OCR mistakes.  Text changes for
-        #     a given revision may not overlap with each other.
+        #     Placeholder.  A list of text corrections made to {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.  This
+        #     is usually used for annotating corrections to OCR mistakes.  Text changes
+        #     for a given revision may not overlap with each other.
         # @!attribute [rw] shard_info
         #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::ShardInfo]
         #     Information about the sharding if this document is sharded part of a larger
@@ -122,6 +122,10 @@ module Google
           # @!attribute [rw] font_size
           #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::Style::FontSize]
           #     Font size.
+          # @!attribute [rw] font_family
+          #   @return [::String]
+          #     Font family such as `Arial`, `Times New Roman`.
+          #     https://www.w3schools.com/cssref/pr_font_font-family.asp
           class Style
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -195,6 +199,9 @@ module Google
           # @!attribute [rw] detected_barcodes
           #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedBarcode>]
           #     A list of detected barcodes.
+          # @!attribute [rw] image_quality_scores
+          #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::ImageQualityScores]
+          #     Image Quality Scores.
           # @!attribute [rw] provenance
           #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::Provenance]
           #     The history of this page.
@@ -265,7 +272,7 @@ module Google
             #   @return [::Float]
             #     Confidence of the current {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} within context of the object this
             #     layout is for. e.g. confidence can be for a single token, a table,
-            #     a visual element, etc. depending on context. Range [0, 1].
+            #     a visual element, etc. depending on context. Range `[0, 1]`.
             # @!attribute [rw] bounding_poly
             #   @return [::Google::Cloud::DocumentAI::V1beta3::BoundingPoly]
             #     The bounding polygon for the {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout}.
@@ -357,7 +364,7 @@ module Google
             #     A list of detected languages together with confidence.
             # @!attribute [rw] provenance
             #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::Provenance]
-            #     The  history of this annotation.
+            #     The history of this annotation.
             class Token
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -428,6 +435,9 @@ module Google
             # @!attribute [rw] detected_languages
             #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>]
             #     A list of detected languages together with confidence.
+            # @!attribute [rw] provenance
+            #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::Provenance]
+            #     The history of this table.
             class Table
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -514,16 +524,50 @@ module Google
             # Detected language for a structural component.
             # @!attribute [rw] language_code
             #   @return [::String]
-            #     The BCP-47 language code, such as "en-US" or "sr-Latn". For more
+            #     The BCP-47 language code, such as `en-US` or `sr-Latn`. For more
             #     information, see
             #     https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
             # @!attribute [rw] confidence
             #   @return [::Float]
-            #     Confidence of detected language. Range [0, 1].
+            #     Confidence of detected language. Range `[0, 1]`.
             class DetectedLanguage
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
+
+            # Image Quality Scores for the page image
+            # @!attribute [rw] quality_score
+            #   @return [::Float]
+            #     The overall quality score. Range `[0, 1]` where 1 is perfect quality.
+            # @!attribute [rw] detected_defects
+            #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::ImageQualityScores::DetectedDefect>]
+            #     A list of detected defects.
+            class ImageQualityScores
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Image Quality Defects
+              # @!attribute [rw] type
+              #   @return [::String]
+              #     Name of the defect type. Supported values are:
+              #
+              #     - `quality/defect_blurry`
+              #     - `quality/defect_noisy`
+              #     - `quality/defect_dark`
+              #     - `quality/defect_faint`
+              #     - `quality/defect_text_too_small`
+              #     - `quality/defect_document_cutoff`
+              #     - `quality/defect_text_cutoff`
+              #     - `quality/defect_glare`
+              # @!attribute [rw] confidence
+              #   @return [::Float]
+              #     Confidence of detected defect. Range `[0, 1]` where 1 indicates
+              #     strong confidence of that the defect exists.
+              class DetectedDefect
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
           end
 
           # An entity that could be a phrase in the text or a property that belongs to
@@ -538,14 +582,13 @@ module Google
           #     Required. Entity type from a schema e.g. `Address`.
           # @!attribute [rw] mention_text
           #   @return [::String]
-          #     Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity
-          #     is not present in the document, this field will be empty.
+          #     Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.
           # @!attribute [rw] mention_id
           #   @return [::String]
           #     Optional. Deprecated.  Use `id` field instead.
           # @!attribute [rw] confidence
           #   @return [::Float]
-          #     Optional. Confidence of detected Schema entity. Range [0, 1].
+          #     Optional. Confidence of detected Schema entity. Range `[0, 1]`.
           # @!attribute [rw] page_anchor
           #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::PageAnchor]
           #     Optional. Represents the provenance of this entity wrt. the location on the
@@ -610,6 +653,7 @@ module Google
             #     or int normalized text by default.
             #
             #     Below are sample formats mapped to structured values.
+            #
             #     - Money/Currency type (`money_value`) is in the ISO 4217 text format.
             #     - Date type (`date_value`) is in the ISO 8601 text format.
             #     - Datetime type (`datetime_value`) is in the ISO 8601 text format.
@@ -691,7 +735,7 @@ module Google
             #     Optional. Identifies the bounding polygon of a layout element on the page.
             # @!attribute [rw] confidence
             #   @return [::Float]
-            #     Optional. Confidence of detected page element, if applicable. Range [0, 1].
+            #     Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
             class PageRef
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/documentai/v1beta3/document_io.rb

@@ -28,7 +28,7 @@ module Google
         # @!attribute [rw] mime_type
         #   @return [::String]
         #     An IANA MIME type (RFC6838) indicating the nature and format of the
-        #     [content].
+        #     {::Google::Cloud::DocumentAI::V1beta3::RawDocument#content content}.
         class RawDocument
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -67,7 +67,7 @@ module Google
         # The common config to specify a set of documents used as input.
         # @!attribute [rw] gcs_prefix
         #   @return [::Google::Cloud::DocumentAI::V1beta3::GcsPrefix]
-        #     The set of documents that match the specified Cloud Storage [gcs_prefix].
+        #     The set of documents that match the specified Cloud Storage `gcs_prefix`.
         # @!attribute [rw] gcs_documents
         #   @return [::Google::Cloud::DocumentAI::V1beta3::GcsDocuments]
         #     The set of documents individually specified on Cloud Storage.
@@ -89,6 +89,11 @@ module Google
           # @!attribute [rw] gcs_uri
           #   @return [::String]
           #     The Cloud Storage uri (a directory) of the output.
+          # @!attribute [rw] field_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     Specifies which fields to include in the output documents.
+          #     Only supports top level document and pages field so it must be in the
+          #     form of `{document_field_name}` or `pages.{page_field_name}`.
           class GcsOutputConfig
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb

@@ -46,6 +46,8 @@ module Google
         # @!attribute [rw] field_mask
         #   @return [::Google::Protobuf::FieldMask]
         #     Specifies which fields to include in ProcessResponse's document.
+        #     Only supports top level document and pages field so it must be in the form
+        #     of `{document_field_name}` or `pages.{page_field_name}`.
         class ProcessRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -553,6 +555,89 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Request message for the create processor version method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent (project, location and processor) to create the new version for.
+        #     Format: `projects/{project}/locations/{location}/processors/{processor}`.
+        # @!attribute [rw] processor_version
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion]
+        #     Required. The processor version to be created.
+        # @!attribute [rw] document_schema
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::DocumentSchema]
+        #     Optional. The schema the processor version will be trained with.
+        # @!attribute [rw] input_data
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::InputData]
+        #     Optional. The input data used to train the `ProcessorVersion`.
+        # @!attribute [rw] base_processor_version
+        #   @return [::String]
+        #     Optional. The processor version to use as a base for training. This processor version
+        #     must be a child of `parent`. Format:
+        #     `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.
+        class TrainProcessorVersionRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The input data used to train a new `ProcessorVersion`.
+          # @!attribute [rw] training_documents
+          #   @return [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig]
+          #     The documents used for training the new version.
+          # @!attribute [rw] test_documents
+          #   @return [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig]
+          #     The documents used for testing the trained version.
+          class InputData
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # The response for the TrainProcessorVersion method.
+        # @!attribute [rw] processor_version
+        #   @return [::String]
+        #     The resource name of the processor version produced by training.
+        class TrainProcessorVersionResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The metadata that represents a processor version being created.
+        # @!attribute [rw] common_metadata
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
+        #     The basic metadata of the long running operation.
+        # @!attribute [rw] training_dataset_validation
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionMetadata::DatasetValidation]
+        #     The training dataset validation information.
+        # @!attribute [rw] test_dataset_validation
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionMetadata::DatasetValidation]
+        #     The test dataset validation information.
+        class TrainProcessorVersionMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The dataset validation information.
+          # This includes any and all errors with documents and the dataset.
+          # @!attribute [rw] document_error_count
+          #   @return [::Integer]
+          #     The total number of document errors.
+          # @!attribute [rw] dataset_error_count
+          #   @return [::Integer]
+          #     The total number of dataset errors.
+          # @!attribute [rw] document_errors
+          #   @return [::Array<::Google::Rpc::Status>]
+          #     Error information pertaining to specific documents. A maximum of 10
+          #     document errors will be returned.
+          #     Any document with errors will not be used throughout training.
+          # @!attribute [rw] dataset_errors
+          #   @return [::Array<::Google::Rpc::Status>]
+          #     Error information for the dataset as a whole. A maximum of 10 dataset
+          #     errors will be returned.
+          #     A single dataset error is terminal for training.
+          class DatasetValidation
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
         # Request message for review document method.
         # @!attribute [rw] inline_document
         #   @return [::Google::Cloud::DocumentAI::V1beta3::Document]
@@ -661,6 +746,80 @@ module Google
             CANCELLED = 5
           end
         end
+
+        # Evaluates the given ProcessorVersion against the supplied documents.
+        # @!attribute [rw] processor_version
+        #   @return [::String]
+        #     Required. The resource name of the {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion} to evaluate.
+        #     `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
+        # @!attribute [rw] evaluation_documents
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig]
+        #     Optional. The documents used in the evaluation. If unspecified, use the processor's
+        #     dataset as evaluation input.
+        class EvaluateProcessorVersionRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata of the EvaluateProcessorVersion method.
+        # @!attribute [rw] common_metadata
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
+        #     The basic metadata of the long running operation.
+        class EvaluateProcessorVersionMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata of the EvaluateProcessorVersion method.
+        # @!attribute [rw] evaluation
+        #   @return [::String]
+        #     The resource name of the created evaluation.
+        class EvaluateProcessorVersionResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Retrieves a specific Evaluation.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the {::Google::Cloud::DocumentAI::V1beta3::Evaluation Evaluation} to get.
+        #     `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}`
+        class GetEvaluationRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Retrieves a list of evaluations for a given ProcessorVersion.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion} to list evaluations for.
+        #     `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     The standard list page size.
+        #     If unspecified, at most 5 evaluations will be returned.
+        #     The maximum value is 100; values above 100 will be coerced to 100.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A page token, received from a previous `ListEvaluations` call.
+        #     Provide this to retrieve the subsequent page.
+        class ListEvaluationsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response from ListEvaluations.
+        # @!attribute [rw] evaluations
+        #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Evaluation>]
+        #     The evaluations requested.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token, which can be sent as `page_token` to retrieve the next page.
+        #     If this field is omitted, there are no subsequent pages.
+        class ListEvaluationsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

data/proto_docs/google/cloud/documentai/v1beta3/document_schema.rb

@@ -56,15 +56,16 @@ module Google
           #     Name of the type. It must be unique within the schema file and
           #     cannot be a 'Common Type'.  Besides that we use the following naming
           #     conventions:
-          #     - *use snake_casing*
+          #
+          #     - *use `snake_casing`*
           #     - name matching is case-insensitive
           #     - Maximum 64 characters.
           #     - Must start with a letter.
           #     - Allowed characters: ASCII letters `[a-z0-9_-]`.  (For backward
           #       compatibility internal infrastructure and tooling can handle any ascii
           #       character)
-          #     - The '/' is sometimes used to denote a property of a type.  For example
-          #       line_item/amount.  This convention is deprecated, but will still be
+          #     - The `/` is sometimes used to denote a property of a type.  For example
+          #       `line_item/amount`.  This convention is deprecated, but will still be
           #       honored for backward compatibility.
           # @!attribute [rw] base_types
           #   @return [::Array<::String>]

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

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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 V1beta3
+        # 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::V1beta3::Evaluation::Counters]
+        #     Counters for the documents used in the evaluation.
+        # @!attribute [rw] all_entities_metrics
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::Evaluation::MultiConfidenceMetrics]
+        #     Metrics for all the entities in aggregate.
+        # @!attribute [rw] entity_metrics
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DocumentAI::V1beta3::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::V1beta3::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::V1beta3::Evaluation::ConfidenceLevelMetrics>]
+          #     Metrics across confidence levels with fuzzy matching enabled.
+          # @!attribute [rw] confidence_level_metrics_exact
+          #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::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::V1beta3::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::V1beta3::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/v1beta3/processor.rb

@@ -34,6 +34,9 @@ module Google
         # @!attribute [rw] display_name
         #   @return [::String]
         #     The display name of the processor version.
+        # @!attribute [rw] document_schema
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::DocumentSchema]
+        #     The schema of the processor version. Describes the output.
         # @!attribute [rw] state
         #   @return [::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion::State]
         #     The state of the processor version.
@@ -104,7 +107,7 @@ module Google
         #     Format: `projects/{project}/locations/{location}/processors/{processor}`
         # @!attribute [rw] type
         #   @return [::String]
-        #     The processor type, e.g., OCR_PROCESSOR, INVOICE_PROCESSOR, etc.
+        #     The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc.
         #     To get a list of processors types, see
         #     {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#fetch_processor_types FetchProcessorTypes}.
         # @!attribute [rw] display_name
@@ -143,14 +146,14 @@ module Google
             # The processor is disabled.
             DISABLED = 2
 
-            # The processor is being enabled, will become ENABLED if successful.
+            # The processor is being enabled, will become `ENABLED` if successful.
             ENABLING = 3
 
-            # The processor is being disabled, will become DISABLED if successful.
+            # The processor is being disabled, will become `DISABLED` if successful.
             DISABLING = 4
 
-            # The processor is being created, will become either ENABLED (for
-            # successful creation) or FAILED (for failed ones).
+            # The processor is being created, will become either `ENABLED` (for
+            # successful creation) or `FAILED` (for failed ones).
             # Once a processor is in this state, it can then be used for document
             # processing, but the feature dependencies of the processor might not be
             # fully created yet.

data/proto_docs/google/cloud/documentai/v1beta3/processor_type.rb

@@ -26,10 +26,10 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     The resource name of the processor type.
-        #     Format: projects/\\{project}/processorTypes/\\{processor_type}
+        #     Format: `projects/{project}/processorTypes/{processor_type}`
         # @!attribute [rw] type
         #   @return [::String]
-        #     The type of the processor, e.g., "invoice_parsing".
+        #     The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc.
         # @!attribute [rw] category
         #   @return [::String]
         #     The processor category, used by UI to group processor types.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-document_ai-v1beta3
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-17 00:00:00.000000000 Z
+date: 2022-11-16 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.10'
+        version: '0.12'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.12'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -204,11 +204,13 @@ files:
 - lib/google/cloud/documentai/v1beta3/document_processor_service_pb.rb
 - lib/google/cloud/documentai/v1beta3/document_processor_service_services_pb.rb
 - lib/google/cloud/documentai/v1beta3/document_schema_pb.rb
+- lib/google/cloud/documentai/v1beta3/evaluation_pb.rb
 - lib/google/cloud/documentai/v1beta3/geometry_pb.rb
 - lib/google/cloud/documentai/v1beta3/operation_metadata_pb.rb
 - lib/google/cloud/documentai/v1beta3/processor_pb.rb
 - lib/google/cloud/documentai/v1beta3/processor_type_pb.rb
 - proto_docs/README.md
+- proto_docs/google/api/client.rb
 - proto_docs/google/api/field_behavior.rb
 - proto_docs/google/api/launch_stage.rb
 - proto_docs/google/api/resource.rb
@@ -217,6 +219,7 @@ files:
 - proto_docs/google/cloud/documentai/v1beta3/document_io.rb
 - proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb
 - proto_docs/google/cloud/documentai/v1beta3/document_schema.rb
+- proto_docs/google/cloud/documentai/v1beta3/evaluation.rb
 - proto_docs/google/cloud/documentai/v1beta3/geometry.rb
 - proto_docs/google/cloud/documentai/v1beta3/operation_metadata.rb
 - proto_docs/google/cloud/documentai/v1beta3/processor.rb