Pipelines：与 UI 无关 (UI-Agnostic) 的 OpenAI API 插件框架

[!TIP] 不要使用 Pipelines！

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

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

🚀 为什么选择 Pipelines？

• 无限可能： 轻松添加自定义逻辑并集成 Python 库，从 AI 智能体到家庭自动化 API。
• 无缝集成： 兼容任何支持 OpenAI API 规范的 UI/客户端。（仅支持管道型管道；过滤器类型需要客户端支持 Pipelines。）
• 自定义钩子 (Hooks)： 构建并集成自定义管道。

你可以实现的功能示例：

• 函数调用管道：轻松处理函数调用并使用自定义逻辑增强你的应用。
• 自定义检索增强生成 (RAG) 管道：实施复杂的检索增强生成管道以满足你的需求。
• 使用 Langfuse 进行消息监控：使用 Langfuse 实时监控和分析消息交互。
• 使用 Opik 进行消息监控：使用 Opik 监控和分析消息交互，Opik 是一个用于调试和评估 LLM 应用及 RAG 系统的开源平台。
• 速率限制过滤器：控制请求流量以防止超出速率限制。
• 使用 LibreTranslate 的实时翻译过滤器：将实时翻译无缝集成到你的 LLM 交互中。
• 有毒消息过滤器：实施过滤器以有效检测和屏蔽有毒消息。
• 以及更多！：有了 Pipelines 和 Python，一切皆有可能。查看我们的脚手架 (Scaffolds) 为你的项目起步，了解如何简化开发流程！

🔧 工作原理

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

⚡ Docker 快速开始

[!WARNING] Pipelines 是一个具有任意代码执行能力的插件系统——不要从不可信的来源获取随机管道。

Docker

使用 Docker 进行简化设置：

1. 运行 Pipelines 容器：

   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 中导航至 Settings > Connections > OpenAI API 部分。
   • 将 API URL 设置为 http://localhost:9099，将 API 密钥设置为 0p3n-w3bu!。此时你的管道应已激活。

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

3. 管理配置：

   • 在管理面板中，进入 Admin Settings > Pipelines tab。
   • 选择你想要的管道，并直接从 WebUI 修改阀门值 (Valve values)。

[!TIP] 如果你无法连接，这很可能是 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 集成。享受吧！

与 Open WebUI 一起使用 Docker Compose

使用 Docker Compose 可以简化多容器 Docker 应用程序的管理。

以下是使用 Docker Compose 设置 Open WebUI 和 Pipelines 的示例配置文件 docker-compose.yaml：

services:
  openwebui:
      image: ghcr.io/open-webui/open-webui:main
      ports:
        - "3000:8080"
      volumes:
        - open-webui:/app/backend/data

  pipelines:
      image: ghcr.io/open-webui/pipelines:main
      volumes:
        - pipelines:/app/pipelines
      restart: always
      environment:
        - PIPELINES_API_KEY=0p3n-w3bu!

volumes:
  open-webui: {}
  pipelines: {}

要启动你的服务，运行以下命令：

docker compose up -d

然后你可以使用 http://pipelines:9099（名称与 docker-compose.yaml 中定义的服务名称相同）作为 API URL 连接到 Open WebUI。

[!NOTE] pipelines 服务仅可由 openwebui Docker 服务访问，因此提供了额外的安全层。

📦 安装与设置

通过几个简单的步骤开始使用 Pipelines：

1. 确保已安装 Python 3.11。

2. 克隆 Pipelines 仓库：

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

3. 安装所需的依赖项：

   pip install -r requirements.txt
   

4. 启动 Pipelines 服务器：

   sh ./start.sh
   

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

高级 Docker 构建

如果您创建了自己的 pipelines（管道），可以在构建 Docker 镜像时安装它们。例如，使用下面的代码片段创建一个 bash 脚本，从路径收集文件，将它们添加为安装 URL，并构建已自动安装新 pipelines 的 Docker 镜像。

注意：pipelines 模块在启动时仍会尝试安装您在文件头中发现的任何包依赖项，但它们不会被再次下载。

