langroid 0.22.3__py3-none-any.whl → 0.22.5__py3-none-any.whl

langroid/agent/base.py

@@ -142,7 +142,7 @@ class Agent(ABC):
         self.llm_tools_handled: Set[str] = set()
         self.llm_tools_usable: Set[str] = set()
         self.llm_tools_known: Set[str] = set()  # all known tools, handled/used or not
-        self.interactive: bool | None = None
+        self.interactive: bool = True  # may be modified by Task wrapper
         self.token_stats_str = ""
         self.default_human_response: Optional[str] = None
         self._indent = ""
@@ -645,10 +645,11 @@ class Agent(ABC):
         need_human_response = (
             isinstance(msg, ChatDocument) and msg.metadata.recipient == Entity.USER
         )
+        default_user_msg = (
+            (self.default_human_response or "null") if need_human_response else ""
+        )
 
-        interactive = self.interactive or settings.interactive
-
-        if not interactive and not need_human_response:
+        if not self.interactive and not need_human_response:
             return None
         elif self.default_human_response is not None:
             user_msg = self.default_human_response
@@ -669,6 +670,8 @@ class Agent(ABC):
         tool_ids = []
         if msg is not None and isinstance(msg, ChatDocument):
             tool_ids = msg.metadata.tool_ids
+
+        user_msg = user_msg.strip() or default_user_msg.strip()
         # only return non-None result if user_msg not empty
         if not user_msg:
             return None

langroid/agent/special/sql/sql_chat_agent.py

@@ -10,11 +10,10 @@ Functionality includes:
 import logging
 from typing import Any, Dict, List, Optional, Sequence, Union
 
-from rich import print
 from rich.console import Console
 
 from langroid.exceptions import LangroidImportError
-from langroid.utils.constants import DONE, SEND_TO
+from langroid.utils.constants import SEND_TO
 
 try:
     from sqlalchemy import MetaData, Row, create_engine, inspect, text
@@ -25,7 +24,7 @@ except ImportError as e:
     raise LangroidImportError(extra="sql", error=str(e))
 
 from langroid.agent.chat_agent import ChatAgent, ChatAgentConfig
-from langroid.agent.chat_document import ChatDocMetaData, ChatDocument
+from langroid.agent.chat_document import ChatDocument
 from langroid.agent.special.sql.utils.description_extractors import (
     extract_schema_descriptions,
 )
@@ -43,15 +42,15 @@ from langroid.agent.special.sql.utils.tools import (
     GetTableSchemaTool,
     RunQueryTool,
 )
-from langroid.mytypes import Entity
+from langroid.agent.tools.orchestration import DoneTool, ForwardTool
 from langroid.vector_store.base import VectorStoreConfig
 
 logger = logging.getLogger(__name__)
 
 console = Console()
 
-DEFAULT_SQL_CHAT_SYSTEM_MESSAGE = f"""
-{{mode}}
+DEFAULT_SQL_CHAT_SYSTEM_MESSAGE = """
+{mode}
 
 You do not need to attempt answering a question with just one query. 
 You could make a sequence of SQL queries to help you write the final query.
@@ -65,19 +64,24 @@ are "Male" and "Female".
 
 Start by asking what I would like to know about the data.
 
-When you have FINISHED the given query or database update task, 
-say {DONE} and show your answer.
-
 """
 
-ADDRESSING_INSTRUCTION = f"""
+ADDRESSING_INSTRUCTION = """
 IMPORTANT - Whenever you are NOT writing a SQL query, make sure you address the user
-using {{prefix}}User. You MUST use the EXACT syntax {{prefix}} !!!
+using {prefix}User. You MUST use the EXACT syntax {prefix} !!!
 
 In other words, you ALWAYS write EITHER:
  - a SQL query using the `run_query` tool, 
- - OR address the user using {{prefix}}User, and include {DONE} to indicate your 
-     task is FINISHED. 
+ - OR address the user using {prefix}User
+"""
+
+DONE_INSTRUCTION = f"""
+When you are SURE you have the CORRECT answer to a user's query or request, 
+use the `{DoneTool.name()}` with `content` set to the answer or result.
+If you DO NOT think you have the answer to the user's query or request,
+you SHOULD NOT use the `{DoneTool.name()}` tool.
+Instead, you must CONTINUE to improve your queries (tools) to get the correct answer,
+and finally use the `{DoneTool.name()}` tool to send the correct answer to the user.
 """
 
 
@@ -96,7 +100,10 @@ class SQLChatAgentConfig(ChatAgentConfig):
     context_descriptions: Dict[str, Dict[str, Union[str, Dict[str, str]]]] = {}
     use_schema_tools: bool = False
     multi_schema: bool = False
