📄 Mtrag¶

MTRAG: a comprehensive and diverse human-generated multi-turn RAG dataset, accompanied by four document corpora. To the best of our knowledge, MTRAG is the first end-to-end human-generated multi-turn RAG benchmark that reflects real-world properties of multi-turn conversations.

Tags: license:apache-2.0, category:dataset

cards.rag.mtrag

TaskCard(
    loader=LoadJsonFile(
        files={
            "test": "https://raw.githubusercontent.com/IBM/mt-rag-benchmark/refs/heads/main/mtrag-human/generation_tasks/reference+RAG.jsonl",
        },
        lines=True,
        data_classification_policy=[
            "public",
        ],
    ),
    preprocess_steps=[
        FilterByCondition(
            values={
                "Answerability": [
                    [
                    "UNANSWERABLE",
                    ],
                    [
                    "ANSWERABLE",
                    ],
                    [
                    "PARTIAL",
                    ],
                ],
            },
            condition="in",
        ),
        MapInstanceValues(
            mappers={
                "Answerability": {
                    "['UNANSWERABLE']": False,
                    "['ANSWERABLE']": True,
                    "['PARTIAL']": True,
                },
            },
        ),
        Copy(
            field_to_field={
                "targets/*/text": "reference_answers",
                "Answerability": "is_answerable_label",
                "task_id": "question_id",
                "contexts/*/document_id": "reference_context_ids",
                "contexts/*/text": "reference_contexts",
                "input/*/speaker": "roles",
                "input/*/text": "contents",
            },
        ),
        ZipFieldValues(
            fields=[
                "roles",
                "contents",
            ],
            to_field="conversation",
        ),
        Dictify(
            field="conversation",
            with_keys=[
                "role",
                "content",
            ],
            to_field="question",
            process_every_value=True,
        ),
    ],
    task="tasks.rag.end_to_end",
    templates={
        "default": "templates.rag.end_to_end.json_predictions",
    },
)

[source]

from unitxt.collections_operators import Dictify
from unitxt.loaders import LoadJsonFile
from unitxt.operators import Copy, FilterByCondition, MapInstanceValues, ZipFieldValues

Explanation about TaskCard¶

TaskCard delineates the phases in transforming the source dataset into model input, and specifies the metrics for evaluation of model output.

Args:

loader:
specifies the source address and the loading operator that can access that source and transform it into a unitxt multistream.

preprocess_steps:
list of unitxt operators to process the data source into model input.

task:
specifies the fields (of the already (pre)processed instance) making the inputs, the fields making the outputs, and the metrics to be used for evaluating the model output.

templates:
format strings to be applied on the input fields (specified by the task) and the output fields. The template also carries the instructions and the list of postprocessing steps, to be applied to the model output.

Explanation about ZipFieldValues¶

Zips values of multiple fields in a given instance, similar to list(zip(*fields)).

The value in each of the specified ‘fields’ is assumed to be a list. The lists from all ‘fields’ are zipped, and stored into ‘to_field’.

If ‘longest’=False, the length of the zipped result is determined by the shortest input value.

If ‘longest’=True, the length of the zipped result is determined by the longest input, padding shorter inputs with None-s.

Explanation about MapInstanceValues¶

A class used to map instance values into other values.

This class is a type of InstanceOperator, it maps values of instances in a stream using predefined mappers.

Args:

mappers (Dict[str, Dict[str, Any]]):
The mappers to use for mapping instance values. Keys are the names of the fields to undergo mapping, and values are dictionaries that define the mapping from old values to new values. Note that mapped values are defined by their string representation, so mapped values are converted to strings before being looked up in the mappers.

strict (bool):
If True, the mapping is applied strictly. That means if a value does not exist in the mapper, it will raise a KeyError. If False, values that are not present in the mapper are kept as they are.

process_every_value (bool):
If True, all fields to be mapped should be lists, and the mapping is to be applied to their individual elements. If False, mapping is only applied to a field containing a single value.

Examples:
MapInstanceValues(mappers={"a": {"1": "hi", "2": "bye"}}) replaces "1" with "hi" and "2" with "bye" in field "a" in all instances of all streams: instance {"a": 1, "b": 2} becomes {"a": "hi", "b": 2}. Note that the value of "b" remained intact, since field-name "b" does not participate in the mappers, and that 1 was casted to "1" before looked up in the mapper of "a".

MapInstanceValues(mappers={"a": {"1": "hi", "2": "bye"}}, process_every_value=True): Assuming field "a" is a list of values, potentially including "1"-s and "2"-s, this replaces each such "1" with "hi" and "2" – with "bye" in all instances of all streams: instance {"a": ["1", "2"], "b": 2} becomes {"a": ["hi", "bye"], "b": 2}.

MapInstanceValues(mappers={"a": {"1": "hi", "2": "bye"}}, strict=True): To ensure that all values of field "a" are mapped in every instance, use strict=True. Input instance {"a":"3", "b": 2} will raise an exception per the above call, because "3" is not a key in the mapper of "a".

MapInstanceValues(mappers={"a": {str([1,2,3,4]): "All", str([]): "None"}}, strict=True) replaces a list [1,2,3,4] with the string "All" and an empty list by string "None".

Explanation about FilterByCondition¶

Filters a stream, yielding only instances in which the values in required fields follow the required condition operator.

Raises an error if a required field name is missing from the input instance.

Args:
values (Dict[str, Any]): Field names and respective Values that instances must match according the condition, to be included in the output.

condition: the name of the desired condition operator between the specified (sub) field’s value and the provided constant value. Supported conditions are (“gt”, “ge”, “lt”, “le”, “ne”, “eq”, “in”,”not in”)

error_on_filtered_all (bool, optional): If True, raises an error if all instances are filtered out. Defaults to True.

Examples:

FilterByCondition(values = {"a":4}, condition = "gt") will yield only instances where field "a" contains a value > 4

FilterByCondition(values = {"a":4}, condition = "le") will yield only instances where "a"<=4

FilterByCondition(values = {"a":[4,8]}, condition = "in") will yield only instances where "a" is 4 or 8

FilterByCondition(values = {"a":[4,8]}, condition = "not in") will yield only instances where "a" is different from 4 or 8

FilterByCondition(values = {"a/b":[4,8]}, condition = "not in") will yield only instances where "a" is a dict in which key "b" is mapped to a value that is neither 4 nor 8

FilterByCondition(values = {"a[2]":4}, condition = "le") will yield only instances where “a” is a list whose 3-rd element is <= 4

FilterByCondition(values = {"a":False}, condition = "exists") will yield only instances which do not contain a field named "a"

FilterByCondition(values = {"a/b":True}, condition = "exists") will yield only instances which contain a field named "a" whose value is a dict containing, in turn, a field named "b"

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 LoadJsonFile¶

Loads data from JSON files.

Supports streaming and can handle large files by loading them in chunks.
Args:
files (Dict[str, str]): A dictionary mapping names to file paths. chunksize : Size of the chunks to load at a time. loader_limit: Optional integer to specify a limit on the number of records to load. streaming: Bool indicating if streaming should be used. lines: Bool indicate if it is json lines file structure. Otherwise, assumes a single json object in the file. data_field: optional field within the json object, that contains the list of instances.

Example:
Loading json lines
load_csv = LoadJsonFile(files={'train': 'path/to/train.jsonl'}, line=True, chunksize=100)

References: templates.rag.end_to_end.json_predictions, tasks.rag.end_to_end