Initial filters documentation, base layout for others

This commit is contained in:
0xThresh.eth 2024-07-17 16:36:32 -06:00
parent d716938efe
commit 84a8819b51
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
<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