Haiku.rag

🚀 Haiku RAG

LanceDB、Pydantic AI、Docling を基盤としたエージェンティックなRAGシステムです。

✨ 主な機能

• ハイブリッド検索 — ベクトル検索と全文検索をReciprocal Rank Fusionで統合
• 再ランキング — MxBAI、Cohere、Zero Entropy、またはvLLMを利用
• 質問応答 — 引用（ページ番号、セクション見出し）付きのQAエージェント
• 調査エージェント — pydantic-graphを介したマルチエージェントワークフロー：計画、検索、評価、合成
• 文書構造 — 完全な DoclingDocument を保存し、構造を考慮したコンテキスト拡張を可能に
• ビジュアルグラウンディング — 元のページ画像上でチャンクをハイライト表示
• タイムトラベル — --before を使用して任意の過去の時点でデータベースをクエリ
• 複数のプロバイダ — 埋め込み：Ollama、OpenAI、VoyageAI、LM Studio、vLLM。QA/調査：Pydantic AIがサポートする任意のモデル
• ローカルファースト — 組み込みのLanceDBを使用し、サーバー不要。S3、GCS、Azure、LanceDB Cloudもサポート
• MCPサーバー — AIアシスタント（Claude Desktopなど）用のツールとして公開
• ファイル監視 — ディレクトリを監視し、変更時に自動インデックス化
• インスペクター — 文書、チャンク、検索結果を閲覧するためのTUI
• CLIとPython API — コマンドラインまたはコードから全機能を利用可能

📦 インストール

Python 3.12以上が必要です

フルパッケージ（推奨）

uv pip install haiku.rag

文書処理、すべての埋め込みプロバイダ、再ランカーを含むすべての機能が利用可能です。

スリムパッケージ（最小限の依存関係）

uv pip install haiku.rag-slim

必要な追加機能のみをインストールします。利用可能なオプションについては、インストール ドキュメントを参照してください。

🚀 クイックスタート

# PDFをインデックス化
haiku-rag add-src paper.pdf

# 検索
haiku-rag search "attention mechanism"

# 引用付きで質問する
haiku-rag ask "What datasets were used for evaluation?" --cite

# ディープQA — 複雑な質問をサブクエリに分解
haiku-rag ask "How does the proposed method compare to the baseline on MMLU?" --deep

# 調査モード — 反復的な計画と検索
haiku-rag research "What are the limitations of the approach?" --verbose

# 対話型調査 — ヒューマンインザループで決定ポイントを持つ
haiku-rag research "Compare the approaches discussed" --interactive

# ディレクトリの変更を監視する
haiku-rag serve --monitor

カスタマイズオプションについては、設定 を参照してください。

💻 使用例

基本的な使用法

from haiku.rag.client import HaikuRAG

async with HaikuRAG("research.lancedb", create=True) as rag:
    # 文書をインデックス化
    await rag.create_document_from_source("paper.pdf")
    await rag.create_document_from_source("https://arxiv.org/pdf/1706.03762")

    # 検索 — 出所付きのチャンクを返す
    results = await rag.search("self-attention")
    for result in results:
        print(f"{result.score:.2f} | p.{result.page_numbers} | {result.content[:100]}")

    # 引用付きのQA
    answer, citations = await rag.ask("What is the complexity of self-attention?")
    print(answer)
    for cite in citations:
        print(f"  [{cite.chunk_id}] p.{cite.page_numbers}: {cite.content[:80]}")

AG-UI を使用した調査エージェントとストリーミングについては、エージェントドキュメント を参照してください。

MCPサーバー

Claude DesktopなどのAIアシスタントで使用するには：

haiku-rag serve --mcp --stdio

Claude Desktopの設定に追加します：

{
  "mcpServers": {
    "haiku-rag": {
      "command": "haiku-rag",
      "args": ["serve", "--mcp", "--stdio"]
    }
  }
}

AIアシスタント内で直接文書管理、検索、QA、調査のツールを利用できます。

サンプル

動作するサンプルについては、サンプルディレクトリ を参照してください：

• 対話型調査アシスタント — Pydantic AIとAG-UIを使用したフルスタックの調査アシスタントで、ヒューマンインザループによる承認とリアルタイムの状態同期を備えています。
• Dockerセットアップ — ファイル監視とMCPサーバーを備えた完全なDockerデプロイメント
• A2Aサーバー — 会話型エージェントインターフェイスを備えた自己完結型のA2Aプロトコルサーバーパッケージ

📚 ドキュメント

完全なドキュメントはこちら：https://ggozad.github.io/haiku.rag/

• インストール — プロバイダのセットアップ
• 設定 — YAML設定
• CLI — コマンドリファレンス
• Python API — 完全なAPIドキュメント
• エージェント — QAエージェントとマルチエージェント調査
• サーバー — ファイル監視、MCP、AG-UI
• MCP — モデルコンテキストプロトコルの統合
• インスペクター — データベースブラウザTUI
• ベンチマーク — パフォーマンスベンチマーク
• 変更履歴 — バージョン履歴

mcp-name: io.github.ggozad/haiku-rag