serpapi_Google_Search_tool

helper.py

@@ -326,3 +326,116 @@ wikipedia_full_content_tool = Tool(
     """,
     func=wikipedia_full_content,
 )
+
+import os
+from serpapi import GoogleSearch # Or use SerpApiClient for other engines
+from typing import Dict, Any
+from langchain.tools import Tool # Import the Tool class
+
+class SerpApiSearchTool:
+    """
+    A tool to perform searches using SerpApi.
+    Supports various search engines and extracts structured data.
+    """
+    def __init__(self):
+        # Retrieve API key from environment variables for security
+        self.api_key = os.getenv("SERPAPI_API_KEY")
+
+        if not self.api_key:
+            raise ValueError(
+                "SERPAPI_API_KEY must be set as an environment variable. "
+                "Get your API key from https://serpapi.com/dashboard"
+            )
+
+    def search_google(self, query: str, num_results: int = 5) -> str:
+        """
+        Performs a Google search via SerpApi and returns a formatted string of organic results.
+
+        Args:
+            query (str): The search query string.
+            num_results (int): The number of organic search results to return (max 100).
+
+        Returns:
+            str: A formatted string containing the title, link, and snippet of each result.
+                 Also includes any featured snippet or knowledge graph if available.
+                 Returns an error message if the search fails or no results are found.
+        """
+        if not query:
+            return "Error: Search query cannot be empty."
+
+        params = {
+            "api_key": self.api_key,
+            "engine": "google",
+            "q": query,
+            "num": num_results, # Number of organic results
+            "gl": "in",         # Geo-location for the search (India in this case)
+            "hl": "en"          # Host language for the search
+        }
+
+        try:
+            print(f"[TOOL: SerpApiSearch] Searching Google for: '{query}'")
+            search = GoogleSearch(params)
+            results = search.get_dict() # Execute the search and get results as a dictionary
+
+            formatted_output = []
+
+            # Check for common structured results first
+            if 'answer_box' in results and results['answer_box'].get('answer'):
+                formatted_output.append(f"Answer Box: {results['answer_box']['answer']}")
+            if 'knowledge_graph' in results and results['knowledge_graph'].get('description'):
+                formatted_output.append(f"Knowledge Graph: {results['knowledge_graph']['description']}")
+                if results['knowledge_graph'].get('title'):
+                     formatted_output.append(f"  Title: {results['knowledge_graph']['title']}")
+                if results['knowledge_graph'].get('link'):
+                     formatted_output.append(f"  Link: {results['knowledge_graph']['link']}")
+
+            # Then process organic results
+            organic_results = results.get('organic_results', [])
+            if organic_results:
+                if formatted_output: # Add a separator if other sections were added
+                    formatted_output.append("\n--- Organic Results ---")
+                else:
+                    formatted_output.append("Organic Results:")
+                for i, item in enumerate(organic_results):
+                    title = item.get('title', 'No Title')
+                    link = item.get('link', '#')
+                    snippet = item.get('snippet', 'No Snippet')
+                    formatted_output.append(
+                        f"Result {i+1}:\n"
+                        f"  Title: {title}\n"
+                        f"  Link: {link}\n"
+                        f"  Snippet: {snippet}\n"
+                    )
+            
+            if not formatted_output: # If no structured data or organic results
+                return "No relevant search results found."
+
+            return "\n".join(formatted_output)
+
+        except Exception as e:
+            return f"Error performing SerpApi search: {e}"
+
+# Instantiate the SerpApiSearchTool class
+serpapi_search_instance = SerpApiSearchTool()
+
+# Create the LangChain Tool object
+serpapi_Google_Search_tool = Tool(
+    name="serpapi_Google Search",
+    description="""
+    Performs a Google search using SerpApi to get current and detailed information from the web.
+    Use this for factual queries, general knowledge, recent events, or when TavilySearch might not be sufficient.
+    It can return rich results including answer boxes, knowledge graphs, and multiple organic search results.
+    Input should be a clear, concise search query string.
+    """,
+    func=serpapi_search_instance.search_google,
+)
+
+# Remember to set your SERPAPI_API_KEY environment variable before running!
+# Example: os.environ["SERPAPI_API_KEY"] = "YOUR_API_KEY_HERE"
+
+# To use this tool, you would add `serpapi_Google Search_tool` to your `tools` list
+# in your `BasicAgent` initialization, like this:
+# tools = [travily_api_search_tool, python_repl, ..., serpapi_Google Search_tool]
+#
+# And you would need to update your prompt's "Available Tools" section
+# to describe `serpapi_Google Search` to the LLM.