Skip to main content

Retrieval-first, deterministic RAG infrastructure

Project description

Scaraflow

Scaraflow is a retrieval-first RAG infrastructure designed for deterministic, production-grade Retrieval-Augmented Generation.

Scaraflow is not an agent framework, not a prompt playground, and not a demo SDK. It focuses on one thing and does it rigorously:

Correct, explicit, and scalable retrieval for LLM systems


Why Scaraflow

Most RAG frameworks prioritize orchestration and abstraction. Scaraflow prioritizes retrieval correctness, predictability, and streaming readiness.

Design Principles

  • Retrieval before generation
  • Explicit contracts over magic
  • Deterministic behavior
  • Low-variance latency
  • Streaming-ready by design
  • Infrastructure consistency across dev, notebooks, and production

Architecture Overview

scaraflow/
├── scara-core        # strict contracts & invariants
├── scara-index       # vector store backends (Qdrant)
├── scara-rag         # deterministic RAG engine
├── scara-live        # streaming / temporal RAG (planned)
├── scara-graph       # graph-based RAG (planned)
└── scara-llm         # thin LLM adapters (planned)

Installation

pip install scaraflow

Note: Scaraflow depends on qdrant-client and standard scientific stack libraries.


Quick Start (Run in 30 Seconds)

The fastest way to try Scaraflow is with the In-Memory setup. No Docker or external database required.

1. Create a script demo.py

import uuid
from qdrant_client import QdrantClient
from sentence_transformers import SentenceTransformer
from scara_index.qdrant_store import QdrantVectorStore
from scara_index.config import QdrantConfig
from scara_rag.engine import RAGEngine
from scara_rag.policies import RetrievalPolicy

# 1. Setup Components
# Use in-memory Qdrant for instant setup
client = QdrantClient(":memory:")
store = QdrantVectorStore(
    QdrantConfig(collection="demo", vector_dim=384),
    client=client
)

model = SentenceTransformer("all-MiniLM-L6-v2")

# Wrap embedder to match protocol
class LocalEmbedder:
    def embed(self, text):
        return model.encode(text).tolist()

embedder = LocalEmbedder()

# 2. Initialize Engine
rag = RAGEngine(
    embedder=embedder,
    store=store,
    llm=lambda prompt: f"Generated answer based on: {len(prompt)} chars of context.",
)

# 3. Index Data
documents = [
    "Scaraflow is a retrieval-first RAG infrastructure.",
    "It prioritizes deterministic behavior and explicit contracts.",
    "Qdrant is the recommended vector backend for Scaraflow.",
]

vectors = model.encode(documents).tolist()
ids = [str(uuid.uuid4()) for _ in documents]

store.upsert(
    ids=ids,
    vectors=vectors,
    metadata=[{"content": doc} for doc in documents]
)

# 4. Query
response = rag.query(
    "What are the design principles of Scaraflow?",
    policy=RetrievalPolicy(top_k=2)
)

print(response.answer)

Option 2 — No Docker (In-Process Qdrant)

from qdrant_client import QdrantClient
from sentence_transformers import SentenceTransformer
from scara_index.qdrant_store import QdrantVectorStore
from scara_index.config import QdrantConfig
from scara_rag.engine import RAGEngine

client = QdrantClient(path="./qdrant_data")

store = QdrantVectorStore(
    QdrantConfig(
        collection="local_demo",
        vector_dim=384,
    ),
    client=client,
)

model = SentenceTransformer("all-MiniLM-L6-v2")
embedder = type("E", (), {"embed": lambda t: model.encode(t).tolist()})

rag = RAGEngine(
    embedder=embedder,
    store=store,
    llm=lambda _: "Demo answer",
)

store.upsert(
    ids=[0],
    vectors=[model.encode("Scaraflow works without Docker").tolist()],
    metadata=[{"mode": "local"}],
)

print(rag.query("How does Scaraflow run locally?").answer)

Production Setup (Docker / Cloud)

For production, connect Scaraflow to a persistent Qdrant instance.

# Start Qdrant locally
docker run -p 6333:6333 qdrant/qdrant
# Connect to local Docker or Qdrant Cloud
store = QdrantVectorStore(
    QdrantConfig(
        url="http://localhost:6333", # or your Cloud URL
        collection="prod_v1",
        vector_dim=384,
    )
)

Benchmarks

Generating 10000 synthetic documents... Benchmarking Embedding Time (SentenceTransformer)... Embedding Time: 34.9234s (286.3 docs/s)

--- Scaraflow Benchmark --- Indexing Time: 9.9117s [Scaraflow] Avg: 112.96ms, P95: 165.32ms, Std: 47.31ms

--- LangChain Benchmark --- Indexing Time: 13.0563s [LangChain] Avg: 134.25ms, P95: 189.02ms, Std: 39.40ms

--- LlamaIndex Benchmark --- LLM is explicitly disabled. Using MockLLM. Indexing Time: 8.9368s [LlamaIndex] Avg: 118.87ms, P95: 167.79ms, Std: 43.85ms

====================================================================== Framework | Index (s) | Avg Lat (ms) | P95 (ms) | Std (ms)

Scaraflow | 9.9117 | 112.96 | 165.32 | 47.31
LangChain | 13.0563 | 134.25 | 189.02 | 39.40
LlamaIndex | 8.9368 | 118.87 | 167.79 | 43.85

Embedding Time (common): 34.9234s

Scaraflow includes a built-in benchmarking suite to verify infrastructure performance.

Benchmarks can be run using:

python testing/benchmarks.py

License

MIT License


Author

Built and maintained by Ganesh (K. S. N. Ganesh).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scaraflow-0.1.5.tar.gz (14.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

scaraflow-0.1.5-py3-none-any.whl (16.7 kB view details)

Uploaded Python 3

File details

Details for the file scaraflow-0.1.5.tar.gz.

File metadata

  • Download URL: scaraflow-0.1.5.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for scaraflow-0.1.5.tar.gz
Algorithm Hash digest
SHA256 50a1cc4492085ce060d62fff2f605b4fc5d6dff574e8bca1717395c7d59ce4ed
MD5 bfb449b39c65332410caa44d840636a6
BLAKE2b-256 a077b4919ae375021cb4f5e601c5430991e822475170dcf2906df5e204f9a769

See more details on using hashes here.

File details

Details for the file scaraflow-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: scaraflow-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 16.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for scaraflow-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 8cf00e3cee1af46b2b55e8dcca6d27772fc6162ed54d60c4cdf0bd6fc90fc970
MD5 5a5100e65e9a4a8332ce757760e22282
BLAKE2b-256 c92b13ef84fa73c810b67000ecb8121bd79b445c629f54ecc74731460ef8e79b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page