langroid 0.1.38__py3-none-any.whl → 0.1.40__py3-none-any.whl

langroid/agent/base.py

@@ -128,9 +128,10 @@ class Agent(ABC):
                 raise ValueError("message_class must be a subclass of ToolMessage")
             tool = message_class.default_value("request")
             self.llm_tools_map[tool] = message_class
-            if hasattr(message_class, "handle"):
+            if hasattr(message_class, "handle") and not hasattr(self, tool):
                 """
                 If the message class has a `handle` method,
+                and does NOT have a method with the same name as the tool,
                 then we create a method for the agent whose name
                 is the value of `tool`, and whose body is the `handle` method.
                 This removes a separate step of having to define this method

langroid/agent/special/doc_chat_agent.py

@@ -304,14 +304,21 @@ class DocChatAgent(ChatAgent):
         )
 
     @no_type_check
-    def answer_from_docs(self, query: str) -> Document:
-        """Answer query based on docs in vecdb, and conv history"""
-        response = Document(
-            content=NO_ANSWER,
-            metadata=DocMetaData(
-                source="None",
-            ),
-        )
+    def get_relevant_extracts(self, query: str) -> List[Document]:
+        """
+        Get list of docs or extracts relevant to a query. These could be:
+        - the original docs, if they exist and are not too long, or
+        - a list of doc-chunks retrieved from the VecDB
+            that are "relevant" to the query, if these are not too long, or
+        - a list of relevant extracts from these doc-chunks
+
+        Args:
+            query (str): query to search for
+
+        Returns:
+            List[Document]: list of relevant docs
+
+        """
         if len(self.dialog) > 0 and not self.config.conversation_mode:
             # In conversation mode, we let self.message_history accumulate
             # and do not need to convert to standalone query
@@ -324,7 +331,7 @@ class DocChatAgent(ChatAgent):
 
         passages = self.original_docs
 
-        # if original docs too long, no need to look for relevant parts.
+        # if original docs not too long, no need to look for relevant parts.
         if (
             passages is None
             or self.original_docs_length > self.config.max_context_tokens
@@ -335,7 +342,7 @@ class DocChatAgent(ChatAgent):
                     k=self.config.parsing.n_similar_docs,
                 )
             if len(docs_and_scores) == 0:
-                return response
+                return []
             passages = [
                 Document(content=d.content, metadata=d.metadata)
                 for (d, _) in docs_and_scores
@@ -347,6 +354,29 @@ class DocChatAgent(ChatAgent):
             with console.status("[cyan]LLM Extracting verbatim passages..."):
                 with StreamingIfAllowed(self.llm, False):
                     extracts = self.llm.get_verbatim_extracts(query, passages)
+
+        return extracts
+
+    @no_type_check
+    def answer_from_docs(self, query: str) -> Document:
+        """
+        Answer query based on relevant docs from the VecDB
+
+        Args:
+            query (str): query to answer
+
+        Returns:
+            Document: answer
+        """
+        response = Document(
+            content=NO_ANSWER,
+            metadata=DocMetaData(
+                source="None",
+            ),
+        )
+        extracts = self.get_relevant_extracts(query)
+        if len(extracts) == 0:
+            return response
         with ExitStack() as stack:
             # conditionally use Streaming or rich console context
             cm = (

langroid/agent/special/retriever_agent.py

@@ -97,7 +97,7 @@ class RetrieverAgent(DocChatAgent, ABC):
             query_str = query.content
         else:
             query_str = query
-        docs = self.get_relevant_docs(query_str)
+        docs = self.get_relevant_extracts(query_str)
         if len(docs) == 0:
             return None
         content = "\n\n".join([d.content for d in docs])
@@ -135,7 +135,7 @@ class RetrieverAgent(DocChatAgent, ABC):
         ]
         return docs
 
-    def get_relevant_docs(self, query: str) -> List[Document]:
+    def get_relevant_extracts(self, query: str) -> List[Document]:
         """
         Given a query, get the records/docs whose contents are most relevant to the
             query. First get nearest docs from vector store, then select the best

langroid/agent/special/sql_chat_agent.py

