mcpField
N
nemo-retriever

nemo-retriever

github.com/nvidiaドキュメント3.0k70 回インストール今日更新
リポジトリ

nemo-retriever について

NeMo Retrieverは、ドキュメントをインデックスに取り込み、内容を検索するコマンドラインツールです。ローカルインデックスや既存の Retriever サービスを使うワークフロー向けで、根拠に基づく回答用の形式で結果を返します。

主な機能

  1. 01ドキュメントをローカルインデックスに取り込み
  2. 02ローカルまたはデプロイ済みサービスを検索
  3. 03根拠形式で結果を返却
  4. 04サービスのBearer認証に対応

活用シーン

  1. 01ドキュメント検索用のローカルインデックス作成
  2. 02既存の Retriever サービスへのクエリ
  3. 03回答で検索根拠とソースメタデータを利用

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/nvidia/nemo-retriever --skill nemo-retriever

インストール後、Claude Code で/nemo-retrieverを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

BENCHMARK.md
skill-card.md
skill.oms.sig
evals/
evals.json

詳細

NeMo Retriever

retriever CLI を使用します。独自に構築した検索コードではなく、こちらを優先してください。

インストールが必要な場合のみ

プロジェクト内に Python 環境を作成します。

uv venv .venv --python 3.12
export PATH="$PWD/.venv/bin:$PATH"

ワークフローに必要なパッケージの種類をインストールします。

# Remote NIM or service client
uv pip install --python .venv/bin/python "nemo-retriever==26.8.1"

# Local GPU ingestion
uv pip install --python .venv/bin/python "nemo-retriever[local]==26.8.1"

# Local service using Hugging Face models
uv pip install --python .venv/bin/python \
  "nemo-retriever[service,local]==26.8.1"

# Local audio or video ingestion
uv pip install --python .venv/bin/python \
  "nemo-retriever[local,multimedia]==26.8.1"

NeMo Retriever をクローンしたり、Git URL からインストールしたりしないでください。retriever がすでに PATH にある場合は、そのインストールを使用してください。

ローカルワークフロー

ローカルインデックスを作成します。

retriever ingest <file-or-directory> \
  --lancedb-uri lancedb --table-name nemo-retriever

クエリを実行します。

retriever query "<question>" \
  --lancedb-uri lancedb --table-name nemo-retriever \
  --top-k 5 --format evidence

明示的に Ray バッチ実行を求められた場合にのみ、retriever ingest batch を使用してください。

サービスワークフロー

すでにデプロイされている Retriever サービスには、次の形式を使用します。

retriever ingest service <file-or-directory> \
  --service-url "$RETRIEVER_SERVICE_URL"

retriever query service "<question>" \
  --service-url "$RETRIEVER_SERVICE_URL" \
  --top-k 5 --format evidence

サービスで Bearer 認証が必要な場合は、NEMO_RETRIEVER_API_TOKEN を設定してください。サービスコマンドにローカルの LanceDB フラグを渡さないでください。

ルール

  • 既存のインデックスまたはサービスが提供されている場合は、それを使用し、再構築しないでください。
  • ここに記載されていないオプションについては、retriever ingest --help、retriever query --help、または該当する batch/service のヘルプを使用してください。
  • 取得した根拠のみを使用して回答してください。タスクで引用が求められている場合は、ソースとページのメタデータを保持してください。

コメント