initiate_chats - AG2

initiate_chats

``autogen.initiate_chats #

initiate_chats(chat_queue)

Initiate a list of chats.

PARAMETER DESCRIPTION

chat_queue 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 chat message in `generate_init_message`. - "finished_chat_indexes_to_exclude_from_carryover" - It can be used by specifying a list of indexes of the finished_chats list, from which to exclude the summaries for carryover. If 'finished_chat_indexes_to_exclude_from_carryover' is not provided or an empty list, then summary from all the finished chats will be taken. 
TYPE:List[Dict]

PARAMETER	DESCRIPTION
`chat_queue`	A list of dictionaries containing the information about the chats. Each dictionary should contain the input arguments for `ConversableAgent.initiate_chat`. For example: <br>- "sender" - the sender agent.<br>- "recipient" - the recipient agent.<br>- "clear_history" (bool) - whether to clear the chat history with the agent.<br> Default is True.<br>- "silent" (bool or None) - (Experimental) whether to print the messages in this<br> conversation. Default is False.<br>- "cache" (Cache or None) - the cache client to use for this conversation.<br> Default is None.<br>- "max_turns" (int or None) - maximum number of turns for the chat. If None, the chat<br> will continue until a termination condition is met. Default is None.<br>- "summary_method" (str or callable) - a string or callable specifying the method to get<br> a summary from the chat. Default is DEFAULT_summary_method, i.e., "last_msg".<br>- "summary_args" (dict) - a dictionary of arguments to be passed to the summary_method.<br> Default is {}.<br>- "message" (str, callable or None) - if None, input() will be called to get the<br> initial message.<br>- context - additional context information to be passed to the chat.<br>- "carryover" - It can be used to specify the carryover information to be passed<br> to this chat. If provided, we will combine this carryover with the "message" content when<br> generating the initial chat message in `generate_init_message`.<br>- "finished_chat_indexes_to_exclude_from_carryover" - It can be used by specifying a list of indexes of the finished_chats list,<br> from which to exclude the summaries for carryover. If 'finished_chat_indexes_to_exclude_from_carryover' is not provided or an empty list,<br> then summary from all the finished chats will be taken.<br> TYPE:`List[Dict]`

RETURNS	DESCRIPTION
`list`	a list of ChatResult objects corresponding to the finished chats in the chat_queue.