-    addressing_prefix: str = SEND_TO
+    # whether the agent is used in a continuous chat with user,
+    # as opposed to returning a result from the task.run()
+    chat_mode: bool = False
+    addressing_prefix: str = ""
 
     """
     Optional, but strongly recommended, context descriptions for tables, columns, 
@@ -225,14 +232,21 @@ class SQLChatAgent(ChatAgent):
         """Initialize message tools used for chatting."""
         message = self._format_message()
         self.config.system_message = self.config.system_message.format(mode=message)
-        if self.config.addressing_prefix != "":
+
+        if self.config.chat_mode:
+            self.config.addressing_prefix = self.config.addressing_prefix or SEND_TO
             self.config.system_message += ADDRESSING_INSTRUCTION.format(
                 prefix=self.config.addressing_prefix
             )
+        else:
+            self.config.system_message += DONE_INSTRUCTION
+
         super().__init__(self.config)
-        self.enable_message(RunQueryTool)
+        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)
 
     def _format_message(self) -> str:
         if self.engine is None:
@@ -270,7 +284,7 @@ class SQLChatAgent(ChatAgent):
 
     def handle_message_fallback(
         self, msg: str | ChatDocument
-    ) -> str | ChatDocument | None:
+    ) -> str | ForwardTool | None:
         """
         Handle the scenario where current msg is not a tool.
         Special handling is only needed if the message was from the LLM
@@ -278,60 +292,40 @@ class SQLChatAgent(ChatAgent):
         """
         if not self.llm_responded:
             return None
-        if self.used_run_query:
-            prefix = (
-                self.config.addressing_prefix + "User"
-                if self.config.addressing_prefix
-                else ""
-            )
-            return (
-                DONE + prefix + (msg.content if isinstance(msg, ChatDocument) else msg)
-            )
+        if self.interactive:
+            return ForwardTool(agent="User")
 
-        else:
-            reminder = """
-            You may have forgotten to use the `run_query` tool to execute an SQL query
-            for the user's question/request            
+        tools_instruction = f"""
+          For example you may want to use the TOOL
+          `{RunQueryTool.name()}` to further explore the database contents
+        """
+        if self.config.use_schema_tools:
+            tools_instruction += """
+            OR you may want to use one of the schema tools to 
+            explore the database schema
+            """
+        if self.config.chat_mode:
+            return f"""
+            Since you did not explicitly address the User, it is not clear
+            whether:
+            - you intend this to be the final response to the 
+              user's query/request, in which case you must use the 
+              `{ForwardTool.name()}` to indicate this.
+            - OR, you FORGOT to use an Appropriate TOOL,
+              in which case you should use the available tools to
+              make progress on the user's query/request.
+              {tools_instruction}            
             """
-            if self.config.addressing_prefix != "":
-                reminder += f"""
-                OR you may have forgotten to address the user using the prefix
-                {self.config.addressing_prefix} 
-                """
-            return reminder
-
-    def _agent_response(
-        self,
-        msg: Optional[str | ChatDocument] = None,
-    ) -> Optional[ChatDocument]:
-        # Your override code here
-        if msg is None:
-            return None
-
-        results = self.handle_message(msg)
-        if results is None:
-            return None
 
-        output = results
-        if SQL_ERROR_MSG in output:
-            output = "There was an error in the SQL Query. Press enter to retry."
-
-        console.print(f"[red]{self.indent}", end="")
-        print(f"[red]Agent: {output}")
-        sender_name = self.config.name
-        if isinstance(msg, ChatDocument) and msg.function_call is not None:
-            sender_name = msg.function_call.name
-
-        content = results.content if isinstance(results, ChatDocument) else results
-
-        return ChatDocument(
-            content=content,
-            metadata=ChatDocMetaData(
-                source=Entity.AGENT,
-                sender=Entity.AGENT,
-                sender_name=sender_name,
-            ),
-        )
+        return f"""
+            The intent of your response is not clear:
+            - if you intended this to be the FINAL answer to the user's query,
+                then use the `{DoneTool.name()}` to indicate so,
+                with the `content` set to the answer or result.
+            - otherwise, use one of the available tools to make progress 
+                to arrive at the final answer.
+                {tools_instruction}
+            """
 
     def retry_query(self, e: Exception, query: str) -> str:
         """

langroid/agent/task.py

@@ -1023,9 +1023,11 @@ class Task:
         found_response = False
         # (responder, result) from a responder who explicitly said NO_ANSWER
         no_answer_response: None | Tuple[Responder, ChatDocument] = None
+        n_non_responders = 0
         for r in responders:
             self.is_pass_thru = False
             if not self._can_respond(r):
+                n_non_responders += 1
                 # create dummy msg for logging
                 log_doc = ChatDocument(
                     content="[CANNOT RESPOND]",
@@ -1038,6 +1040,9 @@ class Task:
                 # no need to register this dummy msg in ObjectRegistry
                 ChatDocument.delete_id(log_doc.id())
                 self.log_message(r, log_doc)
+                if n_non_responders == len(responders):
+                    # don't stay in this "non-response" loop forever
+                    break
                 continue
             self.human_tried = r == Entity.USER
             result = self.response(r, turns)

langroid/agent/tools/retrieval_tool.py

@@ -4,7 +4,10 @@ from langroid.agent.tool_message import ToolMessage
 
 
 class RetrievalTool(ToolMessage):
-    """Retrieval tool, only to be used by a DocChatAgent."""
+    """
+    Retrieval tool, only to be used by a DocChatAgent.
+    The handler method is defined in DocChatAgent.retrieval_tool
+    """
 
     request: str = "retrieval_tool"
     purpose: str = """

