Pre-release
This release is a pre-release and may not be stable for production use.
WhiskerRAG
WhiskerRAG 是为 PeterCat 和 Whisker 项目开发的 RAG（Retrieval-Augmented Generation）工具包，提供完整的 RAG 相关类型定义和方法实现。
特性
- 针对通用 RAG 的领域建模类型, 包括任务（Task）、知识（Knowledge）、分段(Chunk)、租户(Tenant)、知识库空间(Space)。
- Whisker rag 插件接口描述。
- Github 仓库、S3 资源管理器。
安装
使用 pip 安装：
pip install whiskerrag
快速开始
whiskerrag 包含三个子模块，分别是 whiskerrag_utils、whiskerrag_client、whiskerrag_types。它们分别有不同的用途：
whiskerrag_utils
包含了构建 RAG 系统的常用方法：
from whiskerrag_utils import loader,embedding,retriever
whiskerrag_client
将 RAG 系统服务通过 python sdk 的形式向外暴露。
from whiskerrag_client import APIClient
api_client = APIClient(
base_url="https://api.example.com",
token="your_token_here"
)
knowledge_chunks = await api_client.retrieval.retrieve_knowledge_content(
RetrievalByKnowledgeRequest(knowledge_id="your knowledge uuid here")
)
space_chunks = await api_client.retrieval.retrieve_space_content(
RetrievalBySpaceRequest(space_id="your space id here ")
)
chunk_list = await api_client.chunk.get_chunk_list(
page=1,
size=10,
filters={"status": "active"}
)
task_list = await api_client.task.get_task_list(
page=1,
size=10
)
task_detail = await api_client.task.get_task_detail("task_id_here")
whiskerrag_types
一些辅助开发的类型提示，接口；
from whiskerrag_types.interface import DBPluginInterface, TaskEngineInterface
from whiskerrag_types.model import Knowledge, Task, Tenant, PageParams, PageResponse
开发者指南
环境初始化
- 克隆项目
git clone https://github.com/petercat-ai/whiskerrag_toolkit.git
cd whiskerrag_toolkit
- 创建并激活虚拟环境
# 查看poetry配置
poetry config --list
# 修改 poetry 配置
poetry config virtualenvs.create true
poetry config virtualenvs.in-project true
poetry env use python3.10
# 激活虚拟环境
source .venv/bin/activate
- 安装依赖
# 安装项目依赖
poetry install
# 安装 pre-commit 工具
pre-commit install
- 运行测试
# 运行所有测试
poetry run pytest
# 运行指定测试文件
poetry run pytest tests/test_loader.py
- poetry 常用命令
# 安装依赖
poetry install
# 添加新依赖
poetry add package_name
# 添加新 dev 依赖
poetry add --dev package_name
# 更新依赖
poetry update
# 查看环境信息
poetry env info
# 查看已安装的包
poetry show
开发工作流
- 创建新分支
- 开发新功能，补充单元测试，确保代码质量。注意，请确保单元测试覆盖率不低于 80%。
- 提交代码，并创建 Pull Request。
- 等待代码审查，并根据反馈进行修改。
- 合并 Pull Request。
项目结构
whiskerRAG-toolkit/
├── src/
│ ├── whiskerrag_utils/
│ └── whiskerrag_types/
│ └── whiskerrag_client/
└── pyproject.toml
贡献指南
- Fork 本仓库
- 创建特性分支 (
make branch name=feature/amazing-feature) - 提交更改 (
git commit -m 'Add some amazing feature') - 推送到分支 (
git push origin feature/amazing-feature) - 开启 Pull Request
许可证
本项目采用 MIT 许可证 - 查看 LICENSE 文件了解详情
联系方式
项目维护者 - @petercat-ai
1 maintainer
Metadata
1 maintainer
Release files for whiskerrag 0.0.57.dev20250516025337
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| whiskerrag-0.0.57.dev20250516025337.tar.gz | 31.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| whiskerrag-0.0.57.dev20250516025337-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 86.2 kB
Release files / whiskerrag-0.0.57.dev20250516025337.tar.gz
| Download URL | whiskerrag-0.0.57.dev20250516025337.tar.gz |
|---|---|
| Size | 31.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2ad6ac8ecf9447949c86cc6a98d50bf954a671532fed72a2194e5673bf9fba59
|
|
BLAKE2b-256 checksum How to use checksums |
31ce68fd4fd04cee65ff9d68194df285a71d0b779c647f4bf3f50b17fe41891a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.1.3 CPython/3.12.10 Linux/6.11.0-1012-azure
|
Release files / whiskerrag-0.0.57.dev20250516025337-py3-none-any.whl
| Download URL | whiskerrag-0.0.57.dev20250516025337-py3-none-any.whl |
|---|---|
| Size | 54.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7fef5cc5957ba8c2256fb00159d97fae14ab3782645b2d48fe283effdd32ab1d
|
|
BLAKE2b-256 checksum How to use checksums |
8971296f5be361a47dfeb73ff0d9a7918b82460ece17522b55fe4bd522bfd158
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.1.3 CPython/3.12.10 Linux/6.11.0-1012-azure
|