Source code in autogen/agentchat/chat.py

 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 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 213 214 215  @export_module("autogen") 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 about the chats.\n Each dictionary should contain the input arguments for [`ConversableAgent.initiate_chat`](ConversableAgent.md#autogen.ConversableAgent.initiate_chat).\n For example:\n - "sender" - the sender agent.\n - "recipient" - the recipient agent.\n - "clear_history" (bool) - whether to clear the chat history with the agent.\n Default is True.\n - "silent" (bool or None) - (Experimental) whether to print the messages in this\n conversation. Default is False.\n - "cache" (Cache or None) - the cache client to use for this conversation.\n Default is None.\n - "max_turns" (int or None) - maximum number of turns for the chat. If None, the chat\n will continue until a termination condition is met. Default is None.\n - "summary_method" (str or callable) - a string or callable specifying the method to get\n> a summary from the chat. Default is DEFAULT_summary_method, i.e., "last_msg".\n - "summary_args" (dict) - a dictionary of arguments to be passed to the summary_method.\n Default is {}.\n - "message" (str, callable or None) - if None, input() will be called to get the\n> initial message.\n - **context** - additional context information to be passed to the chat.\n - "carryover" - It can be used to specify the carryover information to be passed\n> to this chat. If provided, we will combine this carryover with the "message" content when\n> generating the initial chat message in `generate_init_message`.\n - "finished_chat_indexes_to_exclude_from_carryover" - It can be used by specifying a list of indexes of the finished_chats list,\n from which to exclude the summaries for carryover. If 'finished_chat_indexes_to_exclude_from_carryover' is not provided or an empty list,\n then summary from all the finished chats will be taken.\n Returns: (list): a list of ChatResult objects corresponding to the finished chats in the chat_queue.\n """ consolidate_chat_info(chat_queue) _validate_recipients(chat_queue) current_chat_queue = chat_queue.copy() finished_chats = [] while current_chat_queue: chat_info = current_chat_queue.pop(0) _chat_carryover = chat_info.get("carryover", []) finished_chat_indexes_to_exclude_from_carryover = chat_info.get( "finished_chat_indexes_to_exclude_from_carryover", [] ) if isinstance(_chat_carryover, str): _chat_carryover = [_chat_carryover] chat_info["carryover"] = _chat_carryover + [ r.summary for i, r in enumerate(finished_chats) if i not in finished_chat_indexes_to_exclude_from_carryover ] if not chat_info.get("silent", False): __post_carryover_processing(chat_info) sender = chat_info["sender"] chat_res = sender.initiate_chat(**chat_info) finished_chats.append(chat_res) return finished_chats


`<br>156<br>157<br>158<br>159<br>160<br>161<br>162<br>163<br>164<br>165<br>166<br>167<br>168<br>169<br>170<br>171<br>172<br>173<br>174<br>175<br>176<br>177<br>178<br>179<br>180<br>181<br>182<br>183<br>184<br>185<br>186<br>187<br>188<br>189<br>190<br>191<br>192<br>193<br>194<br>195<br>196<br>197<br>198<br>199<br>200<br>201<br>202<br>203<br>204<br>205<br>206<br>207<br>208<br>209<br>210<br>211<br>212<br>213<br>214<br>215<br>`	<br>@export_module("autogen")<br>def initiate_chats(chat_queue: list[dict[str, Any]]) -> list[ChatResult]:<br> """Initiate a list of chats.<br> Args:<br> chat_queue (List[Dict]): A list of dictionaries containing the information about the chats.\n<br> Each dictionary should contain the input arguments for<br> [`ConversableAgent.initiate_chat`](ConversableAgent.md#autogen.ConversableAgent.initiate_chat).\n<br> For example:\n<br> - "sender" - the sender agent.\n<br> - "recipient" - the recipient agent.\n<br> - "clear_history" (bool) - whether to clear the chat history with the agent.\n<br> Default is True.\n<br> - "silent" (bool or None) - (Experimental) whether to print the messages in this\n<br> conversation. Default is False.\n<br> - "cache" (Cache or None) - the cache client to use for this conversation.\n<br> Default is None.\n<br> - "max_turns" (int or None) - maximum number of turns for the chat. If None, the chat\n<br> will continue until a termination condition is met. Default is None.\n<br> - "summary_method" (str or callable) - a string or callable specifying the method to get\n> a summary from the chat. Default is DEFAULT_summary_method, i.e., "last_msg".\n<br> - "summary_args" (dict) - a dictionary of arguments to be passed to the summary_method.\n<br> Default is {}.\n<br> - "message" (str, callable or None) - if None, input() will be called to get the\n> initial message.\n<br> - context - additional context information to be passed to the chat.\n<br> - "carryover" - It can be used to specify the carryover information to be passed\n> to this chat. If provided, we will combine this carryover with the "message" content when\n> generating the initial chat message in `generate_init_message`.\n<br> - "finished_chat_indexes_to_exclude_from_carryover" - It can be used by specifying a list of indexes of the finished_chats list,\n<br> from which to exclude the summaries for carryover. If 'finished_chat_indexes_to_exclude_from_carryover' is not provided or an empty list,\n<br> then summary from all the finished chats will be taken.\n<br> Returns:<br> (list): a list of ChatResult objects corresponding to the finished chats in the chat_queue.\n<br> """<br> consolidate_chat_info(chat_queue)<br> _validate_recipients(chat_queue)<br> current_chat_queue = chat_queue.copy()<br> finished_chats = []<br> while current_chat_queue:<br> chat_info = current_chat_queue.pop(0)<br> _chat_carryover = chat_info.get("carryover", [])<br> finished_chat_indexes_to_exclude_from_carryover = chat_info.get(<br> "finished_chat_indexes_to_exclude_from_carryover", []<br> )<br> if isinstance(_chat_carryover, str):<br> _chat_carryover = [_chat_carryover]<br> chat_info["carryover"] = _chat_carryover + [<br> r.summary for i, r in enumerate(finished_chats) if i not in finished_chat_indexes_to_exclude_from_carryover<br> ]<br> if not chat_info.get("silent", False):<br> __post_carryover_processing(chat_info)<br> sender = chat_info["sender"]<br> chat_res = sender.initiate_chat(**chat_info)<br> finished_chats.append(chat_res)<br> return finished_chats<br>