Skip to content

docs(llm): stop claiming NVIDIA_API_KEY is auto-read for nvidia_nim (NVBug 6622594) - #2609

Open
kheiss-uwzoo wants to merge 1 commit into
NVIDIA:mainfrom
kheiss-uwzoo:docs/6622594-litellm-nvidia-api-key-docstring
Open

docs(llm): stop claiming NVIDIA_API_KEY is auto-read for nvidia_nim (NVBug 6622594)#2609
kheiss-uwzoo wants to merge 1 commit into
NVIDIA:mainfrom
kheiss-uwzoo:docs/6622594-litellm-nvidia-api-key-docstring

Conversation

@kheiss-uwzoo

Copy link
Copy Markdown
Collaborator

Summary

  • Follow-up to docs(extraction): pass NVIDIA_API_KEY explicitly in Live RAG examples (NVBug 6622594) #2575 / NVBug 6622594 QA: Live RAG examples on main already pass api_key="os.environ/NVIDIA_API_KEY", but LiteLLMClient still claimed NVIDIA_API_KEY was read automatically.
  • The class docstring now states that omitted api_key uses LiteLLM provider-native lookup, that nvidia_nim reads NVIDIA_NIM_API_KEY (not NVIDIA_API_KEY), and that os.environ/NVIDIA_API_KEY forwards the hosted-inference key.

Fixes the remaining API-docstring gap on NVBug 6622594.

26.08.1 released artifacts

Test plan

  • Confirm LiteLLMClient.__doc__ no longer lists NVIDIA_API_KEY as an auto-read variable
  • Confirm the docstring names NVIDIA_NIM_API_KEY for nvidia_nim and os.environ/NVIDIA_API_KEY as the explicit forward
  • Confirm the PR diff is only nemo_retriever/src/nemo_retriever/models/llm/clients/litellm.py

…NVBug 6622594)

LiteLLM nvidia_nim reads NVIDIA_NIM_API_KEY. The class docstring now matches the Live RAG examples on main.
@kheiss-uwzoo
kheiss-uwzoo marked this pull request as ready for review August 28, 2026 15:20
@kheiss-uwzoo
kheiss-uwzoo requested review from a team as code owners August 28, 2026 15:20
@kheiss-uwzoo
kheiss-uwzoo requested review from drobison00 and jperez999 and removed request for drobison00 August 28, 2026 15:20
@kheiss-uwzoo kheiss-uwzoo self-assigned this Aug 28, 2026
@greptile-apps

greptile-apps Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Updates the LiteLLMClient class documentation to distinguish LiteLLM’s provider-native credential lookup from explicit environment-variable forwarding.

  • Documents NVIDIA_NIM_API_KEY as the native variable for the default nvidia_nim provider.
  • Explains how to forward NVIDIA_API_KEY explicitly using api_key="os.environ/NVIDIA_API_KEY".

Confidence Score: 5/5

The PR appears safe to merge because it only corrects credential documentation and introduces no runtime behavior changes.

The documented explicit environment reference is resolved and forwarded at call time, while an omitted key remains delegated to LiteLLM’s provider-native lookup.

Important Files Changed

Filename Overview
nemo_retriever/src/nemo_retriever/models/llm/clients/litellm.py The revised credential guidance is consistent with the client’s omitted-key and explicit environment-reference handling; no actionable issue was identified.

Reviews (1): Last reviewed commit: "docs(llm): stop claiming NVIDIA_API_KEY ..." | Re-trigger Greptile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant