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.2.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.2-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: retrievify-0.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 7e37ddeb6918fcebb5b952904e20b6a64cd2ade39dd86182685f8dcc7853dfae
MD5 d45c3b11390a2356e2ad36e54d544dbd
BLAKE2b-256 a0ccaf798fe1b13172fe1fd0b6314f67ea184449349177542ec75dd57955581a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: retrievify-0.1.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f3943fde3dbd04220dd305c701886a6e106ebb90ede2b9f1f61f764b50c0b347
MD5 3ad6b86d483409af36cc75ab9980f787
BLAKE2b-256 fd59741f0cd71e360bca7ea316c4e34b6e671015d091ef54db6ab5e26354454a

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