diff --git a/docs/pipelines/filters.md b/docs/pipelines/filters.md new file mode 100644 index 0000000..7d09e5e --- /dev/null +++ b/docs/pipelines/filters.md @@ -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. + +

+ + Filter Workflow + +

+ +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. \ No newline at end of file diff --git a/docs/pipelines/pipes.md b/docs/pipelines/pipes.md new file mode 100644 index 0000000..5e36411 --- /dev/null +++ b/docs/pipelines/pipes.md @@ -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). + +

+ + Pipe Workflow + +

\ No newline at end of file diff --git a/docs/pipelines/tutorials.md b/docs/pipelines/tutorials.md index 0c3cc2d..616668b 100644 --- a/docs/pipelines/tutorials.md +++ b/docs/pipelines/tutorials.md @@ -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. -

- - Under Construction - -

+## Tutorials +[Monitoring Open WebUI with Filters](https://medium.com/@0xthresh/monitor-open-webui-with-datadog-llm-observability-620ef3a598c6) \ No newline at end of file diff --git a/static/img/pipelines/filters.png b/static/img/pipelines/filters.png new file mode 100644 index 0000000..e6c970a Binary files /dev/null and b/static/img/pipelines/filters.png differ diff --git a/static/img/pipelines/pipes.png b/static/img/pipelines/pipes.png new file mode 100644 index 0000000..f317b6e Binary files /dev/null and b/static/img/pipelines/pipes.png differ