📄 Token Recall [deprecated]¶

Deprecation message: This metric should be replaced with metrics.rag.external_rag.answer_relevance.token_recall

metrics.rag.answer_relevance.token_recall

type: MetricPipeline
main_score: recall
preprocess_steps: 
  - type: Copy
    field_to_field: 
      task_data/question: references
      answer: prediction
    not_exist_do_nothing: True
  - type: Copy
    field_to_field: 
      question: references
    not_exist_do_nothing: True
  - type: MultiTypeSerializer
    field: references
  - type: ListFieldValues
    fields: 
      - references
    to_field: references
metric: metrics.token_overlap
[source]

Explanation about Copy¶

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 Copy(field_to_field={"a": "b"}) would yield {“a”: 2, “b”: 2}, and when processed by Copy(field_to_field={"a": "c"}) would yield {“a”: 2, “b”: 3, “c”: 2}

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

Explanation about ListFieldValues¶

Concatenates values of multiple fields into a list, and assigns it to a new field.

References: metrics.token_overlap