doc: readme

This commit is contained in:
Timothy J. Baek 2024-06-01 13:58:24 -07:00
parent fd4eef4bb2
commit 3205de817b

View File

@ -12,6 +12,14 @@ Welcome to **Pipelines**, an [Open WebUI](https://github.com/open-webui) initiat
- **Seamless Integration:** Compatible with any UI/client supporting OpenAI API specs.
- **Custom Hooks:** Build and integrate custom pipelines.
### Examples of What You Can Achieve:
- [**Rate Limit Filter**: Control the flow of requests to prevent exceeding rate limits.](/examples/filters/rate_limit_filter_pipeline.py)
- [**Real-Time Translation Filter with LibreTranslate**: Seamlessly integrate real-time translations into your LLM interactions.](/examples/filters/libretranslate_filter_pipeline.py)
- [**Custom RAG Pipeline**: Implement sophisticated Retrieval-Augmented Generation pipelines tailored to your needs.](/examples/rag/llamaindex_pipeline.py)
- [**Function Calling Filter**: Easily handle function calls and enhance your applications with custom logic.](/examples/function_calling/function_calling_filter_pipeline.py)
- **And Much More!**: The sky is the limit for what you can accomplish with Pipelines and Python.
## 🔧 How It Works
<p align="center">
@ -20,14 +28,6 @@ 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]