feat: add Brave search engine integration with API interface

register_interfaces.py

@@ -1,3 +1,4 @@
+from search_engines.brave import BraveInterfaceWrapper
 from search_engines.duckduckgo import DuckDuckGoInterfaceWrapper
 from search_engines.searxng import SearxNGInterfaceWrapper
 from search_engines.serpapi import SerpAPIInterfaceWrapper
@@ -9,8 +10,9 @@ def register_all_interfaces(wrapper):
     """
     Register all search engine interfaces with the provided AppWrapper instance.
     """
+    wrapper.register_interface(BraveInterfaceWrapper(), "Brave Search")
     wrapper.register_interface(DuckDuckGoInterfaceWrapper(), "DuckDuckGo Search")
-    wrapper.register_interface(TavilyInterfaceWrapper(), "Tavily Search")
     wrapper.register_interface(SearxNGInterfaceWrapper(), "SearxNG Search")
     wrapper.register_interface(SerpAPIInterfaceWrapper(), "SerpAPI Search")
     wrapper.register_interface(SerperInterfaceWrapper(), "Serper Search")
+    wrapper.register_interface(TavilyInterfaceWrapper(), "Tavily Search")

search_engines/brave.py

@@ -0,0 +1,56 @@
+import json
+
+import gradio as gr
+import pandas as pd
+from langchain_community.tools import BraveSearch
+
+from utils.helpers import map_results
+
+from .base import BaseInterfaceWrapper
+
+
+async def brave_search(query: str, api_key: str, max_results: int = 5) -> pd.DataFrame:
+    """
+    Given a search query, returns the search results from Brave.
+
+    Args:
+        query (str): The search query.
+        api_key (str): The API key for Brave Search.
+        max_results (int, optional): The number of maximum results to return. Defaults to 5.
+
+    Returns:
+        dict: The search results from Brave Search Engine. Fields:
+            headers (list): The headers of the columns in the search results. Contains "title", "link", "body".
+            data (list): The data in the search results. Each row contains the title, link, and body of the search result.
+    """
+    brave = BraveSearch.from_api_key(
+        api_key=api_key,
+        search_kwargs={
+            "max_results": max_results,
+        },
+    )
+    results = await brave.arun(query)
+    results = json.loads(results)
+    mapping = {
+        "title": "title",
+        "link": "link",
+        "snippet": "body",
+    }
+    results = await map_results(results, mapping)
+    return results
+
+
+class BraveInterfaceWrapper(BaseInterfaceWrapper):
+    def __init__(self):
+        super().__init__(
+            fn=brave_search,
+            inputs=[
+                gr.Textbox(label="Search Query"),
+                gr.Textbox(label="API Key", type="password"),
+                gr.Slider(
+                    minimum=1, maximum=10, step=1, value=5, label="Number of Results"
+                ),
+            ],
+            title="Brave Search",
+            description="Search the web using Brave Search Engine.",
+        )