Skip to main content

A simple RAG (Retrieval-Augmented Generation) framework for Python.

Project description

RAGy

RAGy is a simple framework for building Retrieval-Augmented Generation (RAG) applications. It provides a set of tools and utilities to help you create RAG applications quickly and easily.

It ships with a simple interface for building RAG applications, as well as a set of pre-built components that you can use to get started quickly (OpenAI LLMs, Chroma vector stores, etc.).

Installation

You can install RAGy using pip:

pip install ragy

Usage

Here's a simple example of how to use RAGy to build a RAG application:

from ragy.rag import RAG
from ragy.reasoning import OpenAIEmbeddingModel, OpenAIGPTEngine
from ragy.rawdoc import DirectoryRawDocumentRetriever
from ragy.vector import ChromaVectorStore

# Create a RAG interface with the necessary components
system_prompt = "You are a helpful assistant that provides accurate information."
embedding_model = OpenAIEmbeddingModel(model='text-embedding-3-small')
raw_document_retriever = DirectoryRawDocumentRetriever(dir='path/to/documents')
vector_store = ChromaVectorStore(collection_name='my_collection')
ai_engine = OpenAIGPTEngine(model='gpt-5.2')

rag = RAG(
    system_prompt=system_prompt,
    embedding_model=embedding_model,
    raw_document_retriever=raw_document_retriever,
    vector_store=vector_store,
    ai_engine=ai_engine
)

# Use the RAG interface to generate a response to a query
response = rag.generate('What is the capital of France?')
print(response)

# Use the RAG interface to ingest documents into the vector store
rag.ingest(chunk_size=512, chunk_overlap=128)

Contributing

Contributions to RAGy are welcome! If you have an idea for a new feature or improvement, please open an issue or submit a pull request.

License

RAGy is licensed under the MIT License. See the LICENSE file for more information.

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

ragy-0.1.3.tar.gz (7.9 kB view details)

Uploaded Source

Built Distribution

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

ragy-0.1.3-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ragy-0.1.3.tar.gz
Algorithm Hash digest
SHA256 9ca4ad420004487d2ecb5537727721c76c5f54a1b709208d94b88118a40c56b0
MD5 fcb50e933618b740e6d7c01479e64bf9
BLAKE2b-256 a9c265c8e73dc02c001f66f1262919ab79caa956efb42b5877dbbc722fae994c

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ragy-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ade616af09b172578b91306aafadeb2097efa079b4681178d7f31ce857a04556
MD5 157dadfe89100fd7ccc88fb23fcbf148
BLAKE2b-256 dd6277683eb7181781637b18339deaf002b6b719106a2635a3655ed85c88f9e5

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