langroid 0.33.9__py3-none-any.whl → 0.33.11__py3-none-any.whl

langroid/agent/base.py

@@ -1039,6 +1039,11 @@ class Agent(ABC):
         """
         if msg is None:
             return False
+        if isinstance(msg, ChatDocument):
+            if len(msg.tool_messages) > 0:
+                return True
+            if msg.metadata.sender != Entity.LLM:
+                return False
         try:
             tools = self.get_tool_messages(msg)
             return len(tools) > 0

langroid/agent/chat_agent.py

@@ -539,6 +539,20 @@ class ChatAgent(Agent):
                 self.message_history[i].content = message
                 break
 
+    def delete_last_message(self, role: str = Role.USER) -> None:
+        """
+        Delete the last message that has role `role` from the message history.
+        Args:
+            role (str): role of message to delete
+        """
+        if len(self.message_history) == 0:
+            return
+        # find last message in self.message_history with role `role`
+        for i in range(len(self.message_history) - 1, -1, -1):
+            if self.message_history[i].role == role:
+                self.message_history.pop(i)
+                break
+
     def _create_system_and_tools_message(self) -> LLMMessage:
         """
         (Re-)Create the system message for the LLM of the agent,
@@ -1049,18 +1063,20 @@ class ChatAgent(Agent):
 
         return tools
 
-    def _get_any_tool_message(self, optional: bool = True) -> type[ToolMessage]:
+    def _get_any_tool_message(self, optional: bool = True) -> type[ToolMessage] | None:
         """
         Returns a `ToolMessage` which wraps all enabled tools, excluding those
         where strict recovery is disabled. Used in strict recovery.
         """
-        any_tool_type = Union[  # type: ignore
-            *(
-                self.llm_tools_map[t]
-                for t in self.llm_tools_usable
-                if t not in self.disable_strict_tools_set
-            )
-        ]
+        possible_tools = tuple(
+            self.llm_tools_map[t]
+            for t in self.llm_tools_usable
+            if t not in self.disable_strict_tools_set
+        )
+        if len(possible_tools) == 0:
+            return None
+        any_tool_type = Union.__getitem__(possible_tools)  # type ignore
+
         maybe_optional_type = Optional[any_tool_type] if optional else any_tool_type
 
         class AnyTool(ToolMessage):
@@ -1211,6 +1227,8 @@ class ChatAgent(Agent):
             and self.config.strict_recovery
         ):
             AnyTool = self._get_any_tool_message()
+            if AnyTool is None:
+                return None
             self.set_output_format(
                 AnyTool,
                 force_tools=True,
@@ -1219,15 +1237,25 @@ class ChatAgent(Agent):
                 instructions=True,
             )
             recovery_message = self._strict_recovery_instructions(AnyTool)
+            augmented_message = message
+            if augmented_message is None:
+                augmented_message = recovery_message
+            elif isinstance(augmented_message, str):
+                augmented_message = augmented_message + recovery_message
+            else:
+                augmented_message.content = augmented_message.content + recovery_message
 
+            # only use the augmented message for this one response...
+            result = self.llm_response(augmented_message)
+            # ... restore the original user message so that the AnyTool recover
+            # instructions don't persist in the message history
+            # (this can cause the LLM to use the AnyTool directly as a tool)
             if message is None:
-                message = recovery_message
-            elif isinstance(message, str):
-                message = message + recovery_message
+                self.delete_last_message(role=Role.USER)
             else:
-                message.content = message.content + recovery_message
-
-            return self.llm_response(message)
+                msg = message if isinstance(message, str) else message.content
+                self.update_last_message(msg, role=Role.USER)
+            return result
 
         hist, output_len = self._prep_llm_messages(message)
         if len(hist) == 0:
@@ -1294,15 +1322,25 @@ class ChatAgent(Agent):
                 instructions=True,
             )
             recovery_message = self._strict_recovery_instructions(AnyTool)
+            augmented_message = message
+            if augmented_message is None:
+                augmented_message = recovery_message
+            elif isinstance(augmented_message, str):
+                augmented_message = augmented_message + recovery_message
+            else:
+                augmented_message.content = augmented_message.content + recovery_message
 
