Merge pull request #153 from 0xThresh/enh-pipelines-docs

Basic Pipes and Filters Docs
This commit is contained in:
Timothy Jaeryang Baek 2024-07-20 12:08:06 +02:00 committed by GitHub
commit 5f2f2e8a38
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 37 additions and 6 deletions

15
docs/pipelines/filters.md Normal file
View File

@ -0,0 +1,15 @@
---
sidebar_position: 1
title: "Filter Pipelines"
---
# Filter Pipelines
Filters are used to perform actions against incoming user messages and outgoing assistant (LLM) messages. Potential actions that can be taken in a filter include sending messages to monitoring platforms (such as Langfuse or DataDog), modifying message contents, blocking toxic messages, translating messages to another language, or rate limiting messages from certain users. A list of examples is maintained in the [Pipelines repo](https://github.com/open-webui/pipelines/tree/main/examples/filters). The general workflow can be seen in the image below.
<p align="center">
<a href="#">
<img src="/static/img/pipelines/filters.png" alt="Filter Workflow" />
</a>
</p>
When a filter pipeline is enabled on a model or pipe, the incoming message from the user (or "inlet") is passed to the filter for processing. The filter performs the desired action against the message before requesting the chat completion from the LLM model. Finally, the filter performs post-processing on the outgoing LLM message (or "outlet") before it is sent to the user.

13
docs/pipelines/pipes.md Normal file
View File

@ -0,0 +1,13 @@
---
sidebar_position: 2
title: "Pipes"
---
# Pipes
Pipes are functions that can be used to perform actions prior to returning LLM messages to the user. Examples of potential actions you can take with Pipes are Retrieval Augmented Generation (RAG), sending requests to non-OpenAI LLM providers (such as Anthropic, Azure OpenAI, or Google), or executing functions right in your web UI. A list of examples is maintained in the [Pipelines repo](https://github.com/open-webui/pipelines/tree/main/examples/pipelines).
<p align="center">
<a href="#">
<img src="/static/img/pipelines/pipes.png" alt="Pipe Workflow" />
</a>
</p>

View File

@ -1,9 +1,12 @@
---
sidebar_position: 3
title: "Tutorials"
---
# Tutorials
## WIP 🚧
## Tutorials Wanted!
Write a blog post or create a YouTube video about your pipeline setup, and we'll happily host it here.
<p align="center">
<a href="#">
<img src="/img/oi/cat.png" alt="Under Construction" />
</a>
</p>
## Tutorials
[Monitoring Open WebUI with Filters](https://medium.com/@0xthresh/monitor-open-webui-with-datadog-llm-observability-620ef3a598c6)

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB