Tavily research

TavilyToolSpec

Bases: BaseToolSpec

工具规范。

Source code in llama_index/tools/tavily_research/base.py

class TavilyToolSpec(BaseToolSpec):
    """工具规范。"""

    spec_functions = [
        "search",
    ]

    def __init__(self, api_key: str) -> None:
        """使用参数进行初始化。"""
        from tavily import TavilyClient

        self.client = TavilyClient(api_key=api_key)

    def search(self, query: str, max_results: Optional[int] = 6) -> List[Document]:
        """运行查询通过 Tavily 搜索并返回元数据。

Args:
    query: 要搜索的查询。
    max_results: 要返回的最大结果数。

Returns:
    results: 包含结果的字典列表：
        url: 结果的url。
        content: 结果的内容。
"""
        response = self.client.search(
            query, max_results=max_results, search_depth="advanced"
        )
        return [
            Document(text=result["content"], extra_info={"url": result["url"]})
            for result in response["results"]
        ]

search

search(
    query: str, max_results: Optional[int] = 6
) -> List[Document]

运行查询通过 Tavily 搜索并返回元数据。

Parameters:

Name	Type	Description	Default
query	str	要搜索的查询。	required
max_results	Optional[int]	要返回的最大结果数。	6

Returns:

Name	Type	Description
results	List[Document]	包含结果的字典列表： url: 结果的url。 content: 结果的内容。

Source code in llama_index/tools/tavily_research/base.py

    def search(self, query: str, max_results: Optional[int] = 6) -> List[Document]:
        """运行查询通过 Tavily 搜索并返回元数据。

Args:
    query: 要搜索的查询。
    max_results: 要返回的最大结果数。

Returns:
    results: 包含结果的字典列表：
        url: 结果的url。
        content: 结果的内容。
"""
        response = self.client.search(
            query, max_results=max_results, search_depth="advanced"
        )
        return [
            Document(text=result["content"], extra_info={"url": result["url"]})
            for result in response["results"]
        ]