跳到主要内容
赞助商n8n
n8n
您的界面还没有后端吗？试试 n8n

Pipelines Logo

管道：UI无关的 OpenAI API 插件框架

警告

如果符合以下情况，请勿使用管道！

如果您的目标只是添加对其他提供商（如 Anthropic）或基本过滤器的支持，您可能不需要使用管道。对于这些情况，Open WebUI 函数更适合您——它是内置的，更方便，并且更容易配置。然而，当您处理计算密集型任务（例如，运行大型模型或复杂逻辑），希望将其从主 Open WebUI 实例中分载以获得更好的性能和可扩展性时，管道就派上用场了。

欢迎来到 管道，这是 Open WebUI 的一项倡议。管道为支持 OpenAI API 规范的任何 UI 客户端带来模块化、可定制的工作流——以及更多功能！只需几行代码，即可轻松扩展功能、集成独特逻辑并创建动态工作流。

🚀 为何选择管道？​

  • 无限可能： 轻松添加自定义逻辑并集成 Python 库，从 AI 代理到家庭自动化 API。
  • 无缝集成： 与任何支持 OpenAI API 规范的 UI/客户端兼容。（仅支持 pipe-type 管道；filter 类型需要客户端支持管道。）
  • 自定义钩子： 构建和集成自定义管道。

您可以实现的示例：​

🔧 工作原理​

Pipelines Workflow

将管道与任何兼容 OpenAI API 的 UI 客户端集成都很简单。启动您的管道实例，并将客户端上的 OpenAI URL 设置为管道 URL。就是这样！您已准备好利用任何 Python 库来满足您的需求。

⚡ 使用 Docker 快速入门​

警告

管道是一个带有任意代码执行功能的插件系统 — 不要从不受信任的来源获取随机管道。

使用 Docker 进行简化的设置

  1. 运行管道容器

    docker run -d -p 9099:9099 --add-host=host.docker.internal:host-gateway -v pipelines:/app/pipelines --name pipelines --restart always ghcr.io/open-webui/pipelines:main

  2. 连接到 Open WebUI

    • 在 Open WebUI 中导航到 管理面板 > 设置 > 连接 部分。
    • 当您在此页面上时，可以按下 + 按钮添加另一个连接。
    • 将 API URL 设置为 http://localhost:9099，将 API 密钥设置为 0p3n-w3bu!。
    • 添加并验证管道连接后，您将在已添加连接的 API 基本 URL 字段中看到一个图标。将鼠标悬停在该图标上时，它将被标记为 Pipelines。您的管道现在应该已激活。
信息

如果您的 Open WebUI 运行在 Docker 容器中，请将 API URL 中的 localhost 替换为 host.docker.internal。

  1. 管理配置

    • 在管理面板中，转到 管理面板 > 设置 > 管道 标签页。
    • 选择您想要的管道，并直接从 WebUI 修改阀门值。
提示

如果您无法连接，很可能是 Docker 网络问题。我们鼓励您自行排除故障，并在讨论论坛中分享您的方法和解决方案。

如果您需要安装一个带有额外依赖项的自定义管道

  • 运行以下命令

    docker run -d -p 9099:9099 --add-host=host.docker.internal:host-gateway -e PIPELINES_URLS="https://github.com/open-webui/pipelines/blob/main/examples/filters/detoxify_filter_pipeline.py" -v pipelines:/app/pipelines --name pipelines --restart always ghcr.io/open-webui/pipelines:main

或者，如果管道没有额外的依赖项，您可以通过在管理员设置中复制并粘贴管道 URL 直接安装管道。

就是这样！现在，您已准备好使用管道轻松构建可定制的 AI 集成。尽情享受吧！

📦 安装与设置​

通过几个简单的步骤开始使用管道

  1. 确保已安装 Python 3.11。 这是唯一官方支持的 Python 版本。

  2. 克隆管道仓库

    git clone https://github.com/open-webui/pipelines.git
    cd pipelines

  3. 安装所需的依赖项

    pip install -r requirements.txt

  4. 启动管道服务器

    sh ./start.sh

服务器运行后，将客户端上的 OpenAI URL 设置为管道 URL。这将解锁管道的全部功能，集成任何 Python 库并创建适合您需求的自定义工作流。

📂 目录结构和示例​

/pipelines 目录是您设置的核心。在这里添加新模块、定制现有模块并管理您的工作流。当服务器启动时，/pipelines 目录中的所有管道都将自动加载。

您可以使用 PIPELINES_DIR 环境变量将此目录从 /pipelines 更改到其他位置。

集成示例​

在 https://github.com/open-webui/pipelines/blob/main/examples 目录中找到各种集成示例。这些示例展示了如何集成不同的功能，为构建您自己的自定义管道提供了基础。

🎉 正在进行的工作​

我们正在持续发展！我们非常乐意听取您的反馈，并了解哪些钩子和功能最适合您的用例。欢迎随时联系并成为我们 Open WebUI 社区的一员！

我们的愿景是推动 管道 成为我们 AI 界面 Open WebUI 的终极插件框架。想象一下，将 Open WebUI 视为 AI 界面的 WordPress，而 管道 则是其多样化的插件。加入我们这个激动人心的旅程吧！🌍