SAGE RAG

RAG (Retrieval-Augmented Generation) 组件库，提供文档加载、文本分块、检索和重排序功能。

🧭 边界说明（L3）

sage-rag 作为 L3 算法组件仓库，职责边界如下：

• In-scope（本仓库负责）
  • 文档加载（loaders）
  • 文本切分（chunkers）
  • 检索与重排实现（retrievers / rerankers）
  • RAG pipeline 组合逻辑（pipelines）
• Out-of-scope（不在本仓库实现）
  • 中间件/服务绑定能力（例如数据库服务编排、集群调度）
  • L4/L5 运行时和平台层实现
• Forbidden imports（禁止越层依赖）
  • sage.middleware
  • sage.kernel
  • sage.platform

边界与依赖审计 ADR：

• docs/adr/0001-l3-boundary-convergence.md
• docs/adr/0002-pipeline-boundary-cleanup.md
• docs/adr/0003-retriever-reranker-contracts.md
• docs/adr/0004-phase1-dependency-audit.md

📦 安装

pip install isage-rag

🚀 快速开始

# 直接导入使用
from sage_rag import TextLoader, SentenceChunker

loader = TextLoader()
documents = loader.load("document.txt")

chunker = SentenceChunker()
chunks = chunker.chunk(documents)

📚 组件

• Loaders: TextLoader, MarkdownLoader
• Chunkers: SentenceChunker, TokenChunker
• Retrievers: DenseRetriever
• Rerankers: CrossEncoderReranker
• Pipelines: SimpleRAGPipeline

DenseRetriever 需要显式提供 vector_store 与 embedding_model 后才能执行 index/retrieve/delete_documents。

详细文档请查看 docs/ 目录。

🔌 与 SAGE 集成

本包可以自动注册到 SAGE 框架：

import sage_rag  # 自动注册
from sage.libs.rag import create_loader

loader = create_loader("text")

📄 许可证

MIT License - 详见 LICENSE

📧 联系

• GitHub: https://github.com/intellistream/sage-rag
• Email: shuhao_zhang@hust.edu.cn