Lancedb

🚀 LanceDB Node.js ベクトル検索

このプロジェクトは、Node.jsを使用したベクトル検索のサンプルで、LanceDBとOllamaの埋め込みモデルを組み合わせています。

🚀 クイックスタート

このプロジェクトは、以下のことを行う方法を示しています。

• LanceDBデータベースに接続する
• Ollamaを使用してカスタム埋め込み関数を作成する
• ベクトル類似度検索を実行して、保存されたドキュメントを検索する
• 検索結果を処理して表示する

✨ 主な機能

• LanceDBデータベースへの接続機能
• Ollamaを用いたカスタム埋め込み関数の作成機能
• ベクトル類似度検索機能
• 検索結果の処理と表示機能

📦 インストール

前提条件

• Node.js（v14以上）
• nomic-embed-textモデルが設定された、ローカルで実行されているOllamaサービス
• LanceDBの保存場所に対する読み書き権限

インストール手順

1. リポジトリをクローンします。
2. 依存関係をインストールします。

pnpm install

依存関係

• @lancedb/lancedb：Node.js用のLanceDBクライアントを接続するためのパッケージ
• apache-arrow：列データを処理するためのパッケージ
• node-fetch：Ollama APIにリクエストを送信するためのパッケージ

💻 使用例

基本的な使用法

ベクトル検索テストスクリプトを実行します。

pnpm test-vector-search

または、直接実行することもできます。

node test-vector-search.js

設定

スクリプトは以下のサービスに接続します。

• 指定されたパスにあるLanceDB
• http://localhost:11434/api/embeddingsにあるOllama API

MCP設定

Claude DesktopでこれをMCPサービスとして使用するには、以下の内容をMCP設定JSONファイルに追加します。

{
  "mcpServers": {
    "lanceDB": {
      "command": "node",
      "args": [
        "/path/to/lancedb-node/dist/index.js",
        "--db-path",
        "/path/to/your/lancedb/storage"
      ]
    }
  }
}

以下のパスを実際のパスに置き換えてください。

• /path/to/lancedb-node/dist/index.js - Node.jsサービスの実際のインストール場所
• /path/to/your/lancedb/storage - LanceDBの保存ディレクトリの実際のパス

カスタム埋め込み関数

プロジェクトには、カスタムのOllamaEmbeddingFunctionが含まれており、以下のことを行います。

• テキストをOllama APIに送信して処理する
• 768次元の埋め込みベクトルを受け取る
• LanceDBの要件に合わせて出力をフォーマットする

ベクトル検索の例

サンプルコードでは、「ai-rag」テーブルで「how to define success criteria」を検索し、一致する結果とその類似度スコアを表示する方法を示しています。

📄 ライセンス

MIT License

貢献ガイド

どんな貢献も歓迎します！自由にPull Requestを送信してください。