A programming framework for agentic AI
Improve doc formatting of initiate_chats (#2041)
gagb448736e2ad45
diff --git a/autogen/agentchat/chat.py b/autogen/agentchat/chat.pyindex 6d0704863..885defd54 100644--- a/autogen/agentchat/chat.py+++ b/autogen/agentchat/chat.py@@ -135,20 +135,20 @@ def initiate_chats(chat_queue: List[Dict[str, Any]]) -> List[ChatResult]:"""Initiate a list of chats.Args:- chat_queue (List[Dict]): a list of dictionaries containing the information of the chats.- Each dictionary should contain the input arguments for `ConversableAgent.initiate_chat`.- More specifically, each dictionary could include the following fields:- - "sender": the sender agent.- - "recipient": the recipient agent.- - "clear_history" (bool): whether to clear the chat history with the agent. Default is True.- - "silent" (bool or None): (Experimental) whether to print the messages for this conversation. Default is False.- - "cache" (Cache or None): the cache client to be used for this conversation. Default is None.- - "max_turns" (int or None): the maximum number of turns for the chat. If None, the chat will continue until a termination condition is met. Default is None.- - "summary_method" (str or callable): a string or callable specifying the method to get a summary from the chat. Default is DEFAULT_summary_method, i.e., "last_msg".- - "summary_args" (dict): a dictionary of arguments to be passed to the summary_method. Default is {}.- - "message" (str, callable or None): if None, input() will be called to get the initial message.- - **context: additional context information to be passed to the chat.- - "carryover": It can be used to specify the carryover information to be passed to this chat.+ chat_queue (List[Dict]): a list of dictionaries containing the information about the chats.++ Each dictionary should contain the input arguments for `ConversableAgent.initiate_chat`. For example:+ "sender": the sender agent.+ "recipient": the recipient agent.+ "clear_history" (bool): whether to clear the chat history with the agent. Default is True.+ "silent" (bool or None): (Experimental) whether to print the messages in this conversation. Default is False.+ "cache" (Cache or None): the cache client to use for this conversation. Default is None.+ "max_turns" (int or None): maximum number of turns for the chat. If None, the chat will continue until a termination condition is met. Default is None.+ "summary_method" (str or callable): a string or callable specifying the method to get a summary from the chat. Default is DEFAULT_summary_method, i.e., "last_msg".+ "summary_args" (dict): a dictionary of arguments to be passed to the summary_method. Default is {}.+ "message" (str, callable or None): if None, input() will be called to get the initial message.+ **context: additional context information to be passed to the chat.+ "carryover": It can be used to specify the carryover information to be passed to this chat.If provided, we will combine this carryover with the "message" content when generating the initial chatmessage in `generate_init_message`.