Skip to main content

Lightweight Retrieval-Augmented Generation (RAG) toolkit in 3 lines.

Project description

retrievify

PyPI Python License Downloads

Lightweight Retrieval-Augmented Generation (RAG) toolkit in 3 lines.

from retrievify import RAG
rag = RAG().fit("docs/", patterns=["*.pdf","*.md","*.txt"])
print(rag.ask("What are the core contributions?"))

Why retrievify?

  • ⚡ Fast local embeddings (MiniLM) by default
  • 🧱 Smart chunking & FAISS/Annoy vector stores (Windows-friendly)
  • 🧩 Optional LLM generation hook (OpenAI/Ollama)
  • 🛠️ CLI for quick indexing and querying

Install

pip install retrievify
# If FAISS is tricky on Windows, use Annoy:
pip install annoy

Quickstart

from retrievify import RAG
rag = RAG().fit("docs/")
res = rag.ask("What are the key limitations?", k=5)
print(res["evidence"][0])

CLI

retrievify index ./docs --pattern "*.pdf,*.md"
retrievify query ./docs -q "evaluation pipeline" -k 5 --generate

LLM (optional)

Set env var for OpenAI first:

$env:OPENAI_API_KEY="sk-..."

Then:

from retrievify import RAG
rag = RAG({"generation": True, "llm_backend": "openai"}).fit("docs/")
print(rag.ask("Summarize the paper")["answer"])

Roadmap

  • Cross-encoder re-ranking
  • HTML/URL loaders & deduplication
  • Simple retrieval eval (Recall@k, MRR, NDCG)

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

retrievify-0.1.1.tar.gz (9.2 kB view details)

Uploaded Source

Built Distribution

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

retrievify-0.1.1-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

Details for the file retrievify-0.1.1.tar.gz.

File metadata

  • Download URL: retrievify-0.1.1.tar.gz
  • Upload date:
  • Size: 9.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for retrievify-0.1.1.tar.gz
Algorithm Hash digest
SHA256 afb96dc7315a0d6ad2d8e6daa78611b6f0d7d1aca53254a9f5b3a7508db39801
MD5 09fff3b18460f6a4bbb1fbdf80314826
BLAKE2b-256 51f905bb1cb489103db62c2612bad050483b23519cb88d623273bd586d7fc821

See more details on using hashes here.

File details

Details for the file retrievify-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: retrievify-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 10.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for retrievify-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1d4d4868676367bb4239975e06c8f5d53775f8172fd86b321fde4a0b115816da
MD5 310b185ed7cefa45d8637493ded253fb
BLAKE2b-256 b358b593134c71f70b5ca95957f806a867310755cbd87248be6e595450b4845f

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