This release is a pre-release and may not be stable for production use.
OpenRAG is a comprehensive Retrieval-Augmented Generation platform that enables intelligent document search and AI-powered conversations.
Users can upload, process, and query documents through a chat interface backed by large language models and semantic search capabilities. The system utilizes Langflow for document ingestion, retrieval workflows, and intelligent nudges, providing a seamless RAG experience.
Check out the documentation or get started with the quickstart.
Built with FastAPI and Next.js. Powered by OpenSearch, Langflow, and Docling.
✨ Highlight Features
- Pre-packaged & ready to run - All core tools are hooked up and ready to go, just install and run
- Agentic RAG workflows - Advanced orchestration with re-ranking and multi-agent coordination
- Document ingestion - Handles messy, real-world data with intelligent parsing
- Drag-and-drop workflow builder - Visual interface powered by Langflow for rapid iteration
- Modular enterprise add-ons - Extend functionality when you need it
- Enterprise search at any scale - Powered by OpenSearch for production-grade performance
🔄 How OpenRAG Works
OpenRAG follows a streamlined workflow to transform your documents into intelligent, searchable knowledge:
🚀 Install OpenRAG
To get started with OpenRAG, see the installation guides in the OpenRAG documentation:
✨ Quick Start Workflow
1. Launch OpenRAG
↓
2. Add Knowledge
↓
3. Start Chatting
📦 SDKs
Integrate OpenRAG into your applications with our official SDKs:
Python SDK
pip install openrag-sdk
Quick Example:
import asyncio
from openrag_sdk import OpenRAGClient
async def main():
async with OpenRAGClient() as client:
response = await client.chat.create(message="What is RAG?")
print(response.response)
if __name__ == "__main__":
asyncio.run(main())
📖 Full Python SDK Documentation
TypeScript/JavaScript SDK
npm install openrag-sdk
Quick Example:
import { OpenRAGClient } from "openrag-sdk";
const client = new OpenRAGClient();
const response = await client.chat.create({ message: "What is RAG?" });
console.log(response.response);
📖 Full TypeScript/JavaScript SDK Documentation
🔌 Model Context Protocol (MCP)
OpenRAG ships a built-in MCP server over streamable HTTP, mounted on your instance at /mcp. Connect AI assistants like Cursor, Claude Desktop, and IBM Bob to your OpenRAG knowledge base — no subprocess and no separate install. Authenticate with the same OpenRAG API key you use for the REST API, passed via the X-API-Key header.
Important: The standalone
openrag-mcpPyPI package is deprecated. Connect your MCP client directly to the/mcpendpoint instead.
Quick Example (Cursor/Claude Desktop config):
{
"mcpServers": {
"openrag": {
"url": "http://localhost:3000/mcp",
"headers": {
"X-API-Key": "orag_your_api_key_here"
}
}
}
}
The MCP server provides tools for RAG-enhanced chat, semantic search, document ingestion, knowledge filters, and settings management.
🛠️ Development
For developers who want to contribute to OpenRAG or set up a development environment, see CONTRIBUTING.md.
🛟 Troubleshooting
For assistance with OpenRAG, see Troubleshoot OpenRAG and visit the Discussions page.
To report a bug or submit a feature request, visit the Issues page.
3 maintainers
Metadata
3 maintainers
Release files for openrag 0.8.0.dev8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| openrag-0.8.0.dev8.tar.gz | 7.6 MB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| openrag-0.8.0.dev8-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 15.3 MB
Release files / openrag-0.8.0.dev8.tar.gz
| Download URL | openrag-0.8.0.dev8.tar.gz |
|---|---|
| Size | 7.6 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
95e32544f590c6745554e3c26b9fe0fd18b8ae401768df0f4a525a3c8c9e666e
|
|
BLAKE2b-256 checksum How to use checksums |
c5afc58157b48c610f3cf137799250e2f5d1ff175c596cf566ba330422e0d1fc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.23 {"installer":{"name":"uv","version":"0.12.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / openrag-0.8.0.dev8-py3-none-any.whl
| Download URL | openrag-0.8.0.dev8-py3-none-any.whl |
|---|---|
| Size | 7.7 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
96e1c5573eec4c1c765fc3afe121fc2b0b78d54e12c0d81719de5493000bb87d
|
|
BLAKE2b-256 checksum How to use checksums |
c60a876f7ba8ec6175908dfc3c93ef4740bc50031e43d63308a61e4738d65570
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.23 {"installer":{"name":"uv","version":"0.12.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for openrag 0.8.0.dev8
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
