mcpField
N
nemo-retriever

nemo-retriever

github.com/nvidia文档处理3.8k2.4k 次安装今天更新
代码仓库

关于 nemo-retriever

NeMo Retriever 技能指导通过 retriever CLI 构建或查询本地索引,也可连接已部署的 Retriever 服务。适用于需要依据检索证据回答并保留来源信息的工作流。

主要功能

  1. 01本地索引构建与查询
  2. 02调用已部署的检索服务
  3. 03支持证据格式结果
  4. 04按需配置服务令牌

适用场景

  1. 01为本地文档建立索引
  2. 02查询已有索引并获取证据
  3. 03向需认证的 Retriever 服务发送请求

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/nvidia/skills --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 帮助。
  • 仅根据检索到的证据作答;如果任务要求提供引文,请保留来源和页码元数据。

评论

支持 Markdown