b88c8b20df
* models query combined * make endpoint to handle provider health * provider health banner * update-pdf-to-include-provider-selection (#344) * polishing the error fixing experience * fix agent instructions and up char limit * fix provider * disable tracing in langflow * improve docling serve banner remove false positives * Changed pyproject.toml docling versions * Added another uv lock revision * version bump * unused things and fix bad conflicts * add isFetching to the hook * put back settings for models queries to never cache results * update banner refetching indicator * validate provider settings when saving * fix settings page layout issue * Added retry as false on the get models, to not take a long time --------- Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Co-authored-by: Mike Fortman <michael.fortman@datastax.com> Co-authored-by: phact <estevezsebastian@gmail.com> Co-authored-by: Lucas Oliveira <lucas.edu.oli@hotmail.com> |
||
|---|---|---|
| .github/workflows | ||
| assets | ||
| docs | ||
| documents | ||
| flows | ||
| frontend | ||
| keys | ||
| scripts | ||
| securityconfig | ||
| src | ||
| tests | ||
| .dockerignore | ||
| .env.example | ||
| .gitignore | ||
| .python-version | ||
| CONTRIBUTING.md | ||
| docker-compose-cpu.yml | ||
| docker-compose.yml | ||
| Dockerfile | ||
| Dockerfile.backend | ||
| Dockerfile.frontend | ||
| Dockerfile.langflow | ||
| LICENSE | ||
| Makefile | ||
| MANIFEST.in | ||
| pyproject.toml | ||
| README.md | ||
| uv.lock | ||
| warm_up_docling.py | ||
OpenRAG
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. Built with Starlette and Next.js. Powered by OpenSearch, Langflow, and Docling.
Quickstart
To quickly run OpenRAG without creating or modifying any project files, use uvx:
uvx openrag
This runs OpenRAG without installing it to your project or globally.
To run a specific version of OpenRAG, add the version to the command, such as: uvx --from openrag==0.1.25 openrag.
Install Python package
To first set up a project and then install the OpenRAG Python package, do the following:
-
Create a new project with a virtual environment using
uv init.uv init YOUR_PROJECT_NAME cd YOUR_PROJECT_NAMEThe
(venv)prompt doesn't change, butuvcommands will automatically use the project's virtual environment. For more information on virtual environments, see the uv documentation. -
Add OpenRAG to your project.
uv add openragTo add a specific version of OpenRAG:
uv add openrag==0.1.25 -
Start the OpenRAG TUI.
uv run openrag -
Continue with the Quickstart.
For the full TUI installation guide, see TUI.
Docker or Podman installation
For more information, see Install OpenRAG containers.
Troubleshooting
For common issues and fixes, see Troubleshoot.
Development
For developers wanting to contribute to OpenRAG or set up a development environment, see CONTRIBUTING.md.