Skip to content

Mixin

PromptMixin

Mixin class for classes that have prompts. eg: BaseSynthesizer, MetricWithLLM

get_prompts 

get_prompts() -> Dict[str, PydanticPrompt]

Returns a dictionary of prompts for the class.

Source code in src/ragas/prompt/mixin.py 
24
25
26
27
28
29
30
31
32
def get_prompts(self) -> t.Dict[str, PydanticPrompt]:
    """
    Returns a dictionary of prompts for the class.
    """
    prompts = {}
    for name, value in inspect.getmembers(self):
        if isinstance(value, PydanticPrompt):
            prompts.update({name: value})
    return prompts

set_prompts 

set_prompts(**prompts)

Sets the prompts for the class.

Raises:

Type Description
ValueError

If the prompt is not an instance of PydanticPrompt.
Source code in src/ragas/prompt/mixin.py 
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
def set_prompts(self, **prompts):
    """
    Sets the prompts for the class.

    Raises
    ------
    ValueError
        If the prompt is not an instance of `PydanticPrompt`.
    """
    available_prompts = self.get_prompts()
    for key, value in prompts.items():
        if key not in available_prompts:
            raise ValueError(
                f"Prompt with name '{key}' does not exist. Use get_prompts() to see available prompts."
            )
        if not isinstance(value, PydanticPrompt):
            raise ValueError(
                f"Prompt with name '{key}' must be an instance of 'ragas.prompt.PydanticPrompt'"
            )
        setattr(self, key, value)

adapt_prompts async 

adapt_prompts(
    language: str, llm: BaseRagasLLM
) -> Dict[str, PydanticPrompt]

Adapts the prompts in the class to the given language and using the given LLM.

Notes

Make sure you use the best available LLM for adapting the prompts and then save and load the prompts using save_prompts and load_prompts methods.

Source code in src/ragas/prompt/mixin.py 
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
async def adapt_prompts(
    self, language: str, llm: BaseRagasLLM
) -> t.Dict[str, PydanticPrompt]:
    """
    Adapts the prompts in the class to the given language and using the given LLM.

    Notes
    -----
    Make sure you use the best available LLM for adapting the prompts and then save and load the prompts using
    [save_prompts][ragas.prompt.mixin.PromptMixin.save_prompts] and [load_prompts][ragas.prompt.mixin.PromptMixin.load_prompts]
    methods.
    """
    prompts = self.get_prompts()
    adapted_prompts = {}
    for name, prompt in prompts.items():
        adapted_prompt = await prompt.adapt(language, llm)
        adapted_prompts[name] = adapted_prompt

    return adapted_prompts

save_prompts 

save_prompts(path: str)

Saves the prompts to a directory in the format of {name}_{language}.json

Source code in src/ragas/prompt/mixin.py 
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
def save_prompts(self, path: str):
    """
    Saves the prompts to a directory in the format of {name}_{language}.json
    """
    # check if path is valid
    if not os.path.exists(path):
        raise ValueError(f"Path {path} does not exist")

    prompts = self.get_prompts()
    for prompt_name, prompt in prompts.items():
        # hash_hex = f"0x{hash(prompt) & 0xFFFFFFFFFFFFFFFF:016x}"
        prompt_file_name = os.path.join(
            path, f"{prompt_name}_{prompt.language}.json"
        )
        prompt.save(prompt_file_name)

load_prompts 

load_prompts(path: str, language: Optional[str] = None)

Loads the prompts from a path. File should be in the format of {name}_{language}.json

Source code in src/ragas/prompt/mixin.py 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
def load_prompts(self, path: str, language: t.Optional[str] = None):
    """
    Loads the prompts from a path. File should be in the format of {name}_{language}.json
    """
    # check if path is valid
    if not os.path.exists(path):
        raise ValueError(f"Path {path} does not exist")

    # check if language is supported, defaults to english
    if language is None:
        language = "english"
        logger.info(
            "Language not specified, loading prompts for default language: %s",
            language,
        )
    _check_if_language_is_supported(language)

    loaded_prompts = {}
    for prompt_name, prompt in self.get_prompts().items():
        prompt_file_name = os.path.join(path, f"{prompt_name}_{language}.json")
        loaded_prompt = prompt.__class__.load(prompt_file_name)
        loaded_prompts[prompt_name] = loaded_prompt
    return loaded_prompts