Skip to content

HumanEvaluationCustomMetric

Source code in docs_src/capo_bedrock/types/human_evaluation_custom_metric.py
class HumanEvaluationCustomMetric(TypedDict, closed=True):
    name: "capo_bedrock.types.evaluation_metric_name.EvaluationMetricName"
    """<p>The name of the metric. Your human evaluators will see this name in the evaluation UI.</p>"""
    description: NotRequired[
        "capo_bedrock.types.evaluation_metric_description.EvaluationMetricDescription"
    ]
    """<p>An optional description of the metric. Use this parameter to provide more details about the metric.</p>"""
    rating_method: "capo_bedrock.types.evaluation_rating_method.EvaluationRatingMethod"
    """<p>Choose how you want your human workers to evaluation your model. Valid values for rating methods are <code>ThumbsUpDown</code>, <code>IndividualLikertScale</code>,<code>ComparisonLikertScale</code>, <code>ComparisonChoice</code>, and <code>ComparisonRank</code> </p>"""

description instance-attribute

description: NotRequired[EvaluationMetricDescription]

An optional description of the metric. Use this parameter to provide more details about the metric.

name instance-attribute

The name of the metric. Your human evaluators will see this name in the evaluation UI.

rating_method instance-attribute

rating_method: EvaluationRatingMethod

Choose how you want your human workers to evaluation your model. Valid values for rating methods are ThumbsUpDown, IndividualLikertScale,ComparisonLikertScale, ComparisonChoice, and ComparisonRank