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 パッケージを使用して、迅速にMPCサーバーを構築できます。

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 ファイルを参照してください。

⚠️ 重要提示

本文書内のすべての例と設定は一般的なガイドであり、具体的な実装は実際のニーズに合わせて調整する必要があります。