langroid 0.9.5__tar.gz → 0.10.1__tar.gz

{langroid-0.9.5 → langroid-0.10.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: langroid
-Version: 0.9.5
+Version: 0.10.1
 Summary: Harness LLMs with Multi-Agent Programming
 License: MIT
 Author: Prasad Chalasani
@@ -162,6 +162,9 @@ into simplifying the developer experience; it does not use `Langchain`.
 :fire: See this [Intro to Langroid](https://lancedb.substack.com/p/langoid-multi-agent-programming-framework)
 blog post from the LanceDB team
 
+:fire: Just published in ML for Healthcare (2024): a Langroid-based Multi-Agent RAG system for 
+pharmacovigilance, see [blog post](https://langroid.github.io/langroid/blog/2024/08/12/malade-multi-agent-architecture-for-pharmacovigilance/)
+
 
 We welcome contributions -- See the [contributions](./CONTRIBUTING.md) document
 for ideas on what to contribute.

{langroid-0.9.5 → langroid-0.10.1}/README.md

@@ -55,6 +55,9 @@ into simplifying the developer experience; it does not use `Langchain`.
 :fire: See this [Intro to Langroid](https://lancedb.substack.com/p/langoid-multi-agent-programming-framework)
 blog post from the LanceDB team
 
+:fire: Just published in ML for Healthcare (2024): a Langroid-based Multi-Agent RAG system for 
+pharmacovigilance, see [blog post](https://langroid.github.io/langroid/blog/2024/08/12/malade-multi-agent-architecture-for-pharmacovigilance/)
+
 
 We welcome contributions -- See the [contributions](./CONTRIBUTING.md) document
 for ideas on what to contribute.

{langroid-0.9.5 → langroid-0.10.1}/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.5 → langroid-0.10.1}/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)
@@ -1068,9 +1069,12 @@ class Agent(ABC):
             return None
         if len(tools) == 0:
             fallback_result = self.handle_message_fallback(msg)
-            if fallback_result is not None and isinstance(fallback_result, ToolMessage):
-                return self.create_agent_response(tool_messages=[fallback_result])
-            return fallback_result
+            if fallback_result is None:
+                return None
+            return self._process_handle_message_result(
+                fallback_result,
+                chat_doc=msg if isinstance(msg, ChatDocument) else None,
+            )
         has_ids = all([t.id != "" for t in tools])
         chat_doc = msg if isinstance(msg, ChatDocument) else None
 
@@ -1161,9 +1165,7 @@ class Agent(ABC):
         final = "\n\n".join(str_results)
         return final
 
-    def handle_message_fallback(
-        self, msg: str | ChatDocument
-    ) -> str | ChatDocument | None:
+    def handle_message_fallback(self, msg: str | ChatDocument) -> Any:
         """
         Fallback method for the "no-tools" scenario.
         This method can be overridden by subclasses, e.g.,
@@ -1173,8 +1175,7 @@ class Agent(ABC):
         Args:
             msg (str | ChatDocument): The input msg to handle
         Returns:
-            str: The result of the handler method in string form so it can
-                be handled by LLM
+            Any: The result of the handler method
         """
         return None
 
@@ -1260,6 +1261,52 @@ class Agent(ABC):
             raise ve
         return message
 
+    def _process_handle_message_result(
+        self,
+        msg: Any,
+        orig_tool_name: str | None = None,
+        chat_doc: Optional[ChatDocument] = None,
+    ) -> None | str | ChatDocument:
+        """
+        Process result of agent_response or tool handler, or handle_message_fallback.
+        """
+        if isinstance(msg, ToolMessage):
+            # result is a ToolMessage, so...
+            result_tool_name = msg.default_value("request")
+            if result_tool_name in self.llm_tools_handled and (
+                orig_tool_name is None or orig_tool_name != result_tool_name
+            ):
+                # TODO: do we need to remove the tool message from the chat_doc?
+                # if (chat_doc is not None and
+                #     msg in chat_doc.tool_messages):
+                #    chat_doc.tool_messages.remove(msg)
+                # if we can handle it, do so
+                result = self.handle_tool_message(msg, chat_doc=chat_doc)
+            else:
+                # else wrap it in an agent response and return it so
+                # orchestrator can find a respondent
+                result = self.create_agent_response(tool_messages=[msg])
+        elif isinstance(msg, (ChatDocument, str)):
+            result = msg
+        elif isinstance(msg, BaseModel):
+            result = msg.json()
+        else:
+            # last resort: use json.dumps() or str() to make it a str
+            try:
+                result = json.dumps(msg)
+            except Exception:
+                try:
+                    result = str(msg)
+                except Exception as e:
+                    logger.error(
+                        f"""
+                            Error converting msg handler result to str: {e}", 
+                            """,
+                        exc_info=True,
+                    )
+                    result = None
+        return result
+
     def handle_tool_message(
         self,
         tool: ToolMessage,
@@ -1289,42 +1336,9 @@ class Agent(ABC):
                 maybe_result = handler_method(tool, chat_doc=chat_doc)
             else:
                 maybe_result = handler_method(tool)
-            if isinstance(maybe_result, ToolMessage):
-                # result is a ToolMessage, so...
-                result_tool_name = maybe_result.default_value("request")
-                if (
-                    result_tool_name in self.llm_tools_handled
-                    and tool_name != result_tool_name
-                ):
-                    # TODO: do we need to remove the tool message from the chat_doc?
-                    # if (chat_doc is not None and
-                    #     maybe_result in chat_doc.tool_messages):
-                    #    chat_doc.tool_messages.remove(maybe_result)
-                    # if we can handle it, do so
-                    result = self.handle_tool_message(maybe_result, chat_doc=chat_doc)
-                else:
-                    # 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])
-            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
+            result = self._process_handle_message_result(
+                maybe_result, tool_name, chat_doc
+            )
         except Exception as e:
             # raise the error here since we are sure it's
             # not a pydantic validation error,

{langroid-0.9.5 → langroid-0.10.1}/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.5 → langroid-0.10.1}/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.9.5 → langroid-0.10.1}/langroid/agent/special/lance_rag/lance_rag_task.py

@@ -51,11 +51,13 @@ class LanceRAGTaskCreator:
             critic_name=critic_name,
             doc_agent_name=doc_agent_name,
             doc_schema=agent._get_clean_vecdb_schema(),
+            llm=agent.config.llm,
         )
         query_plan_agent_config.set_system_message()
 
         critic_config = QueryPlanCriticConfig(
             doc_schema=agent._get_clean_vecdb_schema(),
+            llm=agent.config.llm,
         )
         critic_config.set_system_message()
 

langroid-0.10.1/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.5 → langroid-0.10.1}/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.5 → langroid-0.10.1}/langroid/agent/tool_message.py

@@ -273,3 +273,40 @@ 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"
+    id: str = ""  # placeholder for OpenAI-API tool_call_id
+
+    _handle_only: bool = False  # only allow handling, but not use (LLM-generation)?
+
+    class Config:
+        extra = Extra.allow
+        # only HANDLING allowed, NOT "use" (i.e LLM generation)
+        handle_only: bool = False
+        arbitrary_types_allowed = False
+        validate_all = True
+        validate_assignment = True
+        # do not include these fields in the generated schema
+        # since we don't require the LLM to specify them
+        schema_extra = {"exclude": {"purpose", "id"}}

{langroid-0.9.5 → langroid-0.10.1}/langroid/parsing/code_parser.py

@@ -115,5 +115,7 @@ class CodeParser:
             for d in docs
             if d.metadata.language in self.config.extensions  # type: ignore
         ]
+        if len(chunked_docs) == 0:
+            return []
         # collapse the list of lists into a single list
         return reduce(lambda x, y: x + y, chunked_docs)

{langroid-0.9.5 → langroid-0.10.1}/pyproject.toml

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