From 4f2110fbec4c58b479975bd9dc36bdd59b01f3ed Mon Sep 17 00:00:00 2001 From: "Timothy J. Baek" Date: Sun, 26 May 2024 00:52:53 -0700 Subject: [PATCH] Create README.md --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..87de8e8 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# Pipelines: OpenAI API Compatible Plugin Framework 🌟 + +Welcome to **Pipelines**, Open WebUI initiative that brings modular, customizable workflows to any UI client supporting OpenAI API specs – and much more! Dive into a world where you can effortlessly extend functionalities, integrate unique logic, and create dynamic agentic workflows, all with a few lines of code. + +## πŸš€ Why Pipelines? + +- **Seamless Integration:** Compatible with any UI/client that supports OpenAI API specs. +- **Endless Possibilities:** Got a specific need? Pipelines make it easy to add your custom logic and functionalities. Integrate any Python library, from AI agents via libraries like CrewAI to API calls for home automation – the sky's the limit! +- **Custom Hooks:** Build and integrate custom RAG (Retrospective Agent Guidance) pipelines and more. + +## πŸ”§ How It Works + +Integrating Pipelines with any OpenAI API-compatible UI client is a breeze. Simply launch your Pipelines instance and set the OpenAI URL on your client to the Pipelines URL. That's it! You're now ready to leverage any Python library, whether you want an agent to manage your home or need a custom pipeline for your enterprise workflow. + +## πŸŽ‰ Work in Progress + +We’re continuously evolving! We'd love to hear your feedback and understand which hooks and features would best suit your use case. Feel free to reach out and become a part of our Open WebUI community! + +Our vision is to push **Pipelines** to become the ultimate plugin framework for our AI interface, **Open-WebUI**. Imagine **Open-WebUI** as the WordPress of AI interfaces, with **Pipelines** being its diverse range of plugins. Join us on this exciting journey! 🌍