Skip to content

Commit

Permalink
doc: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tjbck committed Jun 1, 2024
1 parent 902c2ae commit fd4eef4
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ Welcome to **Pipelines**, an [Open WebUI](https://github.com/open-webui) initiat

## 🚀 Why Choose Pipelines?

- **Seamless Integration:** Compatible with any UI/client supporting OpenAI API specs.
- **Limitless Possibilities:** Easily add custom logic and integrate Python libraries, from AI agents to home automation APIs.
- **Seamless Integration:** Compatible with any UI/client supporting OpenAI API specs.
- **Custom Hooks:** Build and integrate custom pipelines.

## 🔧 How It Works
Expand All @@ -20,6 +20,14 @@ Welcome to **Pipelines**, an [Open WebUI](https://github.com/open-webui) initiat

Integrating Pipelines with any OpenAI API-compatible UI client is simple. Launch your Pipelines instance and set the OpenAI URL on your client to the Pipelines URL. That's it! You're ready to leverage any Python library for your needs.

### Examples of What You Can Achieve:

- **Rate Limit Filter**: Control the flow of requests to prevent exceeding rate limits.
- **Real-Time Translation Filter with LibreTranslate**: Seamlessly integrate real-time translations into your LLM interactions.
- **Custom RAG Pipeline**: Implement sophisticated Retrieval-Augmented Generation pipelines tailored to your needs.
- **Function Calling Filter**: Easily handle function calls and enhance your applications with custom logic.
- **And Much More!**: The sky is the limit for what you can accomplish with Pipelines and Python.

## ⚡ Quick Start with Docker

> [!WARNING]
Expand Down

0 comments on commit fd4eef4

Please sign in to comment.