Quickstart

Get a working RAG system in under 5 minutes using free providers.

1. Install

pip install ragway[groq,faiss,bge]

2. Get a free Groq key

3. Write rag.yaml

version: "1.0"
pipeline: naive
 
plugins:
  llm:
    provider: groq
    model: llama-3.3-70b-versatile
    api_key: YOUR_GROQ_KEY
 
  embedding:
    provider: bge
    model: BAAI/bge-large-en-v1.5
 
  vectorstore:
    provider: faiss
    index_path: .ragway/index
 
  reranker:
    enabled: false
 
  chunking:
    strategy: recursive
    chunk_size: 512
    overlap: 50

4. Run

from ragway import RAG
import asyncio
 
rag = RAG.from_config("rag.yaml")
 
async def main():
    await rag.ingest("./my_docs/")
    answer = await rag.query("What is in my documents?")
    print(answer)
 
asyncio.run(main())

5. CLI

rag ingest ./my_docs/ --config rag.yaml
rag query "What is in my documents?" --config rag.yaml

Introduction Installation