ghcr.io/open-webui/pipelines:git-4197791-minimum

Pipelines：与UI无关的OpenAI API插件框架

请勿使用PIPELINES！

如果您的目标只是添加对Anthropic等其他提供商的支持或基本过滤器，您可能不需要Pipelines。对于这些情况，Open WebUI Functions是更好的选择——它是内置的，更方便且更易于配置。然而，当您处理计算密集型任务（例如运行大型模型或复杂逻辑），并希望将其从主Open WebUI实例卸载以获得更好的性能和可扩展性时，Pipelines就会发挥作用。

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

🚀 为什么选择Pipelines？

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

可以实现的示例：

• 函数调用Pipeline：轻松处理函数调用，并通过自定义逻辑增强您的应用程序。
• 自定义RAG Pipeline：实施为您的需求量身定制的复杂检索增强生成（RAG）pipeline。
• 使用Langfuse进行消息监控：使用Langfuse实时监控和分析消息交互。
• 使用Opik进行消息监控：使用Opik监控和分析消息交互，Opik是一个用于调试和评估LLM应用程序和RAG系统的开源平台。
• 速率限制过滤器：控制请求流以防止超过速率限制。
• 使用LibreTranslate的实时翻译过滤器：将实时翻译无缝集成到您的LLM交互中。
• 有害消息过滤器：实施过滤器以有效检测和处理有害消息。
• 以及更多！：使用Pipelines和Python可以实现的目标是无限的。查看我们的脚手架，为您的项目抢占先机，并了解如何简化您的开发流程！

🔧 工作原理

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

高级 Docker 构建

如果您创建了自己的 pipelines，可以在构建 Docker 镜像时安装它们。例如，创建一个包含以下代码片段的 bash 脚本，从指定路径收集文件，将它们作为安装 URL 添加，并构建自动安装了新 pipelines 的 Docker 镜像。

[!NOTE] 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 更改为其他位置。

就是这样！您现在已准备好使用Pipelines轻松构建可定制的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构建

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

[!NOTE] pipeline模块仍会在启动时尝试安装文件头中找到的任何包依赖项，但不会再次下载它们。

# 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目录中的所有pipeline将自动加载。

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

集成示例

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

🎉 开发中

我们在不断发展！我们很乐意听取您的反馈，并了解哪些钩子和功能最适合您的使用场景。欢迎联系我们，成为Open WebUI社区的一员！

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