SearxNG 搜索 API
本页介绍如何在 LangChain 中使用 SearxNG 搜索 API。 内容分为两部分:安装和设置,以及对特定 SearxNG API 包装器的参考。
安装与设置
虽然可以将该包装器与 公共 searx 实例 一起使用,但这些实例通常不允许 API 访问(请参见下面关于输出格式的说明),并且对请求频率有一定限制。建议选择自托管实例。
自托管实例:
请参阅 此页面 获取安装说明。
当您安装 SearxNG 时,默认情况下唯一活动的输出格式是 HTML 格式。
您需要激活 json
格式以使用 API。这可以通过将以下行添加到 settings.yml
文件中来实现:
search:
formats:
- html
- json
您可以通过向 API 端点发出 curl 请求来确保 API 正在工作:
curl -kLX GET --data-urlencode q='langchain' -d format=json http://localhost:8888
这应该返回一个包含结果的 JSON 对象。
包装器
实用工具
要使用包装器,我们需要通过以下方式将 SearxNG 实例的主机传递给包装器:
1. 在创建实例时使用命名参数 `searx_host`。
2. 导出环境变量 `SEARXNG_HOST`。
您可以使用包装器从 SearxNG 实例获取结果。
from langchain_community.utilities import SearxSearchWrapper
s = SearxSearchWrapper(searx_host="http://localhost:8888")
s.run("what is a large language model?")
工具
您还可以将此封装加载为工具(与代理一起使用)。
您可以这样做:
from langchain.agents import load_tools
tools = load_tools(["searx-search"],
searx_host="http://localhost:8888",
engines=["github"])
请注意,我们可以可选地传递自定义引擎使用。
如果您想以 json 格式获取带有元数据的结果,可以使用:
tools = load_tools(["searx-search-results-json"],
searx_host="http://localhost:8888",
num_results=5)
快速创建工具
此示例展示了一种从同一封装快速创建多个工具的方法。
from langchain_community.tools.searx_search.tool import SearxSearchResults
wrapper = SearxSearchWrapper(searx_host="**")
github_tool = SearxSearchResults(name="Github", wrapper=wrapper,
kwargs = {
"engines": ["github"],
})
arxiv_tool = SearxSearchResults(name="Arxiv", wrapper=wrapper,
kwargs = {
"engines": ["arxiv"]
})
有关工具的更多信息,请参见此页面。