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.4.tar.gz (9.4 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.4-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: retrievify-0.1.4.tar.gz
  • Upload date:
  • Size: 9.4 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.4.tar.gz
Algorithm Hash digest
SHA256 a94da5264624abeccd7f3dc4831f37efdb23e53df96eff4dc08fea57bba0bba2
MD5 b8646442d0bb77d3ead00a3bb653c4af
BLAKE2b-256 53dbc9a63d80efc91e61e7096ebb342fa26ad9c83678a534a67775de7952c13a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: retrievify-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 10.9 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 197ce9b779abe36454d643295cc29147bb77139598003b27dbb658075d721c11
MD5 8d80dc6499c30aa61094b893d819a22f
BLAKE2b-256 d84ec7c257f90ad3510464147e811fcc5b46fb0b7b8fc91800e45d405d1e1fa5

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