langchain_community.utilities.tavily_search.TavilySearchAPIWrapper

class langchain_community.utilities.tavily_search.TavilySearchAPIWrapper[source]

基类: BaseModel

Tavily Search API 的包装器。

通过解析和验证关键字参数中的输入数据创建一个新的模型。

如果无法将输入数据解析为有效的模型，将引发 ValidationError。

param tavily_api_key: SecretStr [Required]
约束条件

  • 类型 = 字符串

  • 只写 = True

  • 格式 = 密码

clean_results(results: List[Dict]) → List[Dict][source]

清除Tavily搜索API的结果。

参数

results (列表[字典]) –

返回类型

列表[字典]

raw_results(query: str, max_results: Optional[int] = 5, search_depth: Optional[str] = 'advanced', include_domains: Optional[List[str]] = [], exclude_domains: Optional[List[str]] = [], include_answer: Optional[bool] = False, include_raw_content: Optional[bool] = False, include_images: Optional[bool] = False) → Dict[源代码]
参数

  • query (str) –

  • max_results (可选[int]) –

  • search_depth (可选[str]) –

  • include_domains (可选[列表[str]]) –

  • exclude_domains (可选[列表[str]]) –

  • include_answer (可选[bool]) –

  • include_raw_content (可选[bool]) –

  • include_images (可选[bool]) –

返回类型

字典类型

async raw_results_async(query: str, max_results: Optional[int] = 5, search_depth: Optional[str] = 'advanced', include_domains: Optional[List[str]] = [], exclude_domains: Optional[List[str]] = [], include_answer: Optional[bool] = False, include_raw_content: Optional[bool] = False, include_images: Optional[bool] = False) → Dict[来源]

异步从Tavily搜索引擎API获取结果。

参数

  • query (str) –

  • max_results (可选[int]) –

  • search_depth (可选[str]) –

  • include_domains (可选[列表[str]]) –

  • exclude_domains (可选[列表[str]]) –

  • include_answer (可选[bool]) –

  • include_raw_content (可选[bool]) –

  • include_images (可选[bool]) –

返回类型

字典类型

results(query: str, max_results: Optional[int] = 5, search_depth: Optional[str] = 'advanced', include_domains: Optional[List[str]] = [], exclude_domains: Optional[List[str]] = [], include_answer: Optional[bool] = False, include_raw_content: Optional[bool] = False, include_images: Optional[bool] = False) → List[Dict][源代码]

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

参数

  • query (str) – 要搜索的查询。

  • max_results (Optional[int]) – 返回的最大结果数。

  • search_depth (Optional[str]) – 搜索深度。可以是“basic”或“advanced”。

  • include_domains (Optional[List[str]]) – 包括在搜索中的域名列表。

  • exclude_domains (Optional[List[str]]) – 要排除的搜索域名列表。

  • include_answer (Optional[bool]) – 是否在结果中包括答案。

  • include_raw_content (Optional[bool]) – 是否在结果中包括原始内容。

  • include_images (Optional[bool]) – 是否在结果中包括图片。

返回值

搜索的查询。后续问题：后续问题的列表。响应时间：查询的响应时间。答案：查询的答案。图片：图片的列表。结果：包含结果的字典列表。

标题：结果的标题。url：结果的URL。内容：结果的内容。评分：结果的评分。原始内容：结果的原始内容。

返回类型

查询

async results_async(query: str, max_results: Optional[int] = 5, search_depth: Optional[str] = 'advanced', include_domains: Optional[List[str]] = [], exclude_domains: Optional[List[str]] = [], include_answer: Optional[bool] = False, include_raw_content: Optional[bool] = False, include_images: Optional[bool] = False) → List[Dict][source]
参数

  • query (str) –

  • max_results (可选[int]) –

  • search_depth (可选[str]) –

  • include_domains (可选[列表[str]]) –

  • exclude_domains (可选[列表[str]]) –

  • include_answer (可选[bool]) –

  • include_raw_content (可选[bool]) –

  • include_images (可选[bool]) –

返回类型

列表[字典]