+            # only use the augmented message for this one response...
+            result = self.llm_response(augmented_message)
+            # ... restore the original user message so that the AnyTool recover
+            # instructions don't persist in the message history
+            # (this can cause the LLM to use the AnyTool directly as a tool)
             if message is None:
-                message = recovery_message
-            elif isinstance(message, str):
-                message = message + recovery_message
+                self.delete_last_message(role=Role.USER)
             else:
-                message.content = message.content + recovery_message
-
-            return self.llm_response(message)
+                msg = message if isinstance(message, str) else message.content
+                self.update_last_message(msg, role=Role.USER)
+            return result
 
         hist, output_len = self._prep_llm_messages(message)
         if len(hist) == 0:

langroid/agent/special/sql/sql_chat_agent.py

@@ -13,6 +13,7 @@ from typing import Any, Dict, List, Optional, Sequence, Union
 from rich.console import Console
 
 from langroid.exceptions import LangroidImportError
+from langroid.mytypes import Entity
 from langroid.utils.constants import SEND_TO
 
 try:
@@ -43,10 +44,12 @@ from langroid.agent.special.sql.utils.tools import (
     RunQueryTool,
 )
 from langroid.agent.tools.orchestration import (
+    DonePassTool,
     DoneTool,
     ForwardTool,
     PassTool,
 )
+from langroid.language_models.base import Role
 from langroid.vector_store.base import VectorStoreConfig
 
 logger = logging.getLogger(__name__)
@@ -111,6 +114,8 @@ class SQLChatAgentConfig(ChatAgentConfig):
     # as opposed to returning a result from the task.run()
     chat_mode: bool = False
     addressing_prefix: str = ""
+    max_result_rows: int | None = None  # limit query results to this
+    max_retained_tokens: int | None = None  # limit history of query results to this
 
     """
     Optional, but strongly recommended, context descriptions for tables, columns, 
@@ -182,6 +187,7 @@ class SQLChatAgent(ChatAgent):
             self.helper_config = self.config.copy()
             self.helper_config.is_helper = True
             self.helper_config.use_helper = False
+            self.helper_config.chat_mode = False
             self.helper_agent = SQLHelperAgent(self.helper_config)
 
     def _validate_config(self, config: "SQLChatAgentConfig") -> None:
@@ -265,11 +271,13 @@ class SQLChatAgent(ChatAgent):
 
     def _init_tools(self) -> None:
         """Initialize sys msg and tools."""
+        RunQueryTool._max_retained_tokens = self.config.max_retained_tokens
         self.enable_message([RunQueryTool, ForwardTool])
         if self.config.use_schema_tools:
             self._enable_schema_tools()
         if not self.config.chat_mode:
             self.enable_message(DoneTool)
+            self.enable_message(DonePassTool)
 
     def _format_message(self) -> str:
         if self.engine is None:
@@ -312,14 +320,11 @@ class SQLChatAgent(ChatAgent):
         """
         if self.config.chat_mode:
             return f"""
-                you must use the `{ForwardTool.name()}` with the `agent` 
+                you must use the TOOL `{ForwardTool.name()}` with the `agent` 
                 parameter set to "User"
                 """
         else:
-            return f"""
-                you must use the `{DoneTool.name()}` with the `content` 
-                set to the answer or result
-                """
+            return f"you must use the TOOL `{DonePassTool.name()}`"
 
     def _clarifying_message(self) -> str:
         tools_instruction = f"""
@@ -344,23 +349,24 @@ class SQLChatAgent(ChatAgent):
         self, message: str | ChatDocument
     ) -> str | ForwardTool | ChatDocument | None:
         """
