A programming framework for agentic AI
Fix bug in async group chat with func/tool call (#1243)
Chi Wangf9c16d26a360
diff --git a/.github/workflows/openai.yml b/.github/workflows/openai.ymlindex de5f74385..83679b58e 100644--- a/.github/workflows/openai.yml+++ b/.github/workflows/openai.yml@@ -62,7 +62,6 @@ jobs:OAI_CONFIG_LIST: ${{ secrets.OAI_CONFIG_LIST }}run: |pip install nbconvert nbformat ipykernel- coverage run -a -m pytest test/agentchat/test_function_call_groupchat.pycoverage run -a -m pytest test/test_notebook.pycoverage xmlcat "$(pwd)/test/executed_openai_notebook_output.txt"diff --git a/autogen/agentchat/groupchat.py b/autogen/agentchat/groupchat.pyindex 98b0a4ec7..9a7c705a5 100644--- a/autogen/agentchat/groupchat.py+++ b/autogen/agentchat/groupchat.py@@ -52,11 +52,15 @@ class GroupChat:"""Reset the group chat."""self.messages.clear()- def append(self, message: Dict):+ def append(self, message: Dict, speaker: Agent):"""Append a message to the group chat.We cast the content to str here so that it can be managed by text-basedmodel."""+ # set the name to speaker's name if the role is not function+ # if the role is tool, it is OK to modify the name+ if message["role"] != "function":+ message["name"] = speaker.namemessage["content"] = content_str(message["content"])self.messages.append(message)@@ -126,13 +130,17 @@ Then select the next role from {[agent.name for agent in agents]} to play. Onlyprint(f"Invalid input. Please enter a number between 1 and {_n_agents}.")return None- def _prepare_and_select_agents(self, last_speaker: Agent) -> Tuple[Optional[Agent], List[Agent]]:+ def _prepare_and_select_agents(+ self, last_speaker: Agent+ ) -> Tuple[Optional[Agent], List[Agent], Optional[List[Dict]]]:if self.speaker_selection_method.lower() not in self._VALID_SPEAKER_SELECTION_METHODS:raise ValueError(f"GroupChat speaker_selection_method is set to '{self.speaker_selection_method}'. "f"It should be one of {self._VALID_SPEAKER_SELECTION_METHODS} (case insensitive). ")+ if not isinstance(self.allow_repeat_speaker, (bool, list)):+ raise ValueError("GroupChat allow_repeat_speaker should be a bool or a list of Agents.")# If provided a list, make sure the agent is in the listallow_repeat_speaker = (self.allow_repeat_speaker@@ -172,12 +180,12 @@ Then select the next role from {[agent.name for agent in agents]} to play. Onlyagents = [agent for agent in self.agents if agent.can_execute_function(funcs)]if len(agents) == 1:# only one agent can execute the function- return agents[0], agents+ return agents[0], agents, Noneelif not agents:# find all the agents with function_mapagents = [agent for agent in self.agents if agent.function_map]if len(agents) == 1:- return agents[0], agents+ return agents[0], agents, Noneelif not agents:raise ValueError(f"No agent can execute the function {', '.join(funcs)}. "@@ -186,6 +194,7 @@ Then select the next role from {[agent.name for agent in agents]} to play. Only# remove the last speaker from the list to avoid selecting the same speaker if allow_repeat_speaker is Falseagents = agents if allow_repeat_speaker else [agent for agent in agents if agent != last_speaker]+ select_speaker_messages = Noneif self.speaker_selection_method.lower() == "manual":selected_agent = self.manual_select_speaker(agents)elif self.speaker_selection_method.lower() == "round_robin":@@ -194,60 +203,38 @@ Then select the next role from {[agent.name for agent in agents]} to play. Onlyselected_agent = random.choice(agents)else:selected_agent = None- return selected_agent, agents+ select_speaker_messages = self.messages.copy()+ # If last message is a tool call or function call, blank the call so the api doesn't throw+ if select_speaker_messages[-1].get("function_call", False):+ select_speaker_messages[-1] = dict(select_speaker_messages[-1], function_call=None)+ if select_speaker_messages[-1].get("tool_calls", False):+ select_speaker_messages[-1] = dict(select_speaker_messages[-1], tool_calls=None)+ select_speaker_messages = select_speaker_messages + [+ {"role": "system", "content": self.select_speaker_prompt(agents)}+ ]+ return selected_agent, agents, select_speaker_messagesdef select_speaker(self, last_speaker: Agent, selector: ConversableAgent):"""Select the next speaker."""- selected_agent, agents = self._prepare_and_select_agents(last_speaker)+ selected_agent, agents, messages = self._prepare_and_select_agents(last_speaker)if selected_agent:return selected_agent# auto speaker selectionselector.update_system_message(self.select_speaker_msg(agents))-- # If last message is a tool call or function call, blank the call so the api doesn't throw- messages = self.messages.copy()- if messages[-1].get("function_call", False):- messages[-1] = dict(messages[-1], function_call=None)- if messages[-1].get("tool_calls", False):- messages[-1] = dict(messages[-1], tool_calls=None)- context = messages + [{"role": "system", "content": self.select_speaker_prompt(agents)}]- final, name = selector.generate_oai_reply(context)-- if not final:- # the LLM client is None, thus no reply is generated. Use round robin instead.- return self.next_agent(last_speaker, agents)-- # If exactly one agent is mentioned, use it. Otherwise, leave the OAI response unmodified- mentions = self._mentioned_agents(name, agents)- if len(mentions) == 1:- name = next(iter(mentions))- else:- logger.warning(- f"GroupChat select_speaker failed to resolve the next speaker's name. This is because the speaker selection OAI call returned:\n{name}"- )-- # Return the result- try:- return self.agent_by_name(name)- except ValueError:- return self.next_agent(last_speaker, agents)+ final, name = selector.generate_oai_reply(messages)+ return self._finalize_speaker(last_speaker, final, name, agents)async def a_select_speaker(self, last_speaker: Agent, selector: ConversableAgent):"""Select the next speaker."""- selected_agent, agents = self._prepare_and_select_agents(last_speaker)+ selected_agent, agents, messages = self._prepare_and_select_agents(last_speaker)if selected_agent:return selected_agent# auto speaker selectionselector.update_system_message(self.select_speaker_msg(agents))- final, name = await selector.a_generate_oai_reply(- self.messages- + [- {- "role": "system",- "content": f"Read the above conversation. Then select the next role from {[agent.name for agent in agents]} to play. Only return the role.",- }- ]- )+ final, name = await selector.a_generate_oai_reply(messages)+ return self._finalize_speaker(last_speaker, final, name, agents)++ def _finalize_speaker(self, last_speaker: Agent, final: bool, name: str, agents: List[Agent]) -> Agent:if not final:# the LLM client is None, thus no reply is generated. Use round robin instead.return self.next_agent(last_speaker, agents)@@ -360,12 +347,7 @@ class GroupChatManager(ConversableAgent):speaker = sendergroupchat = configfor i in range(groupchat.max_round):- # set the name to speaker's name if the role is not function- if message["role"] != "function":- message["name"] = speaker.name-- groupchat.append(message)-+ groupchat.append(message, speaker)if self._is_termination_msg(message):# The conversation is overbreak@@ -395,6 +377,8 @@ class GroupChatManager(ConversableAgent):# The speaker sends the message without requesting a replyspeaker.send(reply, self, request_reply=False)message = self.last_message(speaker)+ if i == groupchat.max_round - 1:+ groupchat.append(message, speaker)return True, Noneasync def a_run_chat(@@ -410,11 +394,7 @@ class GroupChatManager(ConversableAgent):speaker = sendergroupchat = configfor i in range(groupchat.max_round):- # set the name to speaker's name if the role is not function- if message["role"] != "function":- message["name"] = speaker.name-- groupchat.append(message)+ groupchat.append(message, speaker)if self._is_termination_msg(message):# The conversation is overdiff --git a/test/agentchat/test_function_call_groupchat.py b/test/agentchat/test_function_call_groupchat.pyindex cf4b199cd..f6e2f0689 100644--- a/test/agentchat/test_function_call_groupchat.py+++ b/test/agentchat/test_function_call_groupchat.py@@ -4,22 +4,37 @@ import sysimport osfrom test_assistant_agent import KEY_LOC, OAI_CONFIG_LIST-sys.path.append(os.path.join(os.path.dirname(__file__), ".."))-from conftest import skip_openai # noqa: E402-try:from openai import OpenAIexcept ImportError:skip = Trueelse:- skip = False or skip_openai+ sys.path.append(os.path.join(os.path.dirname(__file__), ".."))+ from conftest import skip_openai as skip++func_def = {+ "name": "get_random_number",+ "description": "Get a random number between 0 and 100",+ "parameters": {+ "type": "object",+ "properties": {},+ },+}@pytest.mark.skipif(- skip or not sys.version.startswith("3.10"),- reason="do not run if openai is not installed or py!=3.10",+ skip,+ reason="do not run if openai is not installed or requested to skip",)-def test_function_call_groupchat():+ "key, value, sync",+ [+ ("tools", [{"type": "function", "function": func_def}], False),+ ("functions", [func_def], True),+ ("tools", [{"type": "function", "function": func_def}], True),+ ],+)+def test_function_call_groupchat(key, value, sync):import randomdef get_random_number():@@ -35,29 +50,31 @@ def test_function_call_groupchat():llm_config = {"config_list": config_list_gpt4,"cache_seed": 42,- "functions": [- {- "name": "get_random_number",- "description": "Get a random number between 0 and 100",- "parameters": {- "type": "object",- "properties": {},- },- },- ],+ key: value,}+ # llm_config without functions+ llm_config_no_function = llm_config.copy()+ del llm_config_no_function[key]+user_proxy = autogen.UserProxyAgent(- name="User_proxy",- system_message="A human admin that will execute function_calls.",+ name="Executor",+ description="An executor that will execute function_calls.",function_map={"get_random_number": get_random_number},human_input_mode="NEVER",)- coder = autogen.AssistantAgent(+ player = autogen.AssistantAgent(name="Player",- system_message="You will can function `get_random_number` to get a random number. Stop only when you get at least 1 even number and 1 odd number. Reply TERMINATE to stop.",+ system_message="You will use function `get_random_number` to get a random number. Stop only when you get at least 1 even number and 1 odd number. Reply TERMINATE to stop.",+ description="A player that will make function_calls.",llm_config=llm_config,)- groupchat = autogen.GroupChat(agents=[user_proxy, coder], messages=[], max_round=7)+ observer = autogen.AssistantAgent(+ name="Observer",+ system_message="You observe the conversation between the executor and the player. Summarize the conversation in 1 sentence.",+ description="An observer that will observe the conversation.",+ llm_config=llm_config_no_function,+ )+ groupchat = autogen.GroupChat(agents=[user_proxy, player, observer], messages=[], max_round=7)# pass in llm_config with functionswith pytest.raises(@@ -66,12 +83,12 @@ def test_function_call_groupchat():):manager = autogen.GroupChatManager(groupchat=groupchat, llm_config=llm_config)- # pass in llm_config without functions- llm_config_manager = llm_config.copy()- del llm_config_manager["functions"]- manager = autogen.GroupChatManager(groupchat=groupchat, llm_config=llm_config_manager)+ manager = autogen.GroupChatManager(groupchat=groupchat, llm_config=llm_config_no_function)- user_proxy.initiate_chat(manager, message="Let's start the game!")+ if sync:+ user_proxy.initiate_chat(manager, message="Let's start the game!")+ else:+ user_proxy.a_initiate_chat(manager, message="Let's start the game!")def test_no_function_map():@@ -103,4 +120,4 @@ def test_no_function_map():if __name__ == "__main__":test_function_call_groupchat()- test_no_function_map()+ # test_no_function_map()diff --git a/test/agentchat/test_groupchat.py b/test/agentchat/test_groupchat.pyindex 038f68bf1..1feca2ea0 100644--- a/test/agentchat/test_groupchat.py+++ b/test/agentchat/test_groupchat.py@@ -224,6 +224,35 @@ def _test_n_agents_less_than_3(method):agent1.initiate_chat(group_chat_manager, message="This is alice speaking.")+def test_invalid_allow_repeat_speaker():+ agent1 = autogen.ConversableAgent(+ "alice",+ max_consecutive_auto_reply=10,+ human_input_mode="NEVER",+ llm_config=False,+ default_auto_reply="This is alice speaking.",+ )+ agent2 = autogen.ConversableAgent(+ "bob",+ max_consecutive_auto_reply=10,+ human_input_mode="NEVER",+ llm_config=False,+ default_auto_reply="This is bob speaking.",+ )+ # test invalid allow_repeat_speaker+ groupchat = autogen.GroupChat(+ agents=[agent1, agent2],+ messages=[],+ max_round=6,+ speaker_selection_method="round_robin",+ allow_repeat_speaker={},+ )+ with pytest.raises(ValueError) as e:+ group_chat_manager = autogen.GroupChatManager(groupchat=groupchat, llm_config=False)+ agent1.initiate_chat(group_chat_manager, message="This is alice speaking.")+ assert str(e.value) == "GroupChat allow_repeat_speaker should be a bool or a list of Agents.", e.value++def test_n_agents_less_than_3():for method in ["auto", "round_robin", "random", "RounD_roBin"]:_test_n_agents_less_than_3(method)@@ -480,8 +509,9 @@ if __name__ == "__main__":# test_broadcast()# test_chat_manager()# test_plugin()- test_speaker_selection_method()+ # test_speaker_selection_method()# test_n_agents_less_than_3()# test_agent_mentions()# test_termination()- test_next_agent()+ # test_next_agent()+ test_invalid_allow_repeat_speaker()diff --git a/test/agentchat/test_tool_calls.py b/test/agentchat/test_tool_calls.pyindex ff9668bb9..e9b236e31 100644--- a/test/agentchat/test_tool_calls.py+++ b/test/agentchat/test_tool_calls.py@@ -1,29 +1,26 @@-try:- from openai import OpenAI-except ImportError:- OpenAI = Noneimport inspectimport pytestimport json+import sys+import osimport autogen-from conftest import skip_openaifrom autogen.math_utils import eval_math_responsesfrom test_assistant_agent import KEY_LOC, OAI_CONFIG_LIST-import sysfrom autogen.oai.client import TOOL_ENABLEDtry:from openai import OpenAIexcept ImportError:- skip = True+ skip_openai = Trueelse:- skip = False or skip_openai+ sys.path.append(os.path.join(os.path.dirname(__file__), ".."))+ from conftest import skip_openai@pytest.mark.skipif(skip_openai or not TOOL_ENABLED, reason="openai>=1.1.0 not installed or requested to skip")def test_eval_math_responses():config_list = autogen.config_list_from_models(- KEY_LOC, exclude="aoai", model_list=["gpt-4-0613", "gpt-3.5-turbo-0613", "gpt-3.5-turbo-16k"]+ KEY_LOC, model_list=["gpt-4-0613", "gpt-3.5-turbo-0613", "gpt-3.5-turbo-16k"])tools = [{@@ -80,10 +77,6 @@ def test_eval_math_responses_api_style_function():config_list = autogen.config_list_from_models(KEY_LOC,model_list=["gpt-4-0613", "gpt-3.5-turbo-0613", "gpt-3.5-turbo-16k"],- filter_dict={- "api_type": ["azure"],- "api_version": ["2023-10-01-preview", "2023-09-01-preview", "2023-08-01-preview", "2023-07-01-preview"],- },)functions = [{@@ -286,6 +279,7 @@ def test_multi_tool_call():if __name__ == "__main__":- test_update_tool()- test_eval_math_responses()- test_multi_tool_call()+ # test_update_tool()+ # test_eval_math_responses()+ # test_multi_tool_call()+ test_eval_math_responses_api_style_function()