Skip to content

docs(cli): use hosted VL rerank defaults in CLI example (NVBug 6657245) #2576

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
kheiss-uwzoo wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs(cli): use hosted VL rerank defaults in CLI example (NVBug 6657245) #2576

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions nemo_retriever/docs/cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,21 +136,29 @@ retriever ingest ./data/multimodal_test.pdf \
build.nvidia.com endpoints. `NGC_API_KEY` is used separately when pulling or
running self-hosted NIM containers.

For NVIDIA inference hub rerank models that expose the Cohere-style rerank
route, pass the full `/v1/rerank` URL and the model name shown in the hub
snippet:
To rerank local query results with the hosted vision-language reranker, pass the
NVIDIA-hosted `/reranking` endpoint and model. Use the same `NVIDIA_API_KEY` that
authorizes the hosted embedding URL:

```bash
export NGC_INFERENCE_API_KEY=...

retriever query "What is in this document?" \
--embed-invoke-url https://integrate.api.nvidia.com/v1/embeddings \
--embed-model-name nvidia/llama-nemotron-embed-1b-v2 \
--reranker-invoke-url https://inference-api.nvidia.com/v1/rerank \
--reranker-model-name nvidia/nvidia/llama-3.2-nv-rerankqa-1b-v2 \
--reranker-api-key-env NGC_INFERENCE_API_KEY
--reranker-invoke-url https://ai.api.nvidia.com/v1/retrieval/nvidia/llama-nemotron-rerank-vl-1b-v2/reranking \
--reranker-model-name nvidia/llama-nemotron-rerank-vl-1b-v2 \
--reranker-api-key-env NVIDIA_API_KEY
```

Passing `--rerank` without `--reranker-invoke-url` uses the local GPU reranker,
not this hosted endpoint.

A Cohere-style `/v1/rerank` URL is a gateway route, not an NVIDIA-hosted NIM
endpoint. Pass the full URL that your gateway exposes, for example
`https://<your-gateway>/v1/rerank`, and the model name that gateway expects.
Set `--reranker-api-key-env` to an environment variable that holds a credential
issued by that gateway. A gateway that expects a LiteLLM virtual key that starts
with `sk-` rejects NVIDIA `nvapi-` keys and NGC keys.

### Query result controls

Both `retriever query` and `retriever query service` return compact JSON hits
Expand Down
Loading