@@ -28,9 +28,9 @@ console = Console()
 
 DEFAULT_SQL_CHAT_SYSTEM_MESSAGE = """
 You are a savvy data scientist/database administrator, with expertise in 
-answering questions by querying a SQL database.
+answering questions by querying a {dialect} database.
 You do not have access to the database 'db' directly, so you will need to use the 
-`run_query` tool/function-call to answer the question.
+`run_query` tool/function-call to answer questions.
 
 The below JSON schema maps the SQL database structure. It outlines tables, each 
 with a description and columns. Each table is identified by a key, 
@@ -146,7 +146,7 @@ class SQLChatAgent(ChatAgent):
 
         # Update the system message with the table information
         self.config.system_message = self.config.system_message.format(
-            schema_dict=schema_dict
+            schema_dict=schema_dict, dialect=self.engine.dialect.name
         )
 
         super().__init__(config)

langroid/agent/stateless_tools/google_search_tool.py

@@ -1,61 +1,16 @@
-import os
-from typing import Dict, List
+"""
+A tool to trigger a Google 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(GoogleSearchTool)`
 
-import requests
-from bs4 import BeautifulSoup
-from dotenv import load_dotenv
-from googleapiclient.discovery import Resource, build
-from requests.models import Response
+NOTE: Using this tool requires setting the GOOGLE_API_KEY and GOOGLE_CSE_ID
+environment variables in your `.env` file, as explained in the
+[README](https://github.com/langroid/langroid#gear-installation-and-setup).
+"""
 
 from langroid.agent.tool_message import ToolMessage
-
-
-class GoogleSearchResult:
-    """
-    Class representing a Google Search result, containing the title, link,
-    summary and full content of the result.
-    """
-
-    def __init__(
-        self,
-        title: str,
-        link: str,
-        max_content_length: int = 3500,
-        max_summary_length: int = 300,
-    ):
-        """
-        Args:
-            title (str): The title of the search result.
-            link (str): The link to the search result.
-            max_content_length (int): The maximum length of the full content.
-            max_summary_length (int): The maximum length of the summary.
-        """
-        self.title = title
-        self.link = link
-        self.max_content_length = max_content_length
-        self.max_summary_length = max_summary_length
-        self.full_content = self.get_full_content()
-        self.summary = self.get_summary()
-
-    def get_summary(self) -> str:
-        return self.full_content[: self.max_summary_length]
-
-    def get_full_content(self) -> str:
-        response: Response = requests.get(self.link)
-        soup: BeautifulSoup = BeautifulSoup(response.text, "lxml")
-        text = " ".join(soup.stripped_strings)
-        return text[: self.max_content_length]
-
-    def __str__(self) -> str:
-        return f"Title: {self.title}\nLink: {self.link}\nSummary: {self.summary}"
-
-    def to_dict(self) -> Dict[str, str]:
-        return {
-            "title": self.title,
-            "link": self.link,
-            "summary": self.summary,
-            "full_content": self.full_content,
-        }
+from langroid.parsing.web_search import google_search
 
 
 class GoogleSearchTool(ToolMessage):
@@ -68,19 +23,6 @@ class GoogleSearchTool(ToolMessage):
     num_results: int
 
     def handle(self) -> str:
-        load_dotenv()
-        api_key = os.getenv("GOOGLE_API_KEY")
-        cse_id = os.getenv("GOOGLE_CSE_ID")
-        service: Resource = build("customsearch", "v1", developerKey=api_key)
-        raw_results = (
-            service.cse()
-            .list(q=self.query, cx=cse_id, num=self.num_results)
-            .execute()["items"]
-        )
-
-        search_results: List[GoogleSearchResult] = [
-            GoogleSearchResult(result["title"], result["link"], 3500, 300)
-            for result in raw_results
-        ]
-        # return Title and Link of each result, separated by two newlines
+        search_results = google_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/parsing/web_search.py

@@ -0,0 +1,79 @@
+"""
+Utilities for web search.
+
+NOTE: Using Google Search requires setting the GOOGLE_API_KEY and GOOGLE_CSE_ID
+environment variables in your `.env` file, as explained in the
+[README](https://github.com/langroid/langroid#gear-installation-and-setup).
+"""
+
+import os
+from typing import Dict, List
+
+import requests
+from bs4 import BeautifulSoup
+from dotenv import load_dotenv
+from googleapiclient.discovery import Resource, build
+from requests.models import Response
+
+
+class WebSearchResult:
+    """
+    Class representing a Web Search result, containing the title, link,
+    summary and full content of the result.
+    """
+
+    def __init__(
+        self,
+        title: str,
+        link: str,
+        max_content_length: int = 3500,
+        max_summary_length: int = 300,
+    ):
+        """
+        Args:
+            title (str): The title of the search result.
+            link (str): The link to the search result.
+            max_content_length (int): The maximum length of the full content.
+            max_summary_length (int): The maximum length of the summary.
+        """
+        self.title = title
+        self.link = link
+        self.max_content_length = max_content_length
+        self.max_summary_length = max_summary_length
+        self.full_content = self.get_full_content()
+        self.summary = self.get_summary()
+
+    def get_summary(self) -> str:
+        return self.full_content[: self.max_summary_length]
+
+    def get_full_content(self) -> str:
+        response: Response = requests.get(self.link)
+        soup: BeautifulSoup = BeautifulSoup(response.text, "lxml")
+        text = " ".join(soup.stripped_strings)
+        return text[: self.max_content_length]
+
+    def __str__(self) -> str:
+        return f"Title: {self.title}\nLink: {self.link}\nSummary: {self.summary}"
+
+    def to_dict(self) -> Dict[str, str]:
+        return {
+            "title": self.title,
+            "link": self.link,
+            "summary": self.summary,
+            "full_content": self.full_content,
+        }
+
+
+def google_search(query: str, num_results: int = 5) -> List[WebSearchResult]:
+    load_dotenv()
+    api_key = os.getenv("GOOGLE_API_KEY")
+    cse_id = os.getenv("GOOGLE_CSE_ID")
+    service: Resource = build("customsearch", "v1", developerKey=api_key)
+    raw_results = (
+        service.cse().list(q=query, cx=cse_id, num=num_results).execute()["items"]
+    )
+
+    return [
+        WebSearchResult(result["title"], result["link"], 3500, 300)
+        for result in raw_results
+    ]

{langroid-0.1.38.dist-info → langroid-0.1.40.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: langroid
-Version: 0.1.38
+Version: 0.1.40
 Summary: Harness LLMs with Multi-Agent Programming
 License: MIT
 Author: Prasad Chalasani
@@ -114,6 +114,8 @@ for ideas on what to contribute.
 <summary> <b>:fire: Updates/Releases</b></summary>
 
 - **Aug 2023:**
+  - **0.1.39:** [`GoogleSearchTool`](langroid/agent/stateless_tools/google_search_tool.py) to enable Agents (their LLM) to do Google searches via function-calling/tools.
+    See [this chat example](examples/basic/chat-search.py) for how easy it is to add this tool to an agent.
   - **Colab notebook** to try the quick-start examples: [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/langroid/langroid/blob/main/examples/langroid_quick_examples.ipynb) 
   - **0.1.37:** Added [`SQLChatAgent`](langroid/agent/special/sql_chat_agent.py) -- thanks to our latest contributor [Rithwik Babu](https://github.com/rithwikbabu)!
   - Multi-agent Example: [Autocorrect chat](examples/basic/autocorrect.py)
@@ -230,7 +232,8 @@ export OPENAI_API_KEY=your-key-here-without-quotes
 <details>
 <summary><b>Optional Setup Instructions (click to expand) </b></summary>
 
-All of the below are optional and not strictly needed to run any of the examples.
+All of the following environment variable settings are optional, and some are only needed 
+to use specific features (as noted below).
 
 - **Qdrant** Vector Store API Key, URL. This is only required if you want to use Qdrant cloud.
   You can sign up for a free 1GB account at [Qdrant cloud](https://cloud.qdrant.io).
@@ -259,8 +262,9 @@ All of the below are optional and not strictly needed to run any of the examples
   After obtaining these credentials, store them as values of 
   `GOOGLE_API_KEY` and `GOOGLE_CSE_ID` in your `.env` file. 
   Full documentation on using this (and other such "stateless" tools) is coming soon, but 
-  in the meantime take a peek at the test 
-  [`tests/main/test_google_search_tool.py`](tests/main/test_google_search_tool.py) to see how to use it.
+  in the meantime take a peek at this [chat example](examples/basic/chat-search.py), which 
+  shows how you can easily equip an Agent with a `GoogleSearchtool`.
+  
 
 
 If you add all of these optional variables, your `.env` file should look like this:
@@ -354,8 +358,6 @@ task.run() # ... a loop seeking response from LLM or User at each turn
 <details>
 <summary><b> Three communicating agents </b></summary>
 
-```python
-
 A toy numbers game, where when given a number `n`:
 - `repeater_agent`'s LLM simply returns `n`,
 - `even_agent`'s LLM returns `n/2` if `n` is even, else says "DO-NOT-KNOW"