langroid/parsing/utils.py

@@ -31,6 +31,10 @@ def download_nltk_resource(resource: str) -> None:
         nltk.download(resource, quiet=True)
 
 
+# Download punkt_tab resource at module import
+download_nltk_resource("punkt_tab")
+download_nltk_resource("gutenberg")
+
 T = TypeVar("T")
 
 
@@ -46,7 +50,6 @@ def batched(iterable: Iterable[T], n: int) -> Iterable[Sequence[T]]:
 
 def generate_random_sentences(k: int) -> str:
     # Load the sample text
-    download_nltk_resource("gutenberg")
 
     from nltk.corpus import gutenberg
 

langroid/utils/configuration.py

@@ -17,8 +17,6 @@ class Settings(BaseSettings):
     stream: bool = True  # stream output?
     cache: bool = True  # use cache?
     cache_type: Literal["redis", "fakeredis", "momento", "none"] = "redis"  # cache type
-    interactive: bool = True  # interactive mode?
-    gpt3_5: bool = True  # use GPT-3.5?
     chat_model: str = ""  # language model name, e.g. litellm/ollama/llama2
     quiet: bool = False  # quiet mode (i.e. suppress all output)?
     notebook: bool = False  # running in a notebook?

{langroid-0.22.3.dist-info → langroid-0.22.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: langroid
-Version: 0.22.3
+Version: 0.22.5
 Summary: Harness LLMs with Multi-Agent Programming
 License: MIT
 Author: Prasad Chalasani
@@ -68,7 +68,7 @@ Requires-Dist: metaphor-python (>=0.1.23,<0.2.0) ; extra == "all" or extra == "m
 Requires-Dist: momento (>=1.10.2,<1.21) ; extra == "momento"
 Requires-Dist: neo4j (>=5.14.1,<6.0.0) ; extra == "all" or extra == "neo4j"
 Requires-Dist: nest-asyncio (>=1.6.0,<2.0.0)
-Requires-Dist: nltk (>=3.8.1,<4.0.0)
+Requires-Dist: nltk (>=3.8.2,<4.0.0)
 Requires-Dist: onnxruntime (>=1.16.1,<2.0.0)
 Requires-Dist: openai (>=1.45.0,<2.0.0)
 Requires-Dist: pandas (>=2.0.3,<3.0.0)

{langroid-0.22.3.dist-info → langroid-0.22.5.dist-info}/RECORD

@@ -1,6 +1,6 @@
 langroid/__init__.py,sha256=z_fCOLQJPOw3LLRPBlFB5-2HyCjpPgQa4m4iY5Fvb8Y,1800
 langroid/agent/__init__.py,sha256=ll0Cubd2DZ-fsCMl7e10hf9ZjFGKzphfBco396IKITY,786
-langroid/agent/base.py,sha256=IatVtrdstxMcreeVSndNoChFKxrJIEkYRpNruBxRQ7M,67112
+langroid/agent/base.py,sha256=-lMv0XHO7ya1P6IW_xb439Mx8WhFEPgt1AmcMe200ds,67268
 langroid/agent/batch.py,sha256=QZdlt1563hx4l3AXrCaGovE-PNG93M3DsvQAbDzdiS8,13705
 langroid/agent/callbacks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 langroid/agent/callbacks/chainlit.py,sha256=JJXI3UGTyTDg2FFath4rqY1GyUo_0pbVBt8CZpvdtn4,23289
@@ -30,7 +30,7 @@ langroid/agent/special/neo4j/tools.py,sha256=Vw3HvtDfG2c4_bUHgt4_ZbJq48lpIQstbjj
 langroid/agent/special/relevance_extractor_agent.py,sha256=zIx8GUdVo1aGW6ASla0NPQjYYIpmriK_TYMijqAx3F8,4796
 langroid/agent/special/retriever_agent.py,sha256=lvMvf-u9rSosg4YASuFdUbGLgkzLPknXAbJZfZ1LZCc,1868
 langroid/agent/special/sql/__init__.py,sha256=mWfmm1QpXCezpFOS2eI57M0L_Ok3q5_ukG8tXBnBrEA,319
-langroid/agent/special/sql/sql_chat_agent.py,sha256=LVTuOlaY6m5DpsMFLFv00eOz04y6vKeO4mfGLIUp6AY,16844
+langroid/agent/special/sql/sql_chat_agent.py,sha256=j8m1Lm8j_w3m3gzPjuC2vea_t_bfhNewCfDnPDzrc38,17191
 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
@@ -38,7 +38,7 @@ langroid/agent/special/sql/utils/system_message.py,sha256=qKLHkvQWRQodTtPLPxr1GS
 langroid/agent/special/sql/utils/tools.py,sha256=vFYysk6Vi7HJjII8B4RitA3pt_z3gkSglDNdhNVMiFc,1332
 langroid/agent/special/table_chat_agent.py,sha256=d9v2wsblaRx7oMnKhLV7uO_ujvk9gh59pSGvBXyeyNc,9659
 langroid/agent/structured_message.py,sha256=y7pud1EgRNeTFZlJmBkLmwME3yQJ_IYik-Xds9kdZbY,282
-langroid/agent/task.py,sha256=0ewueaJBXvOvlSAHipL21xqgcpiGySDHr-A_Ov0WyQ8,86659
+langroid/agent/task.py,sha256=BdLNWFQqA9X-9ZtUIC2NwmRrPAX7GB0mAC0aXDzK0Uk,86877
 langroid/agent/tool_message.py,sha256=bjBSk1N1IgqqYGmOy6O97zPFMSaUdEK7r8ZjOaJwoeE,11335
 langroid/agent/tools/__init__.py,sha256=IMgCte-_ZIvCkozGQmvMqxIw7_nKLKzD78ccJL1bnQU,804
 langroid/agent/tools/duckduckgo_search_tool.py,sha256=NhsCaGZkdv28nja7yveAhSK_w6l_Ftym8agbrdzqgfo,1935
@@ -47,7 +47,7 @@ langroid/agent/tools/google_search_tool.py,sha256=y7b-3FtgXf0lfF4AYxrZ3K5pH2dhid
 langroid/agent/tools/metaphor_search_tool.py,sha256=qj4gt453cLEX3EGW7nVzVu6X7LCdrwjSlcNY0qJW104,2489
 langroid/agent/tools/orchestration.py,sha256=EDv1EMVGYqX82x3bCRbTn9gFNs66oosiUM8WTSZkUJg,10909
 langroid/agent/tools/recipient_tool.py,sha256=dr0yTxgNEIoxUYxH6TtaExC4G_8WdJ0xGohIa4dFLhY,9808
-langroid/agent/tools/retrieval_tool.py,sha256=2q2pfoYbZNfbWQ0McxrtmfF0ekGglIgRl-6uF26pa-E,871
+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
 langroid/agent/tools/segment_extract_tool.py,sha256=__srZ_VGYLVOdPrITUM8S0HpmX4q7r5FHWMDdHdEv8w,1440
 langroid/agent/typed_task.py,sha256=oxja0Z3uLTv0BcR1xIMqDpo85MIGOruz4XsZ4ghjsW4,689
@@ -100,7 +100,7 @@ langroid/parsing/table_loader.py,sha256=qNM4obT_0Y4tjrxNBCNUYjKQ9oETCZ7FbolKBTcz
 langroid/parsing/url_loader.py,sha256=Na2TBlKuQkloZzkE2d7xl6mh9olS3CbpgCsJbJ-xhIA,4472
 langroid/parsing/url_loader_cookies.py,sha256=Lg4sNpRz9MByWq2mde6T0hKv68VZSV3mtMjNEHuFeSU,2327
 langroid/parsing/urls.py,sha256=XjpaV5onG7gKQ5iQeFTzHSw5P08Aqw0g-rMUu61lR6s,7988
-langroid/parsing/utils.py,sha256=pbSAbfwA28EBNESpQRJee_Kp1b44qze-2_2b9qJOKfM,12646
+langroid/parsing/utils.py,sha256=kb9DlHaG1iQB-6JagH1C26SdCNNf8U-2XaXia4_dWCw,12726
 langroid/parsing/web_search.py,sha256=wGycU86N3nsZ78E9iS-BIm5NWueDgoknojABE0_1LRA,4886
 langroid/prompts/__init__.py,sha256=RW11vK6jiLPuaUh4GpeFvstti73gkm8_rDMtrbo2YsU,142
 langroid/prompts/chat-gpt4-system-prompt.md,sha256=Q3uLCJTPQvmUkZN2XDnkBC7M2K3X0F3C3GIQBaFvYvw,5329
@@ -115,7 +115,7 @@ langroid/utils/.chainlit/translations/en-US.json,sha256=DAFz2HjOFFfboCStrUfKFg2B
 langroid/utils/__init__.py,sha256=Sruos2tB4G7Tn0vlblvYlX9PEGR0plI2uE0PJ4d_EC4,353
 langroid/utils/algorithms/__init__.py,sha256=WylYoZymA0fnzpB4vrsH_0n7WsoLhmuZq8qxsOCjUpM,41
 langroid/utils/algorithms/graph.py,sha256=JbdpPnUOhw4-D6O7ou101JLA3xPCD0Lr3qaPoFCaRfo,2866
-langroid/utils/configuration.py,sha256=LgjHGB0qgKKTwBaVt84APiqvJbz6pLwylUvHWYmzyP0,3303
+langroid/utils/configuration.py,sha256=V3RS8OP7AC0_bDKczxfortD0F5H3cnsZL0ulKBxuoHU,3213
 langroid/utils/constants.py,sha256=vKIdkAJwyPT-bRA5MDPiOl7-EppBRmewRBIOcdXi4I4,959
 langroid/utils/docker.py,sha256=kJQOLTgM0x9j9pgIIqp0dZNZCTvoUDhp6i8tYBq1Jr0,1105
 langroid/utils/git_utils.py,sha256=WnflJ3R3owhlD0LNdSJakcKhExcEehE1UW5jYVQl8JY,7955
@@ -142,8 +142,8 @@ langroid/vector_store/meilisearch.py,sha256=6frB7GFWeWmeKzRfLZIvzRjllniZ1cYj3Hmh
 langroid/vector_store/momento.py,sha256=qR-zBF1RKVHQZPZQYW_7g-XpTwr46p8HJuYPCkfJbM4,10534
 langroid/vector_store/qdrant_cloud.py,sha256=3im4Mip0QXLkR6wiqVsjV1QvhSElfxdFSuDKddBDQ-4,188
 langroid/vector_store/qdrantdb.py,sha256=v88lqFkepADvlN6lByUj9I4NEKa9X9lWH16uTPPbYrE,17457
-pyproject.toml,sha256=blIMIWJ0_N8r8YBAJV1BoWriHqWE3erxmjQb-2npkbU,7488
-langroid-0.22.3.dist-info/LICENSE,sha256=EgVbvA6VSYgUlvC3RvPKehSg7MFaxWDsFuzLOsPPfJg,1065
-langroid-0.22.3.dist-info/METADATA,sha256=_1rwLApadQ9D1HTsVSTq03sPgyiALup286Snmx2Ei7I,57107
-langroid-0.22.3.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-langroid-0.22.3.dist-info/RECORD,,
+pyproject.toml,sha256=m9VWz7kgw5OWUlJj_B-LP9ov67jCSioaLfCLTVdi-jg,7488
+langroid-0.22.5.dist-info/LICENSE,sha256=EgVbvA6VSYgUlvC3RvPKehSg7MFaxWDsFuzLOsPPfJg,1065
+langroid-0.22.5.dist-info/METADATA,sha256=B7F4ITogUktXDfPGpjQB1RDNe2TV1se5JF321Jc2tNY,57107
+langroid-0.22.5.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+langroid-0.22.5.dist-info/RECORD,,

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "langroid"
-version = "0.22.3"
+version = "0.22.5"
 description = "Harness LLMs with Multi-Agent Programming"
 authors = ["Prasad Chalasani <pchalasani@gmail.com>"]
 readme = "README.md"
@@ -62,7 +62,7 @@ fakeredis = "^2.12.1"
 faker = "^18.9.0"
 requests = "^2.31.0"
 pyparsing = "^3.0.9"
-nltk = "^3.8.1"
+nltk = "^3.8.2"
 qdrant-client = "^1.8.0"
 pydantic = ">=1,<3"
 pandas = "^2.0.3"