**PurrfectKit** is a Python library for effortless Retrieval-Augmented Generation (RAG) workflows.
Project description
PurrfectKit
PurrfectKit is a toolkit that simplifies Retrieval-Augmented Generation (RAG) into 5 easy steps:
- Suphalak - read content from files
- Malet - split content into chunks
- WichienMaat - embed chunks into vectors
- KhaoManee - search vectors with queries
- Kornja - generate answers from vectors
NOTE: Each step is inspired by a unique Thai cat breed, making the workflow memorable and fun.
Quickstart
Prerequisites
- python
- tesseract
- git
Installation
pip install git+https://github.com/suwalutions/PurrfectKit.git
Usage
from purrfectmeow.meow.felis import DocTemplate, MetaFile
from purrfectmeow import Suphalak, Malet, WichienMaat, KhaoManee
file_path = 'test/test.pdf'
metadata = MetaFile.get_metadata(file_path)
content = Suphalak.reading(open(file_path, 'rb').read(), 'test.pdf', loader='PYMUPDF')
chunks = Malet.chunking(content, chunk_method='token', chunk_size='500', chunk_overlap='25')
docs = DocTemplate.create_template(chunks, metadata)
embedding = WichienMaat.embedding(chunks)
query = WichienMaat.embedding("ทดสอบ")
KhaoManee.searching(query, embedding, docs, 2)
📄 License
PurrfectKit is released under the MIT License.
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
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 purrfectkit-0.2.1.tar.gz.
File metadata
- Download URL: purrfectkit-0.2.1.tar.gz
- Upload date:
- Size: 10.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
394f3ffe1d51ece182749d265fbfe6b85543539f7cd9486fcdbf0fd18ebfd862
|
|
| MD5 |
b000981ed0b60a3c8334670c07a540ba
|
|
| BLAKE2b-256 |
92a2e4471016752115a4b91095dc4573c3677a40fce26a93e39c3abd73b21f3a
|
File details
Details for the file purrfectkit-0.2.1-py3-none-any.whl.
File metadata
- Download URL: purrfectkit-0.2.1-py3-none-any.whl
- Upload date:
- Size: 17.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ce6203eb1d2986d7f620cdfbd4f25d83315d6d9bc9b290f5730feb85f92c4391
|
|
| MD5 |
3e953f955580560f1b58ea8befbb7798
|
|
| BLAKE2b-256 |
63a6b9bab64d63eecd40ba1e42783800d0250b10d92e79b70270542a76244e98
|