Skip to content

RandomPattern

autogen.agentchat.group.patterns.random.RandomPattern #

RandomPattern(initial_agent, agents, user_agent=None, group_manager_args=None, context_variables=None, group_after_work=None, exclude_transit_message=True, summary_method='last_msg')

Bases: Pattern

RandomPattern implements a random agent selection process.

Initialize the pattern with the required components.

PARAMETER DESCRIPTION
initial_agent

The first agent to speak in the group chat.

TYPE: ConversableAgent

agents

List of all agents participating in the chat.

TYPE: list[ConversableAgent]

user_agent

Optional user proxy agent.

TYPE: Optional[ConversableAgent] DEFAULT: None

group_manager_args

Optional arguments for the GroupChatManager.

TYPE: Optional[dict[str, Any]] DEFAULT: None

context_variables

Initial context variables for the chat.

TYPE: Optional[ContextVariables] DEFAULT: None

group_after_work

Default after work transition behavior when no specific next agent is determined.

TYPE: Optional[TransitionTarget] DEFAULT: None

exclude_transit_message

Whether to exclude transit messages from the conversation.

TYPE: bool DEFAULT: True

summary_method

Method for summarizing the conversation.

TYPE: Optional[Union[str, Callable[..., Any]]] DEFAULT: 'last_msg'

Source code in autogen/agentchat/group/patterns/pattern.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
def __init__(
    self,
    initial_agent: "ConversableAgent",
    agents: list["ConversableAgent"],
    user_agent: Optional["ConversableAgent"] = None,
    group_manager_args: Optional[dict[str, Any]] = None,
    context_variables: Optional[ContextVariables] = None,
    group_after_work: Optional[TransitionTarget] = None,
    exclude_transit_message: bool = True,
    summary_method: Optional[Union[str, Callable[..., Any]]] = "last_msg",
):
    """Initialize the pattern with the required components.

    Args:
        initial_agent: The first agent to speak in the group chat.
        agents: List of all agents participating in the chat.
        user_agent: Optional user proxy agent.
        group_manager_args: Optional arguments for the GroupChatManager.
        context_variables: Initial context variables for the chat.
        group_after_work: Default after work transition behavior when no specific next agent is determined.
        exclude_transit_message: Whether to exclude transit messages from the conversation.
        summary_method: Method for summarizing the conversation.
    """
    self.initial_agent = initial_agent
    self.agents = agents
    self.user_agent = user_agent
    self.group_manager_args = group_manager_args or {}
    self.context_variables = context_variables or ContextVariables()
    self.group_after_work = group_after_work if group_after_work is not None else TerminateTarget()
    self.exclude_transit_message = exclude_transit_message
    self.summary_method = summary_method

initial_agent instance-attribute #

initial_agent = initial_agent

agents instance-attribute #

agents = agents

user_agent instance-attribute #

user_agent = user_agent

group_manager_args instance-attribute #

group_manager_args = group_manager_args or {}

context_variables instance-attribute #

context_variables = context_variables or ContextVariables()

group_after_work instance-attribute #

group_after_work = group_after_work if group_after_work is not None else TerminateTarget()

exclude_transit_message instance-attribute #

exclude_transit_message = exclude_transit_message

summary_method instance-attribute #

summary_method = summary_method

prepare_group_chat #

prepare_group_chat(max_rounds, messages)

Prepare the group chat for organic agent selection.

Ensures that: 1. The group manager has a valid LLM config 2. All agents have appropriate descriptions for the group manager to use

PARAMETER DESCRIPTION
max_rounds

Maximum number of conversation rounds.

TYPE: int

messages

Initial message(s) to start the conversation.

TYPE: Union[list[dict[str, Any]], str]

RETURNS DESCRIPTION
Tuple[list[ConversableAgent], list[ConversableAgent], Optional[ConversableAgent], ContextVariables, ConversableAgent, TransitionTarget, GroupToolExecutor, GroupChat, GroupChatManager, list[dict[str, Any]], Any, list[str], list[Any]]

Tuple containing all necessary components for the group chat.
Source code in autogen/agentchat/group/patterns/random.py 
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
def prepare_group_chat(
    self,
    max_rounds: int,
    messages: Union[list[dict[str, Any]], str],
) -> Tuple[
    list["ConversableAgent"],
    list["ConversableAgent"],
    Optional["ConversableAgent"],
    ContextVariables,
    "ConversableAgent",
    TransitionTarget,
    "GroupToolExecutor",
    "GroupChat",
    "GroupChatManager",
    list[dict[str, Any]],
    Any,
    list[str],
    list[Any],
]:
    """Prepare the group chat for organic agent selection.

    Ensures that:
    1. The group manager has a valid LLM config
    2. All agents have appropriate descriptions for the group manager to use

    Args:
        max_rounds: Maximum number of conversation rounds.
        messages: Initial message(s) to start the conversation.

    Returns:
        Tuple containing all necessary components for the group chat.
    """
    # Use the parent class's implementation to prepare the agents and group chat
    (
        agents,
        wrapped_agents,
        user_agent,
        context_variables,
        initial_agent,
        group_after_work,
        tool_executor,
        groupchat,
        manager,
        processed_messages,
        last_agent,
        group_agent_names,
        temp_user_list,
    ) = super().prepare_group_chat(
        max_rounds=max_rounds,
        messages=messages,
    )

    # Create the random handoffs between agents
    self._generate_handoffs(initial_agent=initial_agent, agents=agents, user_agent=user_agent)

    # Return all components with our group_after_work
    return (
        agents,
        wrapped_agents,
        user_agent,
        context_variables,
        initial_agent,
        group_after_work,
        tool_executor,
        groupchat,
        manager,
        processed_messages,
        last_agent,
        group_agent_names,
        temp_user_list,
    )

create_default classmethod #

create_default(initial_agent, agents, user_agent=None, group_manager_args=None, context_variables=None, exclude_transit_message=True, summary_method='last_msg')

Create a default pattern with minimal configuration.

This replaces the need for a separate BasePattern class by providing a factory method that creates a simple DefaultPattern instance.

PARAMETER DESCRIPTION
initial_agent

The first agent to speak in the group chat.

TYPE: ConversableAgent

agents

List of all agents participating in the chat.

TYPE: list[ConversableAgent]

user_agent

Optional user proxy agent.

TYPE: Optional[ConversableAgent] DEFAULT: None

group_manager_args

Optional arguments for the GroupChatManager.

TYPE: Optional[dict[str, Any]] DEFAULT: None

context_variables

Initial context variables for the chat.

TYPE: Optional[ContextVariables] DEFAULT: None

exclude_transit_message

Whether to exclude transit messages from the conversation.

TYPE: bool DEFAULT: True

summary_method

Method for summarizing the conversation.

TYPE: Optional[Union[str, Callable[..., Any]]] DEFAULT: 'last_msg'

RETURNS DESCRIPTION
DefaultPattern

A DefaultPattern instance with basic configuration.
Source code in autogen/agentchat/group/patterns/pattern.py 
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
@classmethod
def create_default(
    cls,
    initial_agent: "ConversableAgent",
    agents: list["ConversableAgent"],
    user_agent: Optional["ConversableAgent"] = None,
    group_manager_args: Optional[dict[str, Any]] = None,
    context_variables: Optional[ContextVariables] = None,
    exclude_transit_message: bool = True,
    summary_method: Optional[Union[str, Callable[..., Any]]] = "last_msg",
) -> "DefaultPattern":
    """Create a default pattern with minimal configuration.

    This replaces the need for a separate BasePattern class by providing
    a factory method that creates a simple DefaultPattern instance.

    Args:
        initial_agent: The first agent to speak in the group chat.
        agents: List of all agents participating in the chat.
        user_agent: Optional user proxy agent.
        group_manager_args: Optional arguments for the GroupChatManager.
        context_variables: Initial context variables for the chat.
        exclude_transit_message: Whether to exclude transit messages from the conversation.
        summary_method: Method for summarizing the conversation.

    Returns:
        A DefaultPattern instance with basic configuration.
    """
    return DefaultPattern(
        initial_agent=initial_agent,
        agents=agents,
        user_agent=user_agent,
        group_manager_args=group_manager_args,
        context_variables=context_variables,
        exclude_transit_message=exclude_transit_message,
        summary_method=summary_method,
    )