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='./docs')
vector_store = ChromaVectorStore(path="./chroma", 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 ingest documents into the vector store
rag.ingest(chunk_size=512, chunk_overlap=128)
# Use the RAG interface to generate a response to a query
response = rag.generate('What is the capital of France?')
print(response)
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ragy-0.1.7.tar.gz.
File metadata
- Download URL: ragy-0.1.7.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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b87cdef066d3af308914a8a1808c207ff66e21a4048b717851a643f38390bcb5
|
|
| MD5 |
057d260a36b2ab061653ad283b2fe7c3
|
|
| BLAKE2b-256 |
71521026c1c7c577c3d42a3e7cdb8d3b895e85440d4dd0497c68497798d0b49e
|
File details
Details for the file ragy-0.1.7-py3-none-any.whl.
File metadata
- Download URL: ragy-0.1.7-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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0d8eafcd231b37c518cd859cf625ee9816e5bc990734a5b1924c975df8aebd83
|
|
| MD5 |
7fdaa31f8cc5ce8f7915893ebc1cf4c7
|
|
| BLAKE2b-256 |
5212286aa7801cdfac6559013131c436bad33f28a906e8fa7cff0d36d66fb226
|