-        Handle the scenario where current msg is not a tool.
-        Special handling is only needed if the message was from the LLM
-        (as indicated by self.llm_responded).
+        We'd end up here if the current msg has no tool.
+        If this is from LLM, we may need to handle the scenario where
+        it may have "forgotten" to generate a tool.
         """
-        if not self.llm_responded:
+        if (
+            not isinstance(message, ChatDocument)
+            or message.metadata.sender != Entity.LLM
+        ):
             return None
-        if self.interactive:
-            # self.interactive will be set to True by the Task,
-            # when chat_mode=True, so in this case
-            # we send any Non-tool msg to the user
+        if self.config.chat_mode:
+            # send any Non-tool msg to the user
             return ForwardTool(agent="User")
         # Agent intent not clear => use the helper agent to
         # do what this agent should have done, e.g. generate tool, etc.
         # This is likelier to succeed since this agent has no "baggage" of
         # prior conversation, other than the system msg, and special
         # "Intent-interpretation" instructions.
-        if self._json_schema_available():
+        if self._json_schema_available() and self.config.strict_recovery:
             AnyTool = self._get_any_tool_message(optional=False)
             self.set_output_format(
                 AnyTool,
@@ -372,15 +378,18 @@ class SQLChatAgent(ChatAgent):
             recovery_message = self._strict_recovery_instructions(
                 AnyTool, optional=False
             )
-            return self.llm_response(recovery_message)
-        else:
+            result = self.llm_response(recovery_message)
+            # remove the recovery_message (it has User role) from the chat history,
+            # else it may cause the LLM to directly use the AnyTool.
+            self.delete_last_message(role=Role.USER)  # delete last User-role msg
+            return result
+        elif self.config.use_helper:
             response = self.helper_agent.llm_response(message)
             tools = self.try_get_tool_messages(response)
             if tools:
                 return response
-            else:
-                # fall back on the clarification message
-                return self._clarifying_message()
+        # fall back on the clarification message
+        return self._clarifying_message()
 
     def retry_query(self, e: Exception, query: str) -> str:
         """
@@ -467,6 +476,14 @@ class SQLChatAgent(ChatAgent):
             try:
                 # attempt to fetch results: should work for normal SELECT queries
                 rows = query_result.fetchall()
+                n_rows = len(rows)
+                if self.config.max_result_rows and n_rows > self.config.max_result_rows:
+                    rows = rows[: self.config.max_result_rows]
+                    logger.warning(
+                        f"SQL query produced {n_rows} rows, "
+                        f"limiting to {self.config.max_result_rows}"
+                    )
+
                 response_message = self._format_rows(rows)
             except ResourceClosedError:
                 # If we get here, it's a non-SELECT query (UPDATE, INSERT, DELETE)

langroid/agent/task.py

@@ -1429,8 +1429,15 @@ class Task:
         else:
             response_fn = self._entity_responder_map[cast(Entity, e)]
             result = response_fn(self.pending_message)
