TavilySearchAPIWrapper

class langchain_community.utilities.tavily_search.TavilySearchAPIWrapper

基础类：BaseModel

Tavily搜索API的封装。

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

如果输入数据无法验证以形成有效模型，则引发 [ValidationError][pydantic_core.ValidationError]。

self 被显式地设为仅位置参数，以允许 self 作为字段名称。

param tavily_api_key: SecretStr [Required]

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

清理来自Tavily搜索API的结果。

Parameters:

结果 (列表[字典])

Return type:

列表[字典]

raw_results(query: str, max_results: int | None = 5, search_depth: str | None = 'advanced', include_domains: List[str] | None = [], exclude_domains: List[str] | None = [], include_answer: bool | None = False, include_raw_content: bool | None = False, include_images: bool | None = False) → Dict

Parameters:

• query (str)

• max_results (int | None)

• search_depth (str | None)

• include_domains (列表[字符串] | 无)

• exclude_domains (List[str] | None)

• include_answer (bool | None)

• include_raw_content (bool | None)

• include_images (bool | None)

Return type:

字典

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

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

Parameters:

• query (str)

• max_results (int | None)

• search_depth (str | None)

• include_domains (列表[字符串] | 无)

• exclude_domains (List[str] | None)

• include_answer (bool | None)

• include_raw_content (bool | None)

• include_images (bool | None)

Return type:

字典

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

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

Parameters:

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

• max_results (int | None) – 返回的最大结果数。

• search_depth (str | None) – 搜索的深度。可以是“basic”或“advanced”。

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

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

• include_answer (bool | None) – 是否在结果中包含答案。

• include_raw_content (bool | None) – 是否在结果中包含原始内容。

• include_images (bool | None) – 是否在结果中包含图像。

Returns:

被搜索的查询。 follow_up_questions: 一系列后续问题。 response_time: 查询的响应时间。 answer: 查询的答案。 images: 一系列图片。 results: 包含结果的字典列表：

title: 结果的标题。 url: 结果的URL。 content: 结果的内容。 score: 结果的分数。 raw_content: 结果的原始内容。

Return type:

查询

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

Parameters:

• query (str)

• max_results (int | None)

• search_depth (str | None)

• include_domains (列表[字符串] | 无)

• exclude_domains (List[str] | None)

• include_answer (bool | None)

• include_raw_content (bool | None)

• include_images (bool | None)

Return type:

列表[字典]