跳到主要内容
注意

本教程为社区贡献，不属于 Open WebUI 团队的官方支持范围。它仅用于演示如何针对特定用例自定义 Open WebUI。想要贡献？请查看贡献教程。

提示

有关与 Web Search 相关的所有环境变量的完整列表（包括并发设置、结果数量等），请参阅 Environment Configuration 环境变量配置文档。

故障排除

在网页搜索时遇到问题？请参阅 Web Search Troubleshooting Guide 网页搜索故障排除指南 以获取常见问题的解决方案，例如代理配置、连接超时和空内容。

Jina 网页搜索集成

本指南将指导您如何将强大的 AI 驱动的搜索基座 Jina AI 与 Open WebUI 集成。该集成使用 Jina 的 DeepSearch API 来提供网页搜索能力。

概述​

Jina AI 的 DeepSearch 不仅仅是一个简单的搜索 API；它是一个结合了网页搜索、阅读和推理以进行全面调查的自主代理（autonomous agent）。与依赖预训练知识的常规 LLM，或执行单次搜索的 RAG 系统不同，DeepSearch 会循环进行搜索、阅读和推理，并根据其发现动态决定下一步行动。它可以通过多次搜索和推理周期深入研究主题，并在返回结果之前自我评估其回答的质量。

OpenAI API 兼容性

Jina DeepSearch API 与 OpenAI Chat API 规范完全兼容。这意味着您只需将 API 端点（Endpoint）更改为 https://deepsearch.jina.ai/v1/chat/completions 并将模型名称设为 jina-deepsearch-v1，即可与任何兼容 OpenAI 的客户端配合使用。

定价与 API Key​

在 Open WebUI 中使用 Jina 的 DeepSearch API 需要一个 API Key。Jina 为新用户提供免费档，包含 1000 万个 token，可用于其任何模型。您可以通过在 Jina AI 平台上创建账户来获取免费的 API Key。

  • API Key：使用时需要 Jina API Key。您可以通过登录 Jina API Dashboard（控制面板）来获取密钥。

配置步骤​

1. 获取 Jina API Key​

请按照以下步骤获取 API Key：

  1. 访问 Jina API 控制面板：前往 jina.ai/api-dashboard。
  2. 登录或注册：创建一个新账户或登录您已有的账户。
  3. 获取您的 API Key：登录后，您专属的 API Key 将显示在控制面板上。复制此密钥。

2. 配置 Open WebUI​

要启用 Jina 网页搜索集成，请在 Open WebUI 的管理员设置中按照以下步骤操作：

  1. 以管理员身份登录：访问您的 Open WebUI 实例并使用管理员账户登录。
  2. 导航至网页搜索设置：前往 Admin Panel（管理面板），然后点击 Settings（设置） > Web Search（网页搜索）。
  3. 选择 Jina 作为搜索引擎：在“Web Search Engine”下拉菜单中选择 Jina。
  4. 输入您的 API Key：将您的 Jina API Key 粘贴到 Jina API Key 输入框中。
  5. （可选）输入 Jina API Base URL：如果您需要使用特定的端点（例如为了进行欧盟数据处理），请在 Jina API Base URL 输入框中输入它。默认值为 https://s.jina.ai/。
  6. 保存更改：向下滚动并点击 Save（保存）按钮应用更改。

3. 环境变量配置​

对于基于 Docker 的部署，您可以使用环境变量来配置 Jina 集成。

为您的 Open WebUI 实例设置以下环境变量：

  • JINA_API_KEY：您的 Jina API Key。
  • JINA_API_BASE_URL：（可选）自定义的 Jina API 端点。

Docker run 命令示例：

docker run -d \\
  -p 3000:8080 \\
  -e JINA_API_KEY="your-jina-api-key-here" \\
  --name open-webui \\
  ghcr.io/open-webui/open-webui:main

高级配置 (Jina API)​

虽然 Open WebUI 提供了极其直观的集成方式，但 Jina DeepSearch API 本身也提供了丰富的参数来微调其行为。这些参数属于 Jina API 的一部分，并不直接暴露在 Open WebUI 设置中，但对了解高级用例非常有帮助。

质量控制​

您可以使用以下参数来控制搜索结果质量与 token 消耗之间的平衡：

  • reasoning_effort：预设选项，用于调整 budget_tokens 和 max_attempts。选项有 low（低）、medium（中）和 high（高）。这是控制质量最简单的方法。
  • budget_tokens：设置允许用于整个 DeepSearch 流程的最大 token 数量。更高的预算通常能带来更好的回答质量。
  • max_attempts：系统重试解决问题的次数。
  • team_size：并行处理该问题的代理数量，有助于进行更广泛的研究。

数据源控制​

您可以控制 DeepSearch 从何处获取信息：

  • no_direct_answer：强制系统始终搜索网页，即使是简单的问题也是如此。
  • boost_hostnames：给予更高优先级的域名列表。
  • bad_hostnames：要严格排除的域名列表。
  • only_hostnames：仅包含的专属域名列表。

关于这些参数的更多细节，请参阅 Jina DeepSearch 官方文档。

验证集成​

配置完成后，您可以测试该集成。在聊天中启用网页搜索功能并提出一个问题。Open WebUI 现在将使用 Jina 的 DeepSearch 来检索并处理网页内容以回答您的查询。

This content is for informational purposes only and does not constitute a warranty, guarantee, or contractual commitment. Open WebUI is provided "as is." See your license for applicable terms.