langchain_community.utilities.metaphor_search.MetaphorSearchAPIWrapper

class langchain_community.utilities.metaphor_search.MetaphorSearchAPIWrapper[source]

基类: BaseModel

Metaphor Search API的包装器。

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

如果输入数据无法解析为有效的模型，则抛出 ValidationError。

参数 k: int = 10
参数 metaphor_api_key: str [必填]
results(query: str, num_results: int, include_domains: Optional[List[str]] = None, exclude_domains: Optional[List[str]] = None, start_crawl_date: Optional[str] = None, end_crawl_date: Optional[str] = None, start_published_date: Optional[str] = None, end_published_date: Optional[str] = None, use_autoprompt: Optional[bool] = None) → List[Dict][源代码]

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

参数

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

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

  • include_domains (Optional[str]) – 应包含在搜索中的域名列表。include_domains 和 exclude_domains 中只能指定其中一个。

  • exclude_domains (Optional[str]) – 应从搜索中排除的域名列表。include_domains 和 exclude_domains 中只能指定其中一个。

  • start_crawl_date (Optional[str]) – 如果指定，则只返回我们在此日期之后抓取的页面。

  • end_crawl_date (Optional[str]) – 如果指定，则只返回我们在此日期之前抓取的页面。

  • start_published_date (Optional[str]) – 如果指定，则只返回在此日期之后发布的页面。

  • end_published_date (Optional[str]) – 如果指定，则只返回在此日期之前发布的页面。

  • use_autoprompt (Optional[bool]) – 如果为 true，我们将查询转换为更符合隐喻查询风格的查询。会增加延迟。

返回值

title - 页面的标题

url - 页面 URL

author - 内容作者，如果适用的话。否则，为 None。

published_date - 估计发布的日期

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

异步获取Metaphor Search API的结果。

参数

  • query (str) –

  • num_results (int) –

  • include_domains (Optional[List[str]]) –

  • exclude_domains (Optional[List[str]]) –

  • start_crawl_date (Optional[str]) –

  • end_crawl_date (Optional[str]) –

  • start_published_date (Optional[str]) –

  • end_published_date (Optional[str]) –

  • use_autoprompt (Optional[bool]) –

author - 内容作者，如果适用的话。否则，为 None。

列表[字典]