// rag · run-llama/rags

rags

Build a ChatGPT over your own data using natural language and LlamaIndex.

★ 6.5k stars⑂ 654 forksMITupdated 2024-04
▦ visual — this project's README ships no embeddable screenshot,
so here's a placeholder. The guide below is complete regardless.
// project facts

Project facts

rags is an open-source rag & knowledge project by run-llama (run-llama/rags on GitHub). It has 6,549 GitHub stars and 654 forks, is released under the MIT license, and was last updated on GitHub on 5 April 2024.

Repository
run-llama/rags
GitHub stars
6,549
Forks
654
License
MIT
Last updated on GitHub
5 April 2024
Listing
Full install guide
// how it works

How it works

  1. Clarify your data goal

    Decide which documents or data sources you want to chat with and what questions the app should answer.

  2. Clone and install

    Clone the repo and install dependencies with Poetry.

  3. Configure your model keys

    Add your OpenAI key (or configure Anthropic, Replicate or a local Hugging Face model) in the app's configuration.

  4. Build and chat

    Use the builder in natural language to configure chunking, embeddings and retrieval, then chat with the generated RAG agent.

// features

Why people love it

Natural-language builder agent

Describe what you want in plain language and the builder agent assembles the RAG application for you.

Configurable RAG settings

Tune the system prompt, top-k retrieval, chunk size, embedding model, LLM and whether to add a summarization tool.

Multiple LLM backends

Supports OpenAI, Anthropic and Replicate models, plus local Hugging Face models referenced as local:<model_name>.

Flexible embeddings

Uses OpenAI text-embedding-ada-002 by default and also supports local Hugging Face embedding models.

Streamlit interface

The generated app runs as a Streamlit UI with a home page, a RAG config page and the generated agent page.

Built on LlamaIndex

Uses the LlamaIndex framework from run-llama for indexing and querying your data.

Advertisement
// run it

Run it yourself

  1. Clone the repository

    Clone RAGs and enter the project directory.

    git clone https://github.com/run-llama/rags.git
    cd rags
  2. Install dependencies

    Install the project and its dev dependencies with Poetry.

    poetry install --with dev
  3. Launch the app

    Start the Streamlit interface, then build your RAG agent from the home page.

    streamlit run 1_🏠_Home.py
// use cases

What you can build

Advertisement
// faq

Questions, answered

Who maintains RAGs?

RAGs is a run-llama project — the team behind LlamaIndex.

Is RAGs free?

Yes, the code is MIT licensed. You pay only for any model APIs you choose to call.

Does it need a paid API key?

By default it uses OpenAI models and embeddings, which need an OpenAI API key; Anthropic and Replicate also need keys, while local Hugging Face models can run without one.

How does it compare to building with LlamaIndex directly?

RAGs is a builder on top of LlamaIndex: faster to get a working chat app via natural language, but less flexible than hand-writing your own LlamaIndex pipeline.

How do I get started?

Clone the repo, run poetry install --with dev, add your model key, and launch the Streamlit app.

// keep exploring

Similar tools

RAG & Knowledge

llm-graph-builder

Build Neo4j knowledge graphs from unstructured data using LLMs — then chat with your graph.

★ 5.3k starsApache-2.0
View guide →
RAG & Knowledge

SQLBot

SQLBot — DataEase's conversational analytics: ask in natural language, get SQL answers via LLMs plus RAG.

★ 6.9k starsGPL-3.0
View guide →
RAG & Knowledge

FastGPT

A knowledge-base platform with visual AI workflows — build Q&A systems on your own documents

★ 29.8k starsNOASSERTION
View guide →
RAG & Knowledge

deep-searcher

DeepSearcher — open-source deep research over your private data, with reasoning models and Milvus retrieval.

★ 8.3k starsApache-2.0
View guide →
RAG & Knowledge

xberg

Polyglot document intelligence in Rust — extract text, tables and structured data from 106 formats.

★ 9.4k starsMIT
View guide →
RAG & Knowledge

txtai

All-in-one AI framework for semantic search, LLM orchestration and language model workflows.

★ 13.0k starsApache-2.0
View guide →
// alternatives

Alternatives in RAG & Knowledge

The most-starred other RAG & Knowledge projects in the LibreAI catalogue — the realistic shortlist if rags is not the right fit.

Get rags

Free and open — grab the source, star the repo, and start creating.