langroid 0.9.5__py3-none-any.whl → 0.10.0__py3-none-any.whl

langroid/agent/__init__.py

@@ -6,7 +6,7 @@ from .chat_document import (
     ChatDocument,
 )
 from .chat_agent import ChatAgentConfig, ChatAgent
-from .tool_message import ToolMessage
+from .tool_message import ToolMessage, FinalResultTool
 from .task import Task
 
 from . import base
@@ -29,6 +29,7 @@ __all__ = [
     "ChatAgent",
     "ChatAgentConfig",
     "ToolMessage",
+    "FinalResultTool",
     "Task",
     "base",
     "chat_document",

langroid/agent/base.py

@@ -1056,6 +1056,7 @@ class Agent(ABC):
         """
         try:
             tools = self.get_tool_messages(msg)
+            tools = [t for t in tools if self._tool_recipient_match(t)]
         except ValidationError as ve:
             # correct tool name but bad fields
             return self.tool_validation_error(ve)

langroid/agent/chat_agent.py

@@ -453,7 +453,7 @@ class ChatAgent(Agent):
         # remove leading and trailing newlines and other whitespace
         return LLMMessage(role=Role.SYSTEM, content=content.strip())
 
-    def unhanded_tools(self) -> set[str]:
+    def unhandled_tools(self) -> set[str]:
         """The set of tools that are known but not handled.
         Useful in task flow: an agent can refuse to accept an incoming msg
         when it only has unhandled tools.
@@ -719,7 +719,7 @@ class ChatAgent(Agent):
                 llm_msgs = ChatDocument.to_LLMMessage(message, self.oai_tool_calls)
                 # LLM only responds to the content, so only those msgs with
                 # non-empty content should be kept
-                llm_msgs = [m for m in llm_msgs if m.content != ""]
+                llm_msgs = [m for m in llm_msgs if m.content.strip() != ""]
                 if len(llm_msgs) == 0:
                     return [], 0
                 # process tools if any

langroid/agent/chat_document.py

@@ -119,7 +119,9 @@ class ChatDocument(Document):
     oai_tool_id2result: Optional[OrderedDict[str, str]] = None
     oai_tool_choice: ToolChoiceTypes | Dict[str, Dict[str, str] | str] = "auto"
     function_call: Optional[LLMFunctionCall] = None
-    tool_messages: List[ToolMessage] = []  # only handle-able tools
+    # tools that are explicitly added by agent response/handler,
+    # or tools recognized in the ChatDocument as handle-able tools
+    tool_messages: List[ToolMessage] = []
     # all known tools in the msg that are in an agent's llm_tools_known list,
     # even if non-used/handled
     all_tool_messages: List[ToolMessage] = []

langroid/agent/structured_message.py

@@ -0,0 +1,9 @@
+from langroid.agent.tool_message import ToolMessage
+
+
+class StructuredMessage(ToolMessage):
+    request: str = ""
+    purpose: str = "Wrapper for a structured message"
+
+    # allow subclasses to inhert this "extras allowed" config
+    # model_config = ConfigDict(extra=Extra.allow)

langroid/agent/task.py

@@ -33,7 +33,7 @@ from langroid.agent.chat_document import (
     ChatDocument,
     StatusCode,
 )
-from langroid.agent.tool_message import ToolMessage
+from langroid.agent.tool_message import FinalResultTool, ToolMessage
 from langroid.agent.tools.orchestration import AgentDoneTool, DoneTool
 from langroid.cachedb.redis_cachedb import RedisCache, RedisCacheConfig
 from langroid.exceptions import InfiniteLoopException
@@ -1399,14 +1399,18 @@ class Task:
         # if there is an LLMDoneTool or AgentDoneTool among these,
         # we extract content and tools from here, and ignore all others
         for t in tool_messages:
-            if isinstance(t, (AgentDoneTool, DoneTool)):
+            if isinstance(t, FinalResultTool):
+                content = ""
+                tool_messages = [t]  # pass it on to parent so it also quits
+                break
+            elif isinstance(t, (AgentDoneTool, DoneTool)):
                 # there shouldn't be multiple tools like this; just take the first
                 content = t.content
                 if isinstance(t, AgentDoneTool):
                     tool_messages = t.tools
                 break
         # drop the "Done" tools since they should not be part of the task result,
-        # or else they would cause the parent task to get done!
+        # or else they would cause the parent task to get unintentionally done!
         tool_messages = [
             t for t in tool_messages if not isinstance(t, (DoneTool, AgentDoneTool))
         ]
@@ -1473,7 +1477,7 @@ class Task:
                 and (
                     DONE in result.content
                     or any(
-                        isinstance(t, (DoneTool, AgentDoneTool))
+                        isinstance(t, (DoneTool, AgentDoneTool, FinalResultTool))
                         for t in result.tool_messages
                     )
                 )
@@ -1594,7 +1598,8 @@ class Task:
         done_result = result is not None and (
             DONE in (result.content if isinstance(result, str) else result.content)
             or any(
-                isinstance(t, (DoneTool, AgentDoneTool)) for t in result.tool_messages
+                isinstance(t, (DoneTool, AgentDoneTool, FinalResultTool))
+                for t in result.tool_messages
             )
         )
 

langroid/agent/tool_message.py

@@ -273,3 +273,29 @@ class ToolMessage(ABC, BaseModel):
             exclude=list(cls.Config.schema_extra["exclude"]),
         )
         return schema
+
+
+class FinalResultTool(ToolMessage):
+    """Class to use as a wrapper for sending arbitrary results from an Agent's
+    agent_response or tool handlers, to:
+    (a) trigger completion of the current task as well as all parent tasks, and
+    (b) be returned as the final result of the root task, i.e. this tool would appear
+         in the final ChatDocument's `tool_messages` list.
+    See test_tool_handlers_and_results in test_tool_messages.py, and
+    examples/basic/tool-extract-short-example.py.
+
+    Note:
+        - when defining a tool handler or agent_response, you can directly return
+            FinalResultTool(field1 = val1, ...),
+            where the values can be aribitrary data structures, including nested
+            Pydantic objs, or you can define a subclass of FinalResultTool with the
+            fields you want to return.
+        - This is a special ToolMessage that is NOT meant to be used or handled
+            by an agent.
+    """
+
+    request: str = ""
+    purpose: str = "Ignored; Wrapper for a structured message"
+
+    class Config:
+        extra = Extra.allow

{langroid-0.9.5.dist-info → langroid-0.10.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: langroid
-Version: 0.9.5
+Version: 0.10.0
 Summary: Harness LLMs with Multi-Agent Programming
 License: MIT
 Author: Prasad Chalasani

{langroid-0.9.5.dist-info → langroid-0.10.0.dist-info}/RECORD

@@ -1,11 +1,11 @@
 langroid/__init__.py,sha256=z_fCOLQJPOw3LLRPBlFB5-2HyCjpPgQa4m4iY5Fvb8Y,1800
-langroid/agent/__init__.py,sha256=ll0Cubd2DZ-fsCMl7e10hf9ZjFGKzphfBco396IKITY,786
-langroid/agent/base.py,sha256=MYG3kBduJxgQsGUpcS97SE2clTq4VUnGm1Ky6tKJhnM,58995
+langroid/agent/__init__.py,sha256=CFjjVvXVEV4ac0PdNPHVQHREV2HbbHCF6wj42v5MpJ4,826
+langroid/agent/base.py,sha256=c5RYAKotgJH1vfqZvnMBt10RCino26jJv3thEMKYyy0,59067
 langroid/agent/batch.py,sha256=feRA_yRG768ElOQjrKEefcRv6Aefd_yY7qktuYUQDwc,10040
 langroid/agent/callbacks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 langroid/agent/callbacks/chainlit.py,sha256=Qedk1-CBCgo9PdaIa7AboLBFCTgAMg9q5nGmoqpZ378,22050
-langroid/agent/chat_agent.py,sha256=VUuYweOLuH4lokvZLY74WXIG4AlxRU4L907ox_hoRA4,48107
-langroid/agent/chat_document.py,sha256=Cq-TbPefpxbx2QzGl-CUpIrCcEC34GHDGH6Fd0w7aYs,16693
+langroid/agent/chat_agent.py,sha256=q39Taek6yhinGWDYP7Uze6p8jP5v5nvn-Y1k-yJB8TQ,48116
+langroid/agent/chat_document.py,sha256=DnmRLma0zud0XsN_wm-F0fnQv3fjQghv3t8Ahudq238,16799
 langroid/agent/helpers.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 langroid/agent/junk,sha256=LxfuuW7Cijsg0szAzT81OjWWv1PMNI-6w_-DspVIO2s,339
 langroid/agent/openai_assistant.py,sha256=2rjCZw45ysNBEGNzQM4uf0bTC4KkatGYAWcVcW4xcek,34337
@@ -32,8 +32,9 @@ langroid/agent/special/sql/utils/populate_metadata.py,sha256=1J22UsyEPKzwK0XlJZt
 langroid/agent/special/sql/utils/system_message.py,sha256=qKLHkvQWRQodTtPLPxr1GSLUYUFASZU8x-ybV67cB68,1885
 langroid/agent/special/sql/utils/tools.py,sha256=vFYysk6Vi7HJjII8B4RitA3pt_z3gkSglDNdhNVMiFc,1332
 langroid/agent/special/table_chat_agent.py,sha256=d9v2wsblaRx7oMnKhLV7uO_ujvk9gh59pSGvBXyeyNc,9659
-langroid/agent/task.py,sha256=taSP80E_pcqa6OEGi9weOQXx7It8SZvgosfuVv4DQcw,80300
-langroid/agent/tool_message.py,sha256=pArap87HNODwBVH2Dyu4Oi_OOhK0NH65pDUOHvIKV0E,10101
+langroid/agent/structured_message.py,sha256=y7pud1EgRNeTFZlJmBkLmwME3yQJ_IYik-Xds9kdZbY,282
+langroid/agent/task.py,sha256=y4FXXLSJv_8LIox4-E48MG_VQl1558WCLR9w35-KBJ4,80560
+langroid/agent/tool_message.py,sha256=EcWsi3LS7SGENO1V8DpM8UFdc5pwlcqelt1UL6KgLwA,11195
 langroid/agent/tools/__init__.py,sha256=lgWAWsPgMx-NdDPVX6tXO_U0cIQX7dwzhUC0G4IfUgk,726
 langroid/agent/tools/duckduckgo_search_tool.py,sha256=NhsCaGZkdv28nja7yveAhSK_w6l_Ftym8agbrdzqgfo,1935
 langroid/agent/tools/extract_tool.py,sha256=u5lL9rKBzaLBOrRyLnTAZ97pQ1uxyLP39XsWMnpaZpw,3789
@@ -133,8 +134,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=STQ2CYykc2Cf2J4p_RgIb0nXTw8esZs7k2gqurI6HSY,7087
-langroid-0.9.5.dist-info/LICENSE,sha256=EgVbvA6VSYgUlvC3RvPKehSg7MFaxWDsFuzLOsPPfJg,1065
-langroid-0.9.5.dist-info/METADATA,sha256=OoluP4y6n-wu3Jsx2p9Ah5SRyhMTKQOA3_R5CyNvA7g,54751
-langroid-0.9.5.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-langroid-0.9.5.dist-info/RECORD,,
+pyproject.toml,sha256=WE_GhHAyFWSrzXRv6PO2Fz7Vz-JGL_Md8QPI5bKqYrw,7088
+langroid-0.10.0.dist-info/LICENSE,sha256=EgVbvA6VSYgUlvC3RvPKehSg7MFaxWDsFuzLOsPPfJg,1065
+langroid-0.10.0.dist-info/METADATA,sha256=PDxK3LArvELAz8HNVfwwLK2o9Uk5kGKJfpwcd-ev9uY,54752
+langroid-0.10.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+langroid-0.10.0.dist-info/RECORD,,

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "langroid"
-version = "0.9.5"
+version = "0.10.0"
 description = "Harness LLMs with Multi-Agent Programming"
 authors = ["Prasad Chalasani <pchalasani@gmail.com>"]
 readme = "README.md"