documentation

tools/web_search.py

@@ -2,13 +2,14 @@ from typing import Any, Optional
 from smolagents.tools import Tool
 import duckduckgo_search
 
-class DuckDuckGoSearchTool(Tool):
+class DuckDuckGoSearchTool(Tool): #inherits from smolagents tool class
     name = "web_search"
     description = "Performs a duckduckgo web search based on your query (think a Google search) then returns the top search results."
     inputs = {'query': {'type': 'string', 'description': 'The search query to perform.'}}
     output_type = "string"
 
     def __init__(self, max_results=10, **kwargs):
+        """prepares the tool for searching"""
         super().__init__()
         self.max_results = max_results
         try:
@@ -17,11 +18,11 @@ class DuckDuckGoSearchTool(Tool):
             raise ImportError(
                 "You must install package `duckduckgo_search` to run this tool: for instance run `pip install duckduckgo-search`."
             ) from e
-        self.ddgs = DDGS(**kwargs)
+        self.ddgs = DDGS(**kwargs) # instance of search engine client
 
     def forward(self, query: str) -> str:
-        results = self.ddgs.text(query, max_results=self.max_results)
+        results = self.ddgs.text(query, max_results=self.max_results) #API call to duckduckgo search
         if len(results) == 0:
             raise Exception("No results found! Try a less restrictive/shorter query.")
         postprocessed_results = [f"[{result['title']}]({result['href']})\n{result['body']}" for result in results]
-        return "## Search Results\n\n" + "\n\n".join(postprocessed_results)
+        return "## Search Results\n\n" + "\n\n".join(postprocessed_results) # markdown friendly result for UI