外部搜索

warning

本教程是社区贡献，不受Open WebUI团队支持。它仅作为如何为您的特定用例自定义Open WebUI的演示。想要贡献？请查看贡献教程。

外部网络搜索API

此选项允许您将Open WebUI连接到您自己的自托管网络搜索API端点。这在以下情况下很有用：

集成Open WebUI原生不支持的搜索引擎。
实现自定义搜索逻辑、过滤或结果处理。
使用私有或内部搜索索引。

Open WebUI设置

导航到Open WebUI 管理面板。
进入设置选项卡，然后选择网络搜索。
将启用网络搜索切换到开启位置。
从下拉菜单中将网络搜索引擎设置为external。
用您的自定义搜索API端点的完整URL填写外部搜索URL（例如，http://localhost:8000/search或https://my-search-api.example.com/api/search）。
用与您的自定义搜索端点进行身份验证所需的秘密API密钥填写外部搜索API密钥。如果您的端点不需要身份验证，请留空（不推荐用于公共端点）。
点击保存。

Open WebUI管理面板显示外部搜索配置

API规范

Open WebUI将与您的外部搜索URL进行如下交互：

方法： POST
请求头：
- Content-Type: application/json
- Authorization: Bearer <YOUR_EXTERNAL_SEARCH_API_KEY>
请求体（JSON）：
```
{
  "query": "用户的搜索查询字符串",
  "count": 5 // 请求的最大搜索结果数量
}
```
- query（字符串）：用户输入的搜索词。
- count（整数）：Open WebUI期望的建议最大结果数量。如有必要，您的API可以返回更少的结果。
期望的响应体（JSON）： 您的API端点必须返回一个搜索结果对象的JSON数组。每个对象应具有以下结构：
```
[
  {
    "link": "搜索结果的URL",
    "title": "搜索结果页面的标题",
    "snippet": "搜索结果页面的简要描述或片段"
  },
  {
    "link": "...",
    "title": "...",
    "snippet": "..."
  }
  // ... 可能还有更多结果，最多达到请求的数量
]
```
- link（字符串）：搜索结果的直接URL。
- title（字符串）：网页的标题。
- snippet（字符串）：来自与查询相关的页面内容的描述性文本片段。
如果发生错误或找不到结果，您的端点理想情况下应返回一个空的JSON数组[]。

示例实现（Python/FastAPI）

以下是使用Python与FastAPI和duckduckgo-search库的自托管搜索API的简单示例。

import uvicorn
from fastapi import FastAPI, Header, Body, HTTPException
from pydantic import BaseModel
from duckduckgo_search import DDGS

EXPECTED_BEARER_TOKEN = "your_secret_token_here"

app = FastAPI()


class SearchRequest(BaseModel):
    query: str
    count: int


class SearchResult(BaseModel):
    link: str
    title: str | None
    snippet: str | None


@app.post("/search")
async def external_search(
    search_request: SearchRequest = Body(...),
    authorization: str | None = Header(None),
):
    expected_auth_header = f"Bearer {EXPECTED_BEARER_TOKEN}"
    if authorization != expected_auth_header:
        raise HTTPException(status_code=401, detail="Unauthorized")

    query, count = search_request.query, search_request.count

    results = []
    try:
        with DDGS() as ddgs:
            search_results = ddgs.text(
                query, safesearch="moderate", max_results=count, backend="lite"
            )

        results = [
            SearchResult(
                link=result["href"],
                title=result.get("title"),
                snippet=result.get("body"),
            )
            for result in search_results
        ]

    except Exception as e:
        print(f"DuckDuckGo搜索过程中出错：{e}")

    return results


if __name__ == "__main__":
    uvicorn.run("main:app", host="0.0.0.0", port=8888)

外部网络搜索API​

Open WebUI设置​

API规范​

示例实现（Python/FastAPI）​

外部网络搜索API

Open WebUI设置

API规范

示例实现（Python/FastAPI）