Skip to main content

Caching based RAG primitives

Project description

rager

Composable RAG primitives with caching baked in.

Install

uv add rager

Getting started

uv run pytest
uv run prek install

For GPU (CUDA/ROCm) torch, add the matching PyTorch index to your own project and install torch from it — those builds aren't on PyPI.

Example

Wire the primitives together yourself — there is no hidden pipeline. This chunks documents, embeds and indexes each chunk, then answers a query from the nearest chunk:

chunker = SemanticChunker()
embedder = SentenceTransformerDenseEmbedder()
index = DenseIndex()
chunks = ChunkStore()
generator = TransformersGenerator()

for document in documents:
    for chunk in chunker.chunk(document):
       embedding = await embedder.embed(chunk)
       key = await index.add(embedding)
       chunks.add(key, chunk)

query = "Why do cats purr?"
(key,) = await index.similar(await embedder.embed(query), results=1)
answer = await generator.prompt(f"Answer using only the context.\n{chunks.get(key)}\n{query}")

tests/application/ has full dense and hybrid recipes.

API

Every stage is a Protocol with concrete implementations. async methods batch concurrent calls; model-backed methods cache results under .jar/.

Parsers — extract text units from files

  • Parser — protocol: units(file) returns text units, id(file) returns the content Hash.
  • UnstructuredFileParser — parses any file supported by unstructured.
  • PdfFileParser, MarkdownFileParser, CsvFileParser — aliases of UnstructuredFileParser for readable call sites.

Chunkers — split units into chunks

  • Chunker — protocol: chunk(unit) -> list[str].
  • SemanticChunker — splits on semantic boundaries with a token budget: SemanticChunker(model_name="gpt-3.5-turbo", chunk_size=1000, overlap=0).

Embedders — turn chunks into vectors

  • Embedder[E] — protocol: async embed(chunk) -> E.
  • SentenceTransformerDenseEmbedder — dense, L2-normalized DenseEmbedding via SentenceTransformers (default all-MiniLM-L6-v2).
  • SpladeSparseEmbedder — sparse SparseEmbedding via a SPLADE encoder (default prithivida/Splade_PP_en_v1).

Indexes — store vectors and search by similarity

  • Index[E, K] — protocol: async add(embedding) -> key, async remove(key), async similar(embedding, results=100) -> list[key]. Ranks by inner product (equals cosine for L2-normalized vectors). Keys are derived from embedding content, so adding the same vector twice yields one entry.
  • DenseIndex — flat FAISS index; DenseIndex(dimensions=None) infers width from the first vector unless fixed.
  • SparseIndex — inner-product search over sparse weight maps.

Fusers — merge ranked lists

  • Fuser[V] — protocol: fuse(*rankings) -> list[V].
  • ReciprocalRankFuser — reciprocal rank fusion with smoothing constant k (default 60).
  • BordaCountFuser — Borda count fusion.

Scorers — rerank chunks against a query

  • Scorer — protocol: async score(query, chunk) -> float.
  • CrossEncoderScorer — cross-encoder reranker (default cross-encoder/ms-marco-MiniLM-L6-v2).

Generators — produce an answer

  • Generator — protocol: async prompt(query) -> str.
  • TransformersGenerator — local Transformers text-generation model (default HuggingFaceTB/SmolLM2-135M-Instruct, max_new_tokens=512).

Stores — map index keys back to data

  • Store[V, K] — protocol: add(key, value), get(key) -> value | None, remove(key).
  • ChunkStore — in-memory map from key to chunk text, resolving a search hit to its source.
  • MetadataStore[M: Metadata] — in-memory map from key to per-chunk metadata.

Types

  • Hash — a blake3 hasher; the content ID returned by parsers.
  • DenseEmbeddinglist[float].
  • SparseEmbeddingdict[int, float] mapping token id to weight.
  • Metadata — protocol for metadata classes used with MetadataStore.

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

rager-0.1.3.tar.gz (13.8 kB view details)

Uploaded Source

Built Distribution

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

rager-0.1.3-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

Details for the file rager-0.1.3.tar.gz.

File metadata

  • Download URL: rager-0.1.3.tar.gz
  • Upload date:
  • Size: 13.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.24 {"installer":{"name":"uv","version":"0.11.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for rager-0.1.3.tar.gz
Algorithm Hash digest
SHA256 c0c4d0943d845b5611f271b799072ae07678bc4658af292cb9b32889f9e4f659
MD5 494a9cfba95a1e645ddd5533685fdcfd
BLAKE2b-256 ea0afbacd0217ed98d4dc46f6d797ee7ccdb8db61a1139dcff4c2f1fa0d1107e

See more details on using hashes here.

File details

Details for the file rager-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: rager-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 17.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.24 {"installer":{"name":"uv","version":"0.11.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for rager-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 239c2985e88570edf344f2ef740e7262eeac153ff611f5005cc3dd17b3eeb815
MD5 76188077f9b28a8e07f9058c74f25c1b
BLAKE2b-256 2c1c4104c4c29ad4bd7123dee63989fc0ea985ea8a070b4ec4b3cea33143f542

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