search_engines/tavily.py

import gradio as gr
import pandas as pd
from langchain_tavily import TavilySearch

from utils.helpers import map_results

from .base import BaseInterfaceWrapper


async def tavily_search(query: str, api_key: str, max_results: int = 5) -> pd.DataFrame:
    """
    Given a search query, returns the search results from Tavily.

    Args:
        query (str): The search query.
        api_key (str): The API key for Tavily Search.
        max_results (int, optional): The number of maximum results to return. Defaults to 5.

    Returns:
        dict: The search results from Tavily 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.
    """
    tavily = TavilySearch(
        tavily_api_key=api_key,
    )
    tavily.max_results = max_results
    results = await tavily.ainvoke(query)
    mapping = {
        "title": "title",
        "url": "link",
        "content": "body",
    }
    results = await map_results(results["results"], mapping)
    return results


class TavilyInterfaceWrapper(BaseInterfaceWrapper):
    def __init__(self):
        super().__init__(
            fn=tavily_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="Tavily Search",
            description="Search the web using Tavily Search Engine.",
        )