whiskerrag 0.0.4

A utility package for RAG operations

WhiskerRAG

WhiskerRAG 是为 PeterCat 和 Whisker 项目开发的 RAG（Retrieval-Augmented Generation）工具包，提供完整的 RAG 相关类型定义和方法实现。

特性

• 领域建模类型
• 插件接口描述
• Github、S3 数据源加载器
• OpenAI Emedding

安装

使用 pip 安装：

pip install whiskerrag

快速开始

whiskerrag_utils

from whiskerrag_utils import loader,embedding,retriever

whiskerrag_client

from whiskerrag_client import ApiClient, Configuration
from whiskerrag_client.api import retrieval_api, knowledge_api, task_api

configuration = Configuration(host="http://localhost:8000", api_key="your_api_key")

api_client = ApiClient(configuration)

# knowledge
knowledge_instance = knowledge_api.KnowledgeApi(api_client)
knowledge_instance.add_knowledge()
knowledge_instance.get_knowledge_list()
# task
task_instance = task_api.TaskApi(api_client)
task_instance.get_task_list()
task_instance.get_task_detail()
# retrieval
retrieval_instance = retrieval_api.RetrievalApi(api_client)
retrieval_instance.retrieve_space_content()
retrieval_instance.retrieve_knowledge_content()

whiskerrag_types

from whiskerrag_types.interface import DBPluginInterface, TaskEngineInterface
from whiskerrag_types.model import Knowledge, Task, Tenant, PageParams, PageResponse

开发指南

环境设置

1. 克隆项目

git clone https://github.com/your-username/whiskerRAG-toolkit.git
cd whiskerRAG-toolkit

2. 创建并激活虚拟环境

make setup
source venv/bin/activate

开发工作流

1. 代码格式化

make format

2. 运行测试

# 运行所有测试
make test

# 运行特定测试文件
make test-file file=tests/test_specific.py

3. 代码检查

# 运行所有检查（lint, type check, test）
make check

# 仅运行 lint
make lint

# 仅运行类型检查
make lint-mypy

4. 生成测试覆盖率报告

make coverage

分支管理

创建新的功能分支：

make branch name=feature/new-feature

构建和发布

1. 构建包

make build

2. 检查构建的包

make check-build

3. 发布到 TestPyPI

make upload-test

4. 发布到 PyPI

make upload

5. 创建新版本发布

# 本地发布
make release-local new_version=X.Y.Z

其他命令

• 清理构建文件和缓存：

make clean

• 更新依赖版本：

make update-deps

• 运行 pre-commit 钩子：

make pre-commit

项目结构

whiskerRAG-toolkit/
├── src/
│   ├── whiskerrag_utils/
│   └── whiskerrag_types/
│   └── whiskerrag_client.py
├── requirements.txt
├── requirements-dev.txt
├── setup.py
└── Makefile

贡献指南

1. Fork 本仓库
2. 创建特性分支 (make branch name=feature/amazing-feature)
3. 提交更改 (git commit -m 'Add some amazing feature')
4. 推送到分支 (git push origin feature/amazing-feature)
5. 开启 Pull Request

许可证

本项目采用 MIT 许可证 - 查看 LICENSE 文件了解详情

联系方式

项目维护者 - @petercat-ai

项目链接：https://github.com/petercat-ai/whiskerrag_toolkit