-            # update result.tool_messages if any
-            if isinstance(result, ChatDocument):
+            # update result.tool_messages if any.
+            # Do this only if sender is LLM, since this could be
+            # a tool-call result from the Agent responder, which may
+            # contain strings that look like tools, and we don't want to
+            # trigger strict tool recovery due to that.
+            if (
+                isinstance(result, ChatDocument)
+                and result.metadata.sender == Entity.LLM
+            ):
                 self.agent.try_get_tool_messages(result)
 
         result_chat_doc = self.agent.to_ChatDocument(

langroid/agent/tool_message.py

@@ -101,7 +101,7 @@ class ToolMessage(ABC, BaseModel):
     # Some tools can have large results that we may not want to fully retain,
     # e.g. result of a db query, which the LLM later reduces to a summary, so
     # in subsequent dialog we may only want to retain the summary,
-    # and replace this raw result truncated to _max_result_tokens.
+    # and replace this raw result truncated to _max_retained_tokens.
     # Important to note: unlike _max_result_tokens, this param is used
     # NOT used to immediately truncate the result;
     # it is only used to truncate what is retained in msg history AFTER the

langroid/agent/tools/orchestration.py

@@ -156,7 +156,7 @@ class PassTool(ToolMessage):
     def response(self, agent: ChatAgent, chat_doc: ChatDocument) -> ChatDocument:
         """When this tool is enabled for an Agent, this will result in a method
         added to the Agent with signature:
-        `forward_tool(self, tool: PassTool, chat_doc: ChatDocument) -> ChatDocument:`
+        `pass_tool(self, tool: PassTool, chat_doc: ChatDocument) -> ChatDocument:`
         """
         # if PassTool is in chat_doc, pass its parent, else pass chat_doc itself
         doc = chat_doc

{langroid-0.33.9.dist-info → langroid-0.33.11.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: langroid
-Version: 0.33.9
+Version: 0.33.11
 Summary: Harness LLMs with Multi-Agent Programming
 Author-email: Prasad Chalasani <pchalasani@gmail.com>
 License: MIT

{langroid-0.33.9.dist-info → langroid-0.33.11.dist-info}/RECORD

@@ -3,13 +3,13 @@ langroid/exceptions.py,sha256=gp6ku4ZLdXXCUQIwUNVFojJNGTzGnkevi2PLvG7HOhc,2555
 langroid/mytypes.py,sha256=ptAFxEAtiwmIfUnGisNotTe8wT9LKBf22lOfPgZoQIY,2368
 langroid/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 langroid/agent/__init__.py,sha256=ll0Cubd2DZ-fsCMl7e10hf9ZjFGKzphfBco396IKITY,786
-langroid/agent/base.py,sha256=-wColF3AGsbIm-uiTLfu8cyGUqMRCzZETVirvgZgYGQ,77642
+langroid/agent/base.py,sha256=oThlrYygKDu1-bKjAfygldJ511gMKT8Z0qCrD52DdDM,77834
 langroid/agent/batch.py,sha256=qK3ph6VNj_1sOhfXCZY4r6gh035DglDKU751p8BU0tY,14665
-langroid/agent/chat_agent.py,sha256=Idts_HDO1tW052POVOQ9FvuU37TTB7c1I96YVbnBumo,80030
+langroid/agent/chat_agent.py,sha256=cxamUgqQkr6_W3mqCPz3L7rJnXIkD4hemR7X7uhlBvI,82095
 langroid/agent/chat_document.py,sha256=xPUMGzR83rn4iAEXIw2jy5LQ6YJ6Y0TiZ78XRQeDnJQ,17778
 langroid/agent/openai_assistant.py,sha256=JkAcs02bIrgPNVvUWVR06VCthc5-ulla2QMBzux_q6o,34340
-langroid/agent/task.py,sha256=c_Ih0Cc_iiyFKBmKMSdirHcW4RX_35JkCFp05jDAEiM,89994
-langroid/agent/tool_message.py,sha256=HDW_FVQXvZAHI61CtOYNuZet0qlK_WwOnjSYd1g81eo,14742
+langroid/agent/task.py,sha256=XrXUbSoiFasvpIsZPn_cBpdWaTCKljJPRimtLMrSZrs,90347
+langroid/agent/tool_message.py,sha256=BhjP-_TfQ2tgxuY4Yo_JHLOwwt0mJ4BwjPnREvEY4vk,14744
 langroid/agent/xml_tool_message.py,sha256=6SshYZJKIfi4mkE-gIoSwjkEYekQ8GwcSiCv7a5uO9E,15054
 langroid/agent/callbacks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 langroid/agent/callbacks/chainlit.py,sha256=C6zzzYC30qC4eMA7al7eFpRoTgoe3475kaMKyXgQM0Q,20695
@@ -35,7 +35,7 @@ langroid/agent/special/neo4j/neo4j_chat_agent.py,sha256=1RMKupJra0KZ-hA7AiiR662S
 langroid/agent/special/neo4j/system_messages.py,sha256=m2jsVayey6E_88F5B_gW2WbWKBJvIeDUoVCRBbNs97o,4522
 langroid/agent/special/neo4j/tools.py,sha256=Vw3HvtDfG2c4_bUHgt4_ZbJq48lpIQstbjjwhh1BjrQ,905
 langroid/agent/special/sql/__init__.py,sha256=mWfmm1QpXCezpFOS2eI57M0L_Ok3q5_ukG8tXBnBrEA,319
-langroid/agent/special/sql/sql_chat_agent.py,sha256=bHJ2TsZciijOBPXKbKvJvDbdEwCRXOSkaRdMmGW1yr0,24660
+langroid/agent/special/sql/sql_chat_agent.py,sha256=CJ-vQFbtcGhmOM-GBQvG2quUmicXXW0XPK1pj52E-54,25639
 langroid/agent/special/sql/utils/__init__.py,sha256=JFif6CRTrN-bc91uuAI4K9fe2ndIWSNMVxJ0WA68--M,446
 langroid/agent/special/sql/utils/description_extractors.py,sha256=cX8TIpmTPXZXQTMpIi3OUFwFsPywxFFdurpx717Kq0I,6529
 langroid/agent/special/sql/utils/populate_metadata.py,sha256=1J22UsyEPKzwK0XlJZtYn9r6kYc0FXIr8-lZrndYlhc,3131
@@ -46,7 +46,7 @@ langroid/agent/tools/duckduckgo_search_tool.py,sha256=NhsCaGZkdv28nja7yveAhSK_w6
 langroid/agent/tools/file_tools.py,sha256=GjPB5YDILucYapElnvvoYpGJuZQ25ecLs2REv7edPEo,7292
 langroid/agent/tools/google_search_tool.py,sha256=y7b-3FtgXf0lfF4AYxrZ3K5pH2dhidvibUOAGBE--WI,1456
 langroid/agent/tools/metaphor_search_tool.py,sha256=ccyEhkShH5MxW6-sx1n0BLpD_GForQddS_nNvBZ67Ik,2561
-langroid/agent/tools/orchestration.py,sha256=851nZQOE1HpGBwH5om_TNP_qCMxxatXYWFZUrpjSfKk,11421
+langroid/agent/tools/orchestration.py,sha256=EaL_z9dmKuqhhHZEh9N-ieMP-Jr9jGjDprUCHdyldZs,11418
 langroid/agent/tools/recipient_tool.py,sha256=dr0yTxgNEIoxUYxH6TtaExC4G_8WdJ0xGohIa4dFLhY,9808
 langroid/agent/tools/retrieval_tool.py,sha256=zcAV20PP_6VzSd-UE-IJcabaBseFL_QNz59Bnig8-lE,946
 langroid/agent/tools/rewind_tool.py,sha256=XAXL3BpNhCmBGYq_qi_sZfHJuIw7NY2jp4wnojJ7WRs,5606
@@ -121,7 +121,7 @@ langroid/vector_store/lancedb.py,sha256=b3_vWkTjG8mweZ7ZNlUD-NjmQP_rLBZfyKWcxt2v
 langroid/vector_store/meilisearch.py,sha256=6frB7GFWeWmeKzRfLZIvzRjllniZ1cYj3HmhHQICXLs,11663
 langroid/vector_store/momento.py,sha256=UNHGT6jXuQtqY9f6MdqGU14bVnS0zHgIJUa30ULpUJo,10474
 langroid/vector_store/qdrantdb.py,sha256=HRLCt-FG8y4718omwpFaQZnWeYxPj0XCwS4tjokI1sU,18116
-langroid-0.33.9.dist-info/METADATA,sha256=5dBFIEzwzxNpjICkMYzMSUNgGONETNZ-Mb9BWhkQs2s,59015
-langroid-0.33.9.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-langroid-0.33.9.dist-info/licenses/LICENSE,sha256=EgVbvA6VSYgUlvC3RvPKehSg7MFaxWDsFuzLOsPPfJg,1065
-langroid-0.33.9.dist-info/RECORD,,
+langroid-0.33.11.dist-info/METADATA,sha256=A-tOfJCvDuYvM96q3zqx6NnATzEflj7mdfoEX64XV4A,59016
+langroid-0.33.11.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+langroid-0.33.11.dist-info/licenses/LICENSE,sha256=EgVbvA6VSYgUlvC3RvPKehSg7MFaxWDsFuzLOsPPfJg,1065
+langroid-0.33.11.dist-info/RECORD,,