📄 answer_correctness¶

Note

ID: metrics.rag.answer_correctness | Type: MetricPipeline

{
    "main_score": "recall",
    "metric": "metrics.token_overlap",
    "preprocess_steps": [
        {
            "field_to_field": [
                [
                    "ground_truths",
                    "references"
                ]
            ],
            "type": "copy_fields"
        },
        {
            "field_to_field": [
                [
                    "answer",
                    "prediction"
                ]
            ],
            "type": "copy_fields"
        }
    ],
    "type": "metric_pipeline"
}

Explanation about CopyFields¶

Copies values from specified fields to specified fields.

Args (of parent class):
field_to_field (Union[List[List], Dict[str, str]]): A list of lists, where each sublist contains the source field and the destination field, or a dictionary mapping source fields to destination fields.

Examples:
An input instance {“a”: 2, “b”: 3}, when processed by CopyField(field_to_field={“a”: “b”} would yield {“a”: 2, “b”: 2}, and when processed by CopyField(field_to_field={“a”: “c”} would yield {“a”: 2, “b”: 3, “c”: 2}

with field names containing / , we can also copy inside the field: CopyFields(field_to_field={“a/0”: “a”}) would process instance {“a”: [1, 3]} into {“a”: 1}

References: metrics.token_overlap