tools/web_search.py

from typing import Any, Optional
from smolagents.tools import Tool
import duckduckgo_search


class DuckDuckGoSearchTool(Tool):
    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.'},
        'max_results': {
            'type': 'integer',
            'description': 'Maximum number of search results to return',
            'nullable': True
        }
    }
    output_type = "string"

    def __init__(self, max_results=10, **kwargs):
        super().__init__()
        self.default_max_results = max_results
        try:
            from duckduckgo_search import DDGS
        except ImportError as e:
            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)

    def forward(self, query: str, max_results: int = None) -> str:
        """Performs a web search
        Args:
            query: The search query to perform
            max_results: Maximum number of results to return. If not specified, uses the value from __init__
        Returns:
            String containing formatted search results
        """
        results_limit = max_results if max_results is not None else self.default_max_results
        results = self.ddgs.text(query, max_results=results_limit)
        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)