# build in the specific pipelines
PIPELINE_DIR="pipelines-custom"
# assuming the above directory is in your source repo and not skipped by `.dockerignore`, it will get copied to the image
PIPELINE_PREFIX="file:///app"

# retrieve all the sub files
export PIPELINES_URLS=
for file in "$PIPELINE_DIR"/*; do
    if [[ -f "$file" ]]; then
        if [[ "$file" == *.py ]]; then
            if [ -z "$PIPELINES_URLS" ]; then
                PIPELINES_URLS="$PIPELINE_PREFIX/$file"
            else
                PIPELINES_URLS="$PIPELINES_URLS;$PIPELINE_PREFIX/$file"
            fi
        fi
    fi
done
echo "New Custom Install Pipes: $PIPELINES_URLS"

docker build --build-arg PIPELINES_URLS=$PIPELINES_URLS --build-arg MINIMUM_BUILD=true -f Dockerfile .

📂 目录结构和示例

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

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

集成示例

在 /examples 目录中找到各种集成示例。这些示例展示了如何集成不同的功能，为构建您自己的自定义 pipelines 提供基础。

🎉 进行中

我们一直在不断进化！我们非常乐意听取您的反馈，并了解哪些 hooks（钩子）和功能最适合您的用例。欢迎随时联系我们，成为我们 Open WebUI 社区的一员！

我们的愿景是推动 Pipelines 成为我们 AI 界面 Open WebUI 的最终插件框架。想象一下，Open WebUI 是 AI 界面的 WordPress，而 Pipelines 是其多样化的插件范围。加入我们这段激动人心的旅程吧！🌍

Pipelines 快速上手指南

📌 简介

Pipelines 是 Open WebUI 推出的一个 UI 无关的 OpenAI API 插件框架。它允许您通过 Python 代码轻松扩展功能、集成逻辑库和创建动态工作流。

[!TIP] 适用场景提示：如果您只是想添加 Anthropic 等支持或基础过滤器，建议使用 Open WebUI Functions。Pipelines 更适合处理计算密集型任务（如运行大模型），以便将负载从主实例卸载，提升性能与可扩展性。

---

1. 环境准备

• 系统要求: Linux / macOS / Windows
• 核心依赖:
  • Docker: 推荐使用 Docker 部署（推荐）。
  • Python: 3.11+ (仅用于源码安装模式)。
• 网络配置: 镜像源为 ghcr.io，国内用户建议配置 Docker 镜像加速器以确保拉取速度。

---

2. 安装步骤

方案一：Docker 部署 (推荐)

直接运行以下命令启动容器：

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

方案二：源码安装

1. 克隆仓库:

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

2. 安装依赖:

   pip install -r requirements.txt
   

3. 启动服务:

   sh ./start.sh
   

方案三：Docker Compose (配合 Open WebUI)

在 docker-compose.yaml 中添加如下配置：

services:
  pipelines:
      image: ghcr.io/open-webui/pipelines:main
      volumes:
        - pipelines:/app/pipelines
      restart: always
      environment:
        - PIPELINES_API_KEY=0p3n-w3bu!
volumes:
  pipelines: {}

启动服务：

docker compose up -d

---

3. 基本使用

连接客户端

在您的 OpenAI API 兼容客户端（如 Open WebUI）中进行如下设置：

• API URL: http://localhost:9099
  • 注：若 Open WebUI 也运行在 Docker 容器中，请将 localhost 替换为 host.docker.internal。
• API Key: 0p3n-w3bu!

管理与配置

1. 进入 Open WebUI 管理面板。
2. 导航至 Admin Settings > Pipelines tab。
3. 选择目标管道，直接在 WebUI 中修改 Valve values。
4. 支持直接粘贴管道 URL 进行安装（仅限无额外依赖的管道）。

自定义管道安装

如需安装带有额外依赖的自定义管道，可通过环境变量指定：

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

[!WARNING] 安全提示: Pipelines 支持任意代码执行，请勿从不可信来源获取或运行管道。