Skip to content

ContextStr

autogen.agentchat.group.context_str.ContextStr #

Bases: BaseModel

A string that requires context variable substitution.

Use the format method to substitute context variables into the string.

template instance-attribute #

template

format #

format(context_variables)

Substitute context variables into the string.

PARAMETER DESCRIPTION
context_variables

The context variables to substitute into the string.

TYPE: ContextVariables

RETURNS DESCRIPTION
Optional[str]

Optional[str]: The formatted string with context variables substituted.
Source code in autogen/agentchat/group/context_str.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
def format(self, context_variables: ContextVariables) -> Optional[str]:
    """Substitute context variables into the string.

    Args:
        context_variables (ContextVariables): The context variables to substitute into the string.

    Returns:
        Optional[str]: The formatted string with context variables substituted.
    """

    context = context_variables.to_dict()

    if not context:
        return self.template

    return self.template.format(**context)