# run_swarm ## `autogen.run_swarm` ```python run_swarm(initial_agent, messages, agents, user_agent=None, swarm_manager_args=None, max_rounds=20, context_variables=None, after_work=TERMINATE, exclude_transit_message=True) ``` Source code in `autogen/agentchat/contrib/swarm_agent.py` | | | | --- | --- | | ```
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
``` | ```
@export_module("autogen")
def run_swarm(
initial_agent: ConversableAgent,
messages: Union[list[dict[str, Any]], str],
agents: list[ConversableAgent],
user_agent: Optional[UserProxyAgent] = None,
swarm_manager_args: Optional[dict[str, Any]] = None,
max_rounds: int = 20,
context_variables: Optional[ContextVariables] = None,
after_work: Optional[
Union[
AfterWorkOption,
Callable[
[ConversableAgent, list[dict[str, Any]], GroupChat], Union[AfterWorkOption, ConversableAgent, str]
],
]
] = AfterWorkOption.TERMINATE,
exclude_transit_message: bool = True,
) -> RunResponseProtocol:
iostream = ThreadIOStream()
response = RunResponse(iostream)
def stream_run(
iostream: ThreadIOStream = iostream,
response: RunResponse = response,
) -> None:
with IOStream.set_default(iostream):
try:
chat_result, returned_context_variables, last_speaker = initiate_swarm_chat(
initial_agent=initial_agent,
messages=messages,
agents=agents,
user_agent=user_agent,
swarm_manager_args=swarm_manager_args,
max_rounds=max_rounds,
context_variables=context_variables,
after_work=after_work,
exclude_transit_message=exclude_transit_message,
)
IOStream.get_default().send(
RunCompletionEvent( # type: ignore[call-arg]
history=chat_result.chat_history,
summary=chat_result.summary,
cost=chat_result.cost,
last_speaker=last_speaker.name,
context_variables=returned_context_variables,
)
)
except Exception as e:
response.iostream.send(ErrorEvent(error=e)) # type: ignore[call-arg]
threading.Thread(
target=stream_run,
).start()
return response
``` Back to top