@@ -662,11 +664,11 @@ script in the `langroid-examples` repo.
 
 If you like this repo, don't forget to leave a star :star: !
 
-# Contributors
+# Langroid Co-Founders
+
+- [Prasad Chalasani](https://www.linkedin.com/in/pchalasani/) (IIT BTech/CS, CMU PhD/ML; Independent ML Consultant)
+- [Somesh Jha](https://www.linkedin.com/in/somesh-jha-80208015/) (IIT BTech/CS, CMU PhD/CS; Professor of CS, U Wisc at Madison)
+
 
-- Prasad Chalasani (IIT BTech/CS, CMU PhD/ML; Independent ML Consultant)
-- Somesh Jha (IIT BTech/CS, CMU PhD/CS; Professor of CS, U Wisc at Madison)
-- Mohannad Alhanahnah (Research Associate, U Wisc at Madison)
-- Ashish Hooda (IIT BTech/CS; PhD Candidate, U Wisc at Madison)
 
 

{langroid-0.1.38.dist-info → langroid-0.1.40.dist-info}/RECORD

@@ -1,17 +1,18 @@
 langroid/__init__.py,sha256=sEKJ_5WJBAMZApevfeE3gxLK-eotVzJMJlT83G0rAko,30
 langroid/agent/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-langroid/agent/base.py,sha256=TpCp7I1480RcCLzHJ4g1TUS2wH3kz5o2KzElFPehuBc,22466
+langroid/agent/base.py,sha256=fWlSdA1omU9TcuphtRzREwvBZ_ZoMo7yOowplpsadN0,22569
 langroid/agent/chat_agent.py,sha256=mLCHlYxU1lB7PGOLjjkaEQUqMNKcq0-HOjlG4ZcDjQE,20522
 langroid/agent/chat_document.py,sha256=Rj7Hfp_FrNjuKsTMA3KyZhno5zKpmvnPPk7WgAuAF2Y,5745
 langroid/agent/helpers.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 langroid/agent/junk,sha256=LxfuuW7Cijsg0szAzT81OjWWv1PMNI-6w_-DspVIO2s,339
 langroid/agent/special/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-langroid/agent/special/doc_chat_agent.py,sha256=NhoS02rlLr3nAfRvLB1YNcmfsWZJH24K8O-m-uYnb-I,15741
+langroid/agent/special/doc_chat_agent.py,sha256=FjuHxV6OyHvPcHuPgsm9kXMIL8qVhOM8oa-oYdzXzN8,16568
 langroid/agent/special/recipient_validator_agent.py,sha256=x2UprcGlh-fyxQCZbb_fkKrruU5Om0mgOnNzk_PYBNM,4527
-langroid/agent/special/retriever_agent.py,sha256=dkG_-QdL5KvpeS4K4jnx1kV9h_KxVEhgHz2rzdilZss,7196
-langroid/agent/special/sql_chat_agent.py,sha256=DNbz60O1HvGgWpsgYgCKE4GU7FqBoUeyZxfTbBHQ7gg,10178
+langroid/agent/special/retriever_agent.py,sha256=DeOB5crFjXBvDEZT9k9ZVinOfFM2VgS6tQWWFyXSk9o,7204
+langroid/agent/special/sql_chat_agent.py,sha256=2pw8o-0ul909HAOUO3G7SVVAaB3qVBkjtaXneNzy1x0,10215
 langroid/agent/special/table_chat_agent.py,sha256=FRkeEMvJxFievRgwschphIVNYYTLmheEyn7RQCggXdg,4953
-langroid/agent/stateless_tools/google_search_tool.py,sha256=riNFJEMNVdJuy4hSUUaH8Iz1hJqI_rGyrdcT6XXp_Sc,2770
+langroid/agent/stateless_tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+langroid/agent/stateless_tools/google_search_tool.py,sha256=64F9oMNdS237BBOitrvYXN4Il_ES_fNrHkh35tBEDfA,1160
 langroid/agent/task.py,sha256=KJZt6lSfCAVctyFfBJWLFcfys73kjrQJV4Y3aMVwO1M,26233
 langroid/agent/tool_message.py,sha256=7OdVcV7UyOZD2ihYgV1C_1fIwiWM-2pR8FFxoA1IgOo,5379
 langroid/agent_config.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -42,6 +43,7 @@ langroid/parsing/url_loader.py,sha256=tdYPMC2V9zI_B207LFdU4aroZzJW4sY9y794XePFAV
 langroid/parsing/url_loader_cookies.py,sha256=Lg4sNpRz9MByWq2mde6T0hKv68VZSV3mtMjNEHuFeSU,2327
 langroid/parsing/urls.py,sha256=_Bcf1iRdT7cQrQ8hnbPX0Jtzxc0lVFaucTS5rJoKA14,3709
 langroid/parsing/utils.py,sha256=__1Z6mFHk_TqHQY-9uU1aV_bIXeYw8H7NEXagUOEX0I,1818
+langroid/parsing/web_search.py,sha256=hGUVoSJNdpoT5rsm-ikAteMiUropHrzKaxN8EVVqO2U,2496
 langroid/prompts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 langroid/prompts/dialog.py,sha256=SpfiSyofSgy2pwD1YboHR_yHO3LEEMbv6j2sm874jKo,331
 langroid/prompts/prompts_config.py,sha256=EMK1Fm7EmS8y3CV4AkrVgn5K4NipiM4m7J8819W1KeM,98
@@ -66,7 +68,7 @@ langroid/vector_store/base.py,sha256=QZx3NUNwf2I0r3A7iuoUHIRGbqt_pFGD0hq1R-Yg8iM
 langroid/vector_store/chromadb.py,sha256=s5pQkKjaMP-Tt5A8M10EInFzttaALPbJAq7q4gf0TKg,5235
 langroid/vector_store/qdrant_cloud.py,sha256=3im4Mip0QXLkR6wiqVsjV1QvhSElfxdFSuDKddBDQ-4,188
 langroid/vector_store/qdrantdb.py,sha256=KRvIIj1IZG2zFqejofMnRs2hT86B-27LgBEnuczdqOU,9072
-langroid-0.1.38.dist-info/LICENSE,sha256=EgVbvA6VSYgUlvC3RvPKehSg7MFaxWDsFuzLOsPPfJg,1065
-langroid-0.1.38.dist-info/WHEEL,sha256=vVCvjcmxuUltf8cYhJ0sJMRDLr1XsPuxEId8YDzbyCY,88
-langroid-0.1.38.dist-info/METADATA,sha256=xtuh9ZekUsUvWV5q4mGAbJNBEY7nVxQi3OzxFazoEto,27233
-langroid-0.1.38.dist-info/RECORD,,
+langroid-0.1.40.dist-info/LICENSE,sha256=EgVbvA6VSYgUlvC3RvPKehSg7MFaxWDsFuzLOsPPfJg,1065
+langroid-0.1.40.dist-info/WHEEL,sha256=vVCvjcmxuUltf8cYhJ0sJMRDLr1XsPuxEId8YDzbyCY,88
+langroid-0.1.40.dist-info/METADATA,sha256=ql9pYkR-oovH5Db91QIShwjPAq0bxXEWE7yxjwvvEiY,27547
+langroid-0.1.40.dist-info/RECORD,,