google-cloud-ces-v1beta 0.a → 0.2.0

data/proto_docs/google/cloud/ces/v1beta/evaluation_metrics_config.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+# Copyright 2026 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 Ces
+      module V1beta
+        # Configures the metrics for an evaluation.
+        # @!attribute [rw] golden_metrics_config
+        #   @return [::Google::Cloud::Ces::V1beta::EvaluationMetricsConfig::GoldenMetricsConfig]
+        #     Optional. Configuration for the golden metrics for the evaluation.
+        # @!attribute [rw] scenario_metrics_config
+        #   @return [::Google::Cloud::Ces::V1beta::EvaluationMetricsConfig::ScenarioMetricsConfig]
+        #     Optional. Configuration for the scenario metrics for the evaluation.
+        class EvaluationMetricsConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Configuration for similarity metrics for the evaluation.
+          # To disable the metric, set the message but do not set the
+          # `enable_semantic_similarity_metrics` field to true (or explicitly set it to
+          # false). To unset the configuration and fallback to the default behavior,
+          # omit the message entirely.
+          # @!attribute [rw] enable_semantic_similarity_metrics
+          #   @return [::Boolean]
+          #     Optional. Whether to calculate semantic similarity metrics for the
+          #     evaluation.
+          class SemanticSimilarityMetricsConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Configuration for correctness metrics for the evaluation.
+          # To disable the metric, set the message but do not set the
+          # `enable_tool_correctness_metrics` field to true (or explicitly set it to
+          # false). To unset the configuration and fallback to the default behavior,
+          # omit the message entirely.
+          # @!attribute [rw] enable_tool_correctness_metrics
+          #   @return [::Boolean]
+          #     Optional. Whether to calculate tool correctness metrics for the
+          #     evaluation.
+          class ToolCorrectnessMetricsConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Configuration for the hallucination metrics for the evaluation.
+          # To disable the metric, set the message but do not set the
+          # `enable_hallucination_metrics` field to true (or explicitly set it to
+          # false). To unset the configuration and fallback to the default behavior,
+          # omit the message entirely.
+          # @!attribute [rw] enable_hallucination_metrics
+          #   @return [::Boolean]
+          #     Optional. Whether to calculate hallucination metrics for the evaluation.
+          class HallucinationMetricsConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Configuration for the user goal met metrics for the evaluation.
+          # To disable the metric, set the message but do not set the
+          # `enable_user_goal_met_metrics` field to true (or explicitly set it to
+          # false). To unset the configuration and fallback to the default behavior,
+          # omit the message entirely.
+          # @!attribute [rw] enable_user_goal_met_metrics
+          #   @return [::Boolean]
+          #     Optional. Whether to calculate the user goal met metrics for the
+          #     evaluation.
+          class UserGoalMetMetricsConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Configuration for the expectation level metrics for the evaluation.
+          # To disable the metric, set the message but do not set the
+          # `enable_expectations_met_metrics` field to true (or explicitly set it to
+          # false). To unset the configuration and fallback to the default behavior,
+          # omit the message entirely.
+          # @!attribute [rw] enable_expectations_met_metrics
+          #   @return [::Boolean]
+          #     Optional. Whether to calculate the expectation level metrics for the
+          #     evaluation.
+          class ExpectationsMetMetricsConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Configuration for the golden metrics for the evaluation.
+          # @!attribute [rw] semantic_similarity_metrics_config
+          #   @return [::Google::Cloud::Ces::V1beta::EvaluationMetricsConfig::SemanticSimilarityMetricsConfig]
+          #     Optional. Global configuration for semantic similarity metrics.
+          # @!attribute [rw] tool_correctness_metrics_config
+          #   @return [::Google::Cloud::Ces::V1beta::EvaluationMetricsConfig::ToolCorrectnessMetricsConfig]
+          #     Optional. Configuration for turn level tool correctness metrics.
+          # @!attribute [rw] step_tool_correctness_metrics_config
+          #   @return [::Google::Cloud::Ces::V1beta::EvaluationMetricsConfig::ToolCorrectnessMetricsConfig]
+          #     Optional. Configuration for step level tool correctness metrics.
+          class GoldenMetricsConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Configuration for the scenario metrics for the evaluation.
+          # @!attribute [rw] user_goal_met_metrics_config
+          #   @return [::Google::Cloud::Ces::V1beta::EvaluationMetricsConfig::UserGoalMetMetricsConfig]
+          #     Optional. Configuration for user goal met metrics.
+          # @!attribute [rw] expectations_met_metrics_config
+          #   @return [::Google::Cloud::Ces::V1beta::EvaluationMetricsConfig::ExpectationsMetMetricsConfig]
+          #     Optional. Configuration for expectation level metrics.
+          class ScenarioMetricsConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Supported comparison types for checking the agent's response.
+          module ComparisonType
+            # Unspecified comparison type. Behavior defaults to SEMANTIC_SIMILARITY
+            # for agent responses and tool calls.
+            COMPARISON_TYPE_UNSPECIFIED = 0
+
+            # Exact string match.
+            EQUALS = 1
+
+            # Substring match (checks if the expected string is contained in the
+            # actual response).
+            CONTAINS = 2
+
+            # Semantic similarity match (evaluates meaning similarity using an LLM).
+            SEMANTIC_SIMILARITY = 3
+          end
+        end
+      end
+    end
+  end
+end