Skip to content

PromptTemplate

This module defines the PromptTemplate class which is used for generating prompts with variable values.

PromptTemplate

A class for generating prompts with variables.

Parameters:

Name Type Description Default
prompt str

The prompt string with variables.

 required

Attributes:

Name Type Description
prompt str

The prompt string with variables.
variables List[str]

A list of variable names in the prompt string.
Source code in llmflows/prompts/prompt_template.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
class PromptTemplate:
    """
    A class for generating prompts with variables.

    Args:
        prompt (str): The prompt string with variables.

    Attributes:
        prompt (str): The prompt string with variables.
        variables (List[str]): A list of variable names in the prompt string.
    """

    def __init__(self, prompt: str):
        self.prompt = prompt
        self.variables = {
            fn for _, fn, _, _ in Formatter().parse(self.prompt) if fn is not None
        }

    def get_prompt(self, **kwargs: str) -> str:
        """
        Returns the prompt string with variables replaced by the provided values.

        Args:
            **kwargs: A dictionary of variable names and their values.

        Returns:
            The prompt string with variables replaced by the provided values.

        Raises:
            ValueError: If the provided variables do not match the defined ones.
        """
        if not self.variables:
            return self.prompt

        if set(kwargs.keys()) != self.variables:
            raise ValueError("The provided variables do not match the defined ones.")

        return self.prompt.format(**kwargs)

get_prompt(**kwargs)

Returns the prompt string with variables replaced by the provided values.

Parameters:

Name Type Description Default
**kwargs str

A dictionary of variable names and their values.

 {}

Returns:

Type Description
str

The prompt string with variables replaced by the provided values.

Raises:

Type Description
ValueError

If the provided variables do not match the defined ones.
Source code in llmflows/prompts/prompt_template.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
def get_prompt(self, **kwargs: str) -> str:
    """
    Returns the prompt string with variables replaced by the provided values.

    Args:
        **kwargs: A dictionary of variable names and their values.

    Returns:
        The prompt string with variables replaced by the provided values.

    Raises:
        ValueError: If the provided variables do not match the defined ones.
    """
    if not self.variables:
        return self.prompt

    if set(kwargs.keys()) != self.variables:
        raise ValueError("The provided variables do not match the defined ones.")

    return self.prompt.format(**kwargs)