Ragrabbit

🚀 RagRabbit - 智能文檔檢索與生成系統

RagRabbit是一個基於大語言模型的智能文檔檢索與生成平臺，它支持通過語義搜索快速定位文檔內容，還具備上下文關聯分析功能，能有效提升文檔處理的效率和準確性。

🚀 快速開始

RagRabbit是一款強大的智能文檔檢索與生成平臺，以下為你介紹如何快速上手。

✨ 主要特性

• 智能檢索引擎：利用向量數據庫實現語義相似度匹配
• 上下文關聯分析：基於文本挖掘技術進行多輪對話支持
• 知識圖譜構建：自動生成文檔間的關聯關係
• 可插拔AI模型：支持多種大語言模型（如LLama系列）

📦 安裝指南

基本安裝

安裝依賴

pnpm install @ragrabbit/core @ragrabbit/ui

初始化配置文件

創建一個名為 config.json 的配置文件：

{
  "apiPort": 3000,
  "vectorDBConfig": {
    "type": "chroma",
    "host": "localhost",
    "port": 2000
  },
  "llmModel": {
    "type": "llama2"
  }
}

啟動服務

pnpm run dev

配置指南

智能檢索模塊配置

通過 vectorDBConfig 可以指定不同的向量數據庫實現：

{
  "vectorDBConfig": {
    "type": "faiss", // 支持的類型包括：chroma, faiss, milvus
    "host": "localhost",
    "port": 6345
  }
}

大語言模型配置

支持多種主流模型：

{
  "llmModel": {
    "type": "gpt-3", // 支持的類型包括：gpt-3, llama2, alpaca
    "apiEndpoint": "https://api.example.com/v1",
    "apiKey": "your-api-key"
  }
}

MPC服務器集成

搭建MPC服務器

通過 @ragrabbit/mcp 包快速搭建：

npx @ragrabbit/mcp start --port 3001

配置AI客戶端

在Claude Desktop中配置：

編輯 claude_desktop_config.json 文件，添加如下內容：

{
  "mcpServers": {
    "my-documentation": {
      "command": "npx",
      "args": ["@ragrabbit/mcp", "start"]
    }
  }
}

在ChatGPT中配置：

通過環境變量設置MPC服務器地址：

export MPC_SERVER=http://localhost:3001

與Fumadocs集成

快速集成

在項目根目錄下運行以下命令：

pnpm install @fumadocs/extension-rag

配置示例

添加如下配置到 config.json 文件中：

{
  "fumaIntegration": {
    "enabled": true,
    "apiKey": "your-fuma-api-key",
    "workspaceId": "your-workspace-id"
  }
}

開發指南

環境搭建

git clone https://github.com/ragrabbit-project/rag.git
cd rag
pnpm install

核心組件開發

向量數據庫接口

實現自定義向量數據庫：

interface VectorDB {
  init(): Promise<void>;
  addVectors(vectors: number[], metadata: object[]): Promise<string[]>;
  searchSimilar(id: string, k: number): Promise<SearchResult[]>;
}

文本處理管道

定義文本處理流程：

class TextProcessingPipeline {
  private tokenizer;
  private embeddings;

  constructor() {
    this.tokenizer = new Tokenizer();
    this.embeddings = new LlamaEmbedder();
  }

  async process(text: string): Promise<ProcessedText> {
    const tokens = this.tokenizer.tokenize(text);
    const embeds = await this.embeddings.embed(tokens);
    return { tokens, embeddings: embeds };
  }
}

貢獻指南

歡迎社區貢獻代碼！請參考 CONTRIBUTING.md 文件瞭解具體流程。

💻 使用示例

基礎用法

const rag = new RagManager({
  vectorDB: new ChromaDB(),
  llm: new Llama2()
});

async function search(query: string) {
  const results = await rag.search(query, { limit: 5 });
  return results.map(r => r.metadata);
}

📚 詳細文檔

核心功能

• 智能檢索：通過自然語言查詢快速定位文檔
• 上下文關聯：支持多輪對話和歷史記錄
• 知識圖譜：自動生成文檔間關係網絡
• 插件擴展：支持多種大語言模型和存儲後端

文檔結構

根目錄結構

project/
├── config.json          # 全局配置文件
├── package.json        # 項目依賴管理
├── src/                # 源代碼目錄
│   ├── core/           # 核心算法模塊
│   └── ui/             # 用戶界面組件
└── public/             # 靜態資源目錄

配置文件說明

config.json

{
  "mode": "development",      # 模式：開發或生產
  "vectorDBConfig": {         # 向量數據庫配置
    "type": "chroma",
    "host": "localhost",
    "port": 2000
  },
  "llmModel": {               # 大語言模型配置
    "type": "gpt-3",
    "apiKey": "..."
  }
}

項目維護者

• Marco D'Alì - 項目負責人
• 社區貢獻者 - 代碼貢獻者列表

📄 許可證

本項目遵循MIT開源協議，詳見 LICENSE 文件。

⚠️ 重要提示

本文檔中的所有示例和配置均為通用指導，具體實現需根據實際需求調整。