MetaphorSearchAPIWrapper#

class langchain_community.utilities.metaphor_search.MetaphorSearchAPIWrapper[源代码]#

基础类：BaseModel

Metaphor Search API 的封装器。

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

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

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

param k: int = 10#
param metaphor_api_key: str [Required]#
results(query: str, num_results: int, include_domains: List[str] | None = None, exclude_domains: List[str] | None = None, start_crawl_date: str | None = None, end_crawl_date: str | None = None, start_published_date: str | None = None, end_published_date: str | None = None, use_autoprompt: bool | None = None) → List[Dict][来源]#

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

Parameters:

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

  • num_results (int) – 返回的结果数量。

  • include_domains (List[str] | None) – 包含在搜索中的域名列表。只能定义 include_domains 和 exclude_domains 中的一个。

  • exclude_domains (List[str] | None) – 要从搜索中排除的域名列表。include_domains 和 exclude_domains 只能定义其中一个。

  • start_crawl_date (str | None) – 如果指定，则只返回我们在start_crawl_date之后爬取的页面。

  • end_crawl_date (str | None) – 如果指定，则只返回我们在end_crawl_date之前抓取的页面。

  • start_published_date (str | None) – 如果指定，则只返回在start_published_date之后发布的页面。

  • end_published_date (str | None) – 如果指定，则只返回在end_published_date之前发布的页面。

  • use_autoprompt (bool | None) – 如果为真，我们将您的查询转换为更友好的Metaphor查询。会增加延迟。

Returns:

标题 - 页面的标题 网址 - 网址 作者 - 内容的作者，如果适用。否则为无。 发布日期 - 估计的发布日期

以YYYY-MM-DD格式。否则为无。

Return type:

一个包含以下键的字典列表

async results_async(query: str, num_results: int, include_domains: List[str] | None = None, exclude_domains: List[str] | None = None, start_crawl_date: str | None = None, end_crawl_date: str | None = None, start_published_date: str | None = None, end_published_date: str | None = None, use_autoprompt: bool | None = None) → List[Dict][source]#

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

Parameters:

  • query (str)

  • num_results (int)

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

  • exclude_domains (List[str] | None)

  • start_crawl_date (str | None)

  • end_crawl_date (str | None)

  • start_published_date (str | None)

  • end_published_date (str | None)

  • use_autoprompt (bool | None)

Return type:

列表[字典]