Skip to content

Prompt helpers

Provide utilities for formatting structured prompt templates.

This module contains helper functions for working with prompt templates represented as lists of message dictionaries. Its main purpose is to replace placeholder variables in string fields while preserving the original template structure.

format_prompt(prompt_template, args)

Format a prompt template by replacing placeholder variables.

This function creates a deep copy of the input prompt template and replaces placeholders of the form {key} in each string field using the values provided in args. The original template is not modified.

Parameters:

Name Type Description Default
prompt_template List[Dict[str, str]]

A list of message dictionaries representing the prompt template. Each dictionary typically contains fields such as roles and content.

 required
args Dict[str, str]

A mapping of placeholder names to replacement values. Each key is matched against placeholders in the template, and each value is converted to a string before substitution.

 required

Returns:

Type Description
List[Dict[str, str]]

A new prompt template with all matching placeholders replaced by their corresponding values.
Notes

Only string fields are processed for placeholder replacement. Non-string values in the template are left unchanged.

Source code in aatm\prompt_helpers.py 
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
def format_prompt(
    prompt_template: List[Dict[str, str]], args: Dict[str, str]
) -> List[Dict[str, str]]:
    """Format a prompt template by replacing placeholder variables.

    This function creates a deep copy of the input prompt template and replaces
    placeholders of the form ``{key}`` in each string field using the values
    provided in ``args``. The original template is not modified.

    Args:
        prompt_template: A list of message dictionaries representing the prompt
            template. Each dictionary typically contains fields such as roles
            and content.
        args: A mapping of placeholder names to replacement values. Each key is
            matched against placeholders in the template, and each value is
            converted to a string before substitution.

    Returns:
        A new prompt template with all matching placeholders replaced by their corresponding values.

    Notes:
        Only string fields are processed for placeholder replacement. Non-string values in the template are left unchanged.
    """

    prompt = copy.deepcopy(prompt_template)

    for message_id, message in enumerate(prompt):
        for field, text in message.items():
            if isinstance(text, str):
                for key, value in args.items():
                    prompt[message_id][field] = prompt[message_id][field].replace(
                        f"{{{key}}}", str(value)
                    )

    return prompt