Skip to content

Tavily Web Search

WebSearch ΒΆ

Bases: BaseComponent

WebSearch component for fetching data from the web using Jina API

Source code in libs/kotaemon/kotaemon/indices/retrievers/tavily_web_search.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
class WebSearch(BaseComponent):
    """WebSearch component for fetching data from the web
    using Jina API
    """

    def run(
        self,
        text: str,
        *args,
        **kwargs,
    ) -> list[RetrievedDocument]:
        if TAVILY_API_KEY == "":
            raise ValueError(
                "This feature requires TAVILY_API_KEY "
                "(get free one from https://app.tavily.com/)"
            )

        try:
            from tavily import TavilyClient
        except ImportError:
            raise ImportError(
                "Please install `pip install tavily-python` to use this feature"
            )

        tavily_client = TavilyClient(api_key=TAVILY_API_KEY)
        results = tavily_client.search(
            query=text,
            search_depth="advanced",
        )["results"]
        context = "\n\n".join(
            "###URL: [{url}]({url})\n\n{content}".format(
                url=result["url"],
                content=result["content"],
            )
            for result in results
        )

        return [
            RetrievedDocument(
                text=context,
                metadata={
                    "file_name": "Web search",
                    "type": "table",
                    "llm_trulens_score": 1.0,
                },
            )
        ]

    def generate_relevant_scores(self, text, documents: list[RetrievedDocument]):
        return documents