langroid 0.1.176__tar.gz → 0.1.177__tar.gz

{langroid-0.1.176 → langroid-0.1.177}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: langroid
-Version: 0.1.176
+Version: 0.1.177
 Summary: Harness LLMs with Multi-Agent Programming
 License: MIT
 Author: Prasad Chalasani
@@ -12,6 +12,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Provides-Extra: hf-embeddings
 Provides-Extra: litellm
+Provides-Extra: metaphor
 Provides-Extra: mysql
 Provides-Extra: neo4j
 Provides-Extra: postgres
@@ -38,6 +39,7 @@ Requires-Dist: litellm (>=1.0.0,<2.0.0) ; extra == "litellm"
 Requires-Dist: lxml (>=4.9.3,<5.0.0)
 Requires-Dist: meilisearch (>=0.28.3,<0.29.0)
 Requires-Dist: meilisearch-python-sdk (>=2.2.3,<3.0.0)
+Requires-Dist: metaphor-python (>=0.1.23,<0.2.0) ; extra == "metaphor"
 Requires-Dist: mkdocs (>=1.4.2,<2.0.0)
 Requires-Dist: mkdocs-awesome-pages-plugin (>=2.8.0,<3.0.0)
 Requires-Dist: mkdocs-gen-files (>=0.4.0,<0.5.0)

{langroid-0.1.176 → langroid-0.1.177}/langroid/agent/special/neo4j/neo4j_chat_agent.py

@@ -146,10 +146,11 @@ class Neo4jChatAgent(ChatAgent):
         logger.error(f"Cypher Query failed: {query}\nException: {e}")
 
         # Construct the error message
-        error_message_template = f"""\
+        error_message_template = f"""
+        There were some errors running your Cypher query:
         {NEO4J_ERROR_MSG}: '{query}'
         {str(e)}
-        Run a new query, correcting the errors.
+        Send a new query, correcting the errors.
         """
 
         return error_message_template
@@ -168,7 +169,6 @@ class Neo4jChatAgent(ChatAgent):
         Returns:
             str: The result of executing the Cypher query.
         """
-        response_message = ""
         if not self.driver:
             raise ValueError("No database connection is established.")
 
@@ -284,7 +284,7 @@ class Neo4jChatAgent(ChatAgent):
             return "The database schema does not have any nodes or relationships."
 
     def _init_tool_messages(self) -> None:
-        """Initialize message tools used for chatting."""
+        """Attach ToolMessages to the Agent."""
         message = self._format_message()
         self.config.system_message = self.config.system_message.format(mode=message)
         super().__init__(self.config)

{langroid-0.1.176 → langroid-0.1.177}/langroid/agent/special/table_chat_agent.py

@@ -10,7 +10,7 @@ the code and returns the result as a string.
 import io
 import logging
 import sys
-from typing import List, no_type_check
+from typing import List, Optional, no_type_check
 
 import numpy as np
 import pandas as pd
@@ -23,7 +23,7 @@ from langroid.agent.tool_message import ToolMessage
 from langroid.language_models.openai_gpt import OpenAIChatModel, OpenAIGPTConfig
 from langroid.parsing.table_loader import read_tabular_data
 from langroid.prompts.prompts_config import PromptsConfig
-from langroid.utils.constants import DONE, PASS
+from langroid.utils.constants import DONE
 from langroid.vector_store.base import VectorStoreConfig
 
 logger = logging.getLogger(__name__)
@@ -34,7 +34,7 @@ DEFAULT_TABLE_CHAT_SYSTEM_MESSAGE = f"""
 You are a savvy data scientist, with expertise in analyzing tabular datasets,
 using Python and the Pandas library for dataframe manipulation.
 Since you do not have access to the dataframe 'df', you
-will need to use the `run_code` tool/function-call to answer the question.
+will need to use the `run_code` tool/function-call to answer my questions.
 Here is a summary of the dataframe:
 {{summary}}
 Do not assume any columns other than those shown.
@@ -48,9 +48,9 @@ If you receive a null or other unexpected result, see if you have made an assump
 in your code, and try another way, or use `run_code` to explore the dataframe 
 before submitting your final code. 
 
-Once you have the answer to the question, say {DONE} and show me the answer.
-If you receive an error message, try using the `run_code` tool/function 
-again with the corrected code. 
+Once you have the answer to the question, possibly after a few steps,
+say {DONE} and show me the answer. If you receive an error message, 
+try using the `run_code` tool/function again with the corrected code. 
 
 VERY IMPORTANT: When using the `run_code` tool/function, DO NOT EXPLAIN ANYTHING,
    SIMPLY USE THE TOOL, with the CODE.
@@ -129,6 +129,7 @@ class RunCodeTool(ToolMessage):
     purpose: str = """
             To run <code> on the dataframe 'df' and 
             return the results to answer a question.
+            IMPORTANT: ALL the code should be in the <code> field.
             """
     code: str
 
@@ -145,6 +146,8 @@ class TableChatAgent(ChatAgent):
     Agent for chatting with a collection of documents.
     """
 
+    sent_code: bool = False
+
     def __init__(self, config: TableChatAgentConfig):
         if isinstance(config.data, pd.DataFrame):
             df = config.data
@@ -169,6 +172,15 @@ class TableChatAgent(ChatAgent):
         # enable the agent to use and handle the RunCodeTool
         self.enable_message(RunCodeTool)
 
+    def user_response(
+        self,
+        msg: Optional[str | ChatDocument] = None,
+    ) -> Optional[ChatDocument]:
+        response = super().user_response(msg)
+        if response is not None and response.content != "":
+            self.sent_code = False
+        return response
+
     def run_code(self, msg: RunCodeTool) -> str:
         """
         Handle a RunCodeTool message by running the code and returning the result.
@@ -178,6 +190,7 @@ class TableChatAgent(ChatAgent):
         Returns:
             str: The result of running the code along with any print output.
         """
+        self.sent_code = True
         code = msg.code
         # Create a dictionary that maps 'df' to the actual DataFrame
         local_vars = {"df": self.df}
@@ -230,14 +243,13 @@ class TableChatAgent(ChatAgent):
     ) -> str | ChatDocument | None:
         """Handle scenario where LLM forgets to say DONE or forgets to use run_code"""
         if isinstance(msg, ChatDocument) and msg.metadata.sender == lr.Entity.LLM:
-            return f"""
-                You either:
-                
-                (A) forgot to use the `run_code` tool/function to find the answer,
-                        ==> In this case re-try using the `run_code` tool/function. 
-                OR 
-                
-                (B) forgot to say {DONE} after you found the answer.
-                        ==> In this case say "{DONE} {PASS}"
-                """
+            if self.sent_code:
+                return DONE
+            else:
+                return """
+                    You forgot to use the `run_code` tool/function to find the answer.
+                    Try again using the `run_code` tool/function.
+                    Remember that ALL your code, including imports, 
+                    should be in the `code` field.
+                    """
         return None

{langroid-0.1.176 → langroid-0.1.177}/langroid/agent/task.py

@@ -160,6 +160,8 @@ class Task:
         self.name = name or agent.config.name
         self.value: str = self.name
         self.default_human_response = default_human_response
+        if default_human_response is not None and default_human_response == "":
+            interactive = False
         self.interactive = interactive
         self.message_history_idx = -1
         if interactive:
@@ -957,8 +959,6 @@ class Task:
             bool: True if task is done, False otherwise
         """
         result = result or self.pending_message
-        if self.is_done:
-            return True
         user_quit = (
             result is not None
             and result.content in USER_QUIT
@@ -968,6 +968,9 @@ class Task:
             # for top-level task, only user can quit out
             return user_quit
 
+        if self.is_done:
+            return True
+
         if self.n_stalled_steps >= self.max_stalled_steps:
             # we are stuck, so bail to avoid infinite loop
             logger.warning(

langroid-0.1.177/langroid/agent/tools/metaphor_search_tool.py

@@ -0,0 +1,44 @@
+"""
+A tool to trigger a metaphor search for a given query, and return the top results with
+their titles, links, summaries. Since the tool is stateless (i.e. does not need
+access to agent state), it can be enabled for any agent, without having to define a
+special method inside the agent: `agent.enable_message(MetaphorSearchTool)`
+
+NOTE: Using this tool requires setting the METAPHOR_API_KEY environment variables in 
+your `.env` file, as explained in the
+[README](https://github.com/langroid/langroid#gear-installation-and-setup).
+
+This tool requires installing langroid with the `metaphor` extra, e.g.
+`pip install langroid[metaphor]` or `poetry add langroid[metaphor]`
+(it installs the `metaphor-python` package from pypi).
+
+For more information, please refer to the official docs:
+https://metaphor.systems/
+"""
+
+from langroid.agent.tool_message import ToolMessage
+from langroid.parsing.web_search import metaphor_search
+
+
+class MetaphorSearchTool(ToolMessage):
+    request: str = "metaphor_search"
+    purpose: str = """
+            To search the web by metaphor api and return up to <num_results> 
+            links relevant to the given <query>. 
+            """
+    query: str
+    num_results: int
+
+    def handle(self) -> str:
+        """
+        Conducts a search using the metaphor API based on the provided query
+        and number of results by triggering a metaphor_search.
+
+        Returns:
+            str: A formatted string containing the titles, links, and
+            summaries of each search result, separated by two newlines.
+        """
+
+        search_results = metaphor_search(self.query, self.num_results)
+        # return Title, Link, Summary of each result, separated by two newlines
+        return "\n\n".join(str(result) for result in search_results)

{langroid-0.1.176 → langroid-0.1.177}/langroid/language_models/openai_gpt.py

@@ -60,7 +60,8 @@ class OpenAIChatModel(str, Enum):
 
     GPT3_5_TURBO = "gpt-3.5-turbo-1106"
     GPT4 = "gpt-4"
-    GPT4_TURBO = "gpt-4-1106-preview"
+    GPT4_32K = "gpt-4-32k"
+    GPT4_TURBO = "gpt-4-turbo-preview"
 
 
 class OpenAICompletionModel(str, Enum):
@@ -72,8 +73,9 @@ class OpenAICompletionModel(str, Enum):
 
 _context_length: Dict[str, int] = {
     # can add other non-openAI models here
-    OpenAIChatModel.GPT3_5_TURBO: 4096,
+    OpenAIChatModel.GPT3_5_TURBO: 16_385,
     OpenAIChatModel.GPT4: 8192,
+    OpenAIChatModel.GPT4_32K: 32_768,
     OpenAIChatModel.GPT4_TURBO: 128_000,
     OpenAICompletionModel.TEXT_DA_VINCI_003: 4096,
 }
@@ -81,7 +83,7 @@ _context_length: Dict[str, int] = {
 _cost_per_1k_tokens: Dict[str, Tuple[float, float]] = {
     # can add other non-openAI models here.
     # model => (prompt cost, generation cost) in USD
-    OpenAIChatModel.GPT3_5_TURBO: (0.0015, 0.002),
+    OpenAIChatModel.GPT3_5_TURBO: (0.001, 0.002),
     OpenAIChatModel.GPT4: (0.03, 0.06),  # 8K context
     OpenAIChatModel.GPT4_TURBO: (0.01, 0.03),  # 128K context
 }
@@ -197,7 +199,7 @@ class OpenAIGPTConfig(LLMConfig):
     api_base: str | None = None  # used for local or other non-OpenAI models
     litellm: bool = False  # use litellm api?
     max_output_tokens: int = 1024
-    min_output_tokens: int = 64
+    min_output_tokens: int = 1
     use_chat_for_completion = True  # do not change this, for OpenAI models!
     timeout: int = 20
     temperature: float = 0.2

{langroid-0.1.176 → langroid-0.1.177}/langroid/parsing/web_search.py

@@ -77,3 +77,49 @@ def google_search(query: str, num_results: int = 5) -> List[WebSearchResult]:
         WebSearchResult(result["title"], result["link"], 3500, 300)
         for result in raw_results
     ]
+
+
+def metaphor_search(query: str, num_results: int = 5) -> List[WebSearchResult]:
+    """
+    Method that makes an API call by Metaphor client that queries
+    the top num_results links that matches the query. Returns a list
+    of WebSearchResult objects.
+
+    Args:
+        query (str): The query body that users wants to make.
+        num_results (int): Number of top matching results that we want
+            to grab
+    """
+
+    load_dotenv()
+
+    api_key = os.getenv("METAPHOR_API_KEY")
+    if not api_key:
+        raise ValueError(
+            """
+            METAPHOR_API_KEY is not set. 
+            Please set the METAPHOR_API_KEY environment variable.
+            """
+        )
+
+    try:
+        from metaphor_python import Metaphor
+    except ImportError:
+        raise ImportError(
+            "You are attempting to use the `metaphor_python` library;"
+            "To use it, please install langroid with the `metaphor` extra, e.g. "
+            "`pip install langroid[metaphor]` or `poetry add langroid[metaphor]` "
+            "(it installs the `metaphor_python` package from pypi)."
+        )
+
+    client = Metaphor(api_key=api_key)
+
+    response = client.search(
+        query=query,
+        num_results=num_results,
+    )
+    raw_results = response.results
+
+    return [
+        WebSearchResult(result.title, result.url, 3500, 300) for result in raw_results
+    ]

{langroid-0.1.176 → langroid-0.1.177}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "langroid"
-version = "0.1.176"
+version = "0.1.177"
 description = "Harness LLMs with Multi-Agent Programming"
 authors = ["Prasad Chalasani <pchalasani@gmail.com>"]
 readme = "README.md"
@@ -85,6 +85,7 @@ neo4j = {version = "^5.14.1", optional = true}
 agent-search = {version = "^0.0.7", optional = true}
 python-docx = "^1.1.0"
 aiohttp = "^3.9.1"
+metaphor-python = {version = "^0.1.23", optional = true}
 
 [tool.poetry.extras]
 # install these using `poetry install -E [...]` where [...] is one of the extras below
@@ -94,7 +95,7 @@ mysql = ["pymysql", "pytest-mysql"]
 litellm = ["litellm"]
 neo4j = ["neo4j"]
 sciphi = ["agent-search"]
-
+metaphor = ["metaphor-python"]
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.3.1"