langroid 0.9.4__tar.gz → 0.10.0__tar.gz

{langroid-0.9.4 → langroid-0.10.0}/PKG-INFO

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

{langroid-0.9.4 → langroid-0.10.0}/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-0.9.4 → langroid-0.10.0}/langroid/agent/base.py

@@ -45,7 +45,13 @@ from langroid.mytypes import Entity
 from langroid.parsing.parse_json import extract_top_level_json
 from langroid.parsing.parser import Parser, ParsingConfig
 from langroid.prompts.prompts_config import PromptsConfig
-from langroid.pydantic_v1 import BaseSettings, Field, ValidationError, validator
+from langroid.pydantic_v1 import (
+    BaseModel,
+    BaseSettings,
+    Field,
+    ValidationError,
+    validator,
+)
 from langroid.utils.configuration import settings
 from langroid.utils.constants import DONE, NO_ANSWER, PASS, PASS_TO, SEND_TO
 from langroid.utils.object_registry import ObjectRegistry
@@ -1050,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)
@@ -1300,8 +1307,25 @@ class Agent(ABC):
                     # else wrap it in an agent response and return it so
                     # orchestrator can find a respondent
                     result = self.create_agent_response(tool_messages=[maybe_result])
-            else:
+            elif isinstance(maybe_result, (ChatDocument, str)):
                 result = maybe_result
+            elif isinstance(maybe_result, BaseModel):
+                result = maybe_result.json()
+            else:
+                # last resort: use json.dumps() or str() to make it a str
+                try:
+                    result = json.dumps(maybe_result)
+                except Exception:
+                    try:
+                        result = str(maybe_result)
+                    except Exception as e:
+                        logger.error(
+                            f"""
+                            Error converting result of {tool_name} to str: {e}", 
+                            """,
+                            exc_info=True,
+                        )
+                        result = None
         except Exception as e:
             # raise the error here since we are sure it's
             # not a pydantic validation error,

{langroid-0.9.4 → langroid-0.10.0}/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-0.9.4 → langroid-0.10.0}/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-0.10.0/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-0.9.4 → langroid-0.10.0}/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-0.9.4 → langroid-0.10.0}/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.4 → langroid-0.10.0}/pyproject.toml

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