docs(extraction): pass NVIDIA_API_KEY explicitly in Live RAG examples (NVBug 6622594) - #2575
Open
kheiss-uwzoo wants to merge 2 commits into
Open
docs(extraction): pass NVIDIA_API_KEY explicitly in Live RAG examples (NVBug 6622594)#2575kheiss-uwzoo wants to merge 2 commits into
kheiss-uwzoo wants to merge 2 commits into
Conversation
… (NVBug 6622594) LiteLLM nvidia_nim does not read NVIDIA_API_KEY from the environment, so the README and API-key docs now pass os.environ/NVIDIA_API_KEY.
kheiss-uwzoo
marked this pull request as ready for review
August 24, 2026 17:02
kheiss-uwzoo
requested review from
jioffe502 and
jperez999
and removed request for
jioffe502
August 24, 2026 17:02
Contributor
Greptile SummaryThe PR updates Live RAG documentation to pass
|
| Filename | Overview |
|---|---|
| docs/docs/extraction/api-keys.md | Clarifies the explicit credential reference required by LiteLLM-backed NVIDIA NIM models. |
| docs/docs/extraction/nemo-retriever-api-reference.md | Adds credential guidance for default LiteLLMClient and LLMJudge models in persisted configurations. |
| nemo_retriever/README.md | Updates both Live RAG examples to forward the configured NVIDIA API key explicitly. |
Reviews (2): Last reviewed commit: "Merge branch 'main' into docs/6622594-li..." | Re-trigger Greptile
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
LiteLLMClient/LLMJudgeexamples now passapi_key="os.environ/NVIDIA_API_KEY"so the defaultnvidia_nimmodel receives the hosted-inference key.NVIDIA_API_KEYfornvidia_nim; omit-api_keylooks upNVIDIA_NIM_API_KEY.LiteLLMClientclass docstring still listsNVIDIA_API_KEYas auto-read (litellm.py:57-58); that is source drift for a follow-up eng change.Fixes NVBug 6622594.
Test plan
NVIDIA_API_KEYset and confirm the request is sent (noterror='transport_error'from a missing LiteLLM key name)api_key="os.environ/NVIDIA_API_KEY"still matches the working OpenAI example earlier on the same READMEpre-draft: leakage, mkdocs --strict, ::a, ::p, ::r on the diff vs main
Base: upstream/main
Files:
docs/docs/extraction/api-keys.md,docs/docs/extraction/nemo-retriever-api-reference.md,nemo_retriever/README.mdsee [CTAs)see [CTAs on these three files; nonimOperator/nvcr.io/nim/installFfmpegon faq.md, overview.md, or multimodal-extraction.md. Leakage script vsorigin/mainreported leftover untrackedcustom-metadata.md(not in this diff; forkorigin/mainis behindupstream/main).custom-metadata.mdanduser-defined-stages.md, which are not in this diffos.environ/NVIDIA_API_KEYresolves at call time (resolve_environment_reference,LiteLLMClient.complete,test_llm_params.py); default models arenvidia_nim/...(litellm.py:70,judge.py:237); omit-api_keyis provider-native (LLMRemoteClientParams);nvidia_nimlookup name isNVIDIA_NIM_API_KEY(evaluation README). DroppedNVIDIA_NIM_ADMIN_KEY(no in-repo evidence).Code drift (not in this docs PR):
nemo_retriever/src/nemo_retriever/models/llm/clients/litellm.py:57-58still listsNVIDIA_API_KEYas auto-read. Evaluation READMELLMJudgenvidia_nimexample still omitsapi_key.transport_errormasking is a separate product defect.PR: this draft