模式

TestsetSample

Bases: BaseModel

Represents a sample in a test set.

Attributes:

Name	Type	Description
`eval_sample`	`Union[SingleTurnSample, MultiTurnSample]`	The evaluation sample, which can be either a single-turn or multi-turn sample.
`synthesizer_name`	`str`	The name of the synthesizer used to generate this sample.

Testset

Bases: BaseModel

Represents a test set containing multiple test samples.

Attributes:

Name	Type	Description
`samples`	`List[TestsetSample]`	A list of TestsetSample objects representing the samples in the test set.

to_evaluation_dataset

to_evaluation_dataset() -> EvaluationDataset

Converts the Testset to an EvaluationDataset.

Source code in src/ragas/testset/synthesizers/testset_schema.py

def to_evaluation_dataset(self) -> EvaluationDataset:
    """
    Converts the Testset to an EvaluationDataset.
    """
    return EvaluationDataset(
        samples=[sample.eval_sample for sample in self.samples]
    )

to_pandas

to_pandas() -> DataFrame

Converts the Testset to a Pandas DataFrame.

Source code in src/ragas/testset/synthesizers/testset_schema.py

def to_pandas(self) -> PandasDataframe:
    """
    Converts the Testset to a Pandas DataFrame.
    """
    import pandas as pd

    return pd.DataFrame(self._to_list())

to_hf_dataset

to_hf_dataset() -> Dataset

Converts the Testset to a Hugging Face Dataset.

Raises:

Type	Description
`ImportError`	If the 'datasets' library is not installed.

Source code in src/ragas/testset/synthesizers/testset_schema.py

def to_hf_dataset(self) -> HFDataset:
    """
    Converts the Testset to a Hugging Face Dataset.

    Raises
    ------
    ImportError
        If the 'datasets' library is not installed.
    """
    try:
        from datasets import Dataset as HFDataset
    except ImportError:
        raise ImportError(
            "datasets is not installed. Please install it to use this function."
        )

    return HFDataset.from_list(self._to_list())

QueryLength

Bases: str, Enum

Enumeration of query lengths. Available options are: LONG, MEDIUM, SHORT

QueryStyle

Bases: str, Enum

Enumeration of query styles. Available options are: MISSPELLED, PERFECT_GRAMMAR, POOR_GRAMMAR, WEB_SEARCH_LIKE

BaseScenario

Bases: BaseModel

Base class for representing a scenario for generating test samples.

Attributes:

Name	Type	Description
`nodes`	`List[Node]`	List of nodes involved in the scenario.
`style`	`QueryStyle`	The style of the query.
`length`	`QueryLength`	The length of the query.

SpecificQueryScenario

Bases: BaseScenario

Represents a scenario for generating specific queries. Also inherits attributes from BaseScenario.

Attributes:

Name	Type	Description
`keyphrase`	`str`	The keyphrase of the specific query scenario.

AbstractQueryScenario

Bases: BaseScenario

Represents a scenario for generating abstract queries. Also inherits attributes from BaseScenario.

Attributes:

Name	Type	Description
`theme`	`str`	The theme of the abstract query scenario.