Class EvaluationMetricsConfig (0.7.0)

EvaluationMetricsConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Configures the metrics for an evaluation.

Attributes

Name Description
golden_metrics_config google.cloud.ces_v1beta.types.EvaluationMetricsConfig.GoldenMetricsConfig
Optional. Configuration for the golden metrics for the evaluation.
scenario_metrics_config google.cloud.ces_v1beta.types.EvaluationMetricsConfig.ScenarioMetricsConfig
Optional. Configuration for the scenario metrics for the evaluation.

Classes

ComparisonType

ComparisonType(value)

Supported comparison types for checking the agent's response.

ExpectationsMetMetricsConfig

ExpectationsMetMetricsConfig(
    mapping=None, *, ignore_unknown_fields=False, **kwargs
)

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.

GoldenMetricsConfig

GoldenMetricsConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Configuration for the golden metrics for the evaluation.

HallucinationMetricsConfig

HallucinationMetricsConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

ScenarioMetricsConfig

ScenarioMetricsConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Configuration for the scenario metrics for the evaluation.

SemanticSimilarityMetricsConfig

SemanticSimilarityMetricsConfig(
    mapping=None, *, ignore_unknown_fields=False, **kwargs
)

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.

ToolCorrectnessMetricsConfig

ToolCorrectnessMetricsConfig(
    mapping=None, *, ignore_unknown_fields=False, **kwargs
)

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.

UserGoalMetMetricsConfig

UserGoalMetMetricsConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.