Class swarmauri_core.prompts.ITemplate.ITemplate

swarmauri_core.prompts.ITemplate.ITemplate

Bases: ABC

Interface for template-based prompt generation within the SwarmAURI framework. Defines standard operations and attributes for managing and utilizing templates.

set_template abstractmethod

set_template(template)

Sets or updates the current template string.

PARAMETER	DESCRIPTION
template	The new template string to be used for generating prompts. TYPE: str

Source code in swarmauri_core/prompts/ITemplate.py

@abstractmethod
def set_template(self, template: str) -> None:
    """
    Sets or updates the current template string.

    Args:
        template (str): The new template string to be used for generating prompts.
    """
    pass

set_variables abstractmethod

set_variables(variables={})

Sets or updates the variables to be substituted into the template.

PARAMETER	DESCRIPTION
variables	A dictionary of variables where each key-value pair corresponds to a placeholder name and its replacement value in the template. TYPE: List[Dict[str, str]] DEFAULT: {}

Source code in swarmauri_core/prompts/ITemplate.py

@abstractmethod
def set_variables(
    self, variables: Union[List[Dict[str, Any]], Dict[str, Any]] = {}
) -> None:
    """
    Sets or updates the variables to be substituted into the template.

    Args:
        variables (List[Dict[str, str]]): A dictionary of variables where each key-value
                                    pair corresponds to a placeholder name and its
                                    replacement value in the template.
    """
    pass

generate_prompt abstractmethod

generate_prompt(**kwargs)

Generates a prompt string based on the current template and provided keyword arguments.

PARAMETER	DESCRIPTION
**kwargs dict[str, Any]	Keyword arguments containing variables for template substitution.

RETURNS	DESCRIPTION
str	The generated prompt string with template variables replaced by their corresponding values provided in kwargs. TYPE: str

Source code in swarmauri_core/prompts/ITemplate.py

@abstractmethod
def generate_prompt(self, **kwargs: dict[str, Any]) -> str:
    """
    Generates a prompt string based on the current template and provided keyword arguments.

    Args:
        **kwargs dict[str, Any]: Keyword arguments containing variables for template substitution.

    Returns:
        str: The generated prompt string with template variables replaced by their
             corresponding values provided in `kwargs`.
    """
    pass