RagDocs

ragdocs

Ragdocs是一种尖端的开源解决方案，它彻底改变了您与文档的互动方式。通过将本地LLM的力量与最先进的检索型发电（RAG）相结合，开发人员可以立即从文档中获得准确的答案，而无需任何API成本。

告别昂贵的API电话和隐私问题。使用Ragdocs ，您的所有文档都保持私密，同时提供类似Chatgpt的互动。它是由Milvus Vector Search和Next.js构建的，它已经准备就绪且易于部署。通过完整的数据隐私和没有使用费来体验文档搜索的未来。

rag.demo.1.mp4

？特征

• ？智能聊天接口：针对技术文档的对话界面。
• ？尖端检索增强发电：准确和上下文感知的响应。
• ？本地LLM支持：与Ollama集成以供隐私和效率集成。
• MILVUS提供支持的矢量搜索：快速可扩展的文档查询。
• Modern Next.js Frontend ：时尚，实时用户体验。
• 多文件支持：无缝处理各种技术堆栈。
• ⚡快速文档处理：有效摄入和更新分析。
• 增量更新：使您的文档毫不费力地保持同步。

---

建筑学

 ragdocs/
├── data/                         # Documentation storage
│   ├── milvus_docs/              # Milvus documentation
│   ├── qdrant_docs/              # Qdrant documentation
│   └── weaviate_docs/            # Weaviate documentation
├── milvus/                       # Milvus standalone setup
│   └── standalone_embed.sh       # Milvus standalone script
├── ragdocs_api/                  # FastAPI backend
│   ├── conversation_api.py       # Chat API endpoints
│   ├── file_tracker.py           # Document change tracking
│   ├── llm_provider.py           # LLM integration (Ollama)
│   ├── markdown_processor.py     # Markdown processing
│   └── rag_system.py             # Core RAG implementation
└── ragdocs_frontend/             # Next.js frontend
    └── src/                      # Frontend source code

---

入门

先决条件

• Python 3.12+
• Node.js 20.17.0
• MILVUS 2.0+
• Ollama（用于本地LLM支持）

使用NVM安装node.js：

nvm install 20.17.0
nvm use 20.17.0

---

安装

1. 克隆存储库：

git clone https://github.com/AlexisBalayre/RagDocs.git
cd RagDocs

2. 安装Python依赖性：

 # Install poetry if not already installed
curl -sSL https://install.python-poetry.org | python3 -

# Install project dependencies
poetry install
poetry shell

关键依赖性：

• 骆驼指数：0.11.22
• FastApi：0.115.4
• Milvus-Lite：2.4.10
• 句子转换器：2.7.0
• 火炬：2.5.1

3. 安装前端依赖性：

 cd ragdocs_frontend
yarn

4. 设置环境变量：

cp example.env.local .env.local
# Edit .env.local with your configuration

5. 开始米尔维斯：

 cd milvus
bash standalone_embed.sh start

6. 运行后端：

poetry run uvicorn ragdocs_api.conversation_api:app --reload

7. 运行前端：

 cd ragdocs_frontend
yarn dev

---

用法

1. 添加文档：将文件放在data/下方的文件夹中。
2. 开始聊天：使用前端与文档聊天并探索您的文档。
3. 比较技术堆栈：利用内置比较功能进行分析。

---

？配置

为密钥设置编辑.env.local文件：

 MILVUS_HOST = localhost
MILVUS_PORT = 19530
OLLAMA_MODEL = llama3.2 

---

？贡献

鼓励捐款！请按照以下步骤：

1. 分叉存储库。
2. 创建一个功能分支：

git checkout -b feature/AmazingFeature

3. 提交您的更改：

git commit -m ' Add some AmazingFeature '

4. 推您的分支：

git push origin feature/AmazingFeature

5. 打开拉动请求。

---

执照

该项目已根据MIT许可获得许可。有关详细信息，请参见许可证文件。

---

致谢

• Vercel AI聊天机器人 - 前端的模板灵感。
• LlamainDex-为RAG功能提供动力。
• MILVUS-有效的向量搜索后端。
• Ollama-本地LLM支持。

---

支持

如果此项目为您的工作增加价值，请给它星星！

您的支持会有所作为，并鼓励进一步发展。总是欢迎反馈和功能建议！