docs: add OrcaRouter as an OpenAI-compatible gateway example - #2509
docs: add OrcaRouter as an OpenAI-compatible gateway example#2509XiaoHuo888-hue wants to merge 1 commit into
Conversation
Signed-off-by: XiaoHuo888 <sjh00112233@outlook.com>
Greptile SummaryAdds OrcaRouter as an OpenAI-compatible gateway example across credential, Python-library, and agentic-service documentation.
|
| Filename | Overview |
|---|---|
| docs/docs/extraction/api-keys.md | Adds an environment-reference example that is compatible with the library credential resolver. |
| docs/docs/extraction/nemo-retriever-api-reference.md | Adds a Python OrcaRouter example consistent with the current generation parameter and operator APIs. |
| docs/docs/extraction/workflow-agentic-retrieval.md | Adds valid model and endpoint settings but documents an API-key environment variable that the agentic service does not resolve. |
Prompt To Fix All With AI
### Issue 1
docs/docs/extraction/workflow-agentic-retrieval.md:71-73
**Agentic gateway key is ignored**
When users follow this example and export `ORCAROUTER_API_KEY`, the agentic service does not read that variable; it reuses the embedding credential resolved from `NVIDIA_API_KEY` or `NGC_API_KEY`. OrcaRouter consequently receives an empty or NVIDIA bearer token and rejects the chat-completion request.
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.Reviews (1): Last reviewed commit: "docs: add OrcaRouter as an OpenAI-compat..." | Re-trigger Greptile
| `ORCAROUTER_API_KEY` environment variable, and its keys start with `sk-orca-`. | ||
|
|
||
| ```yaml |
There was a problem hiding this comment.
Agentic gateway key is ignored
When users follow this example and export ORCAROUTER_API_KEY, the agentic service does not read that variable; it reuses the embedding credential resolved from NVIDIA_API_KEY or NGC_API_KEY. OrcaRouter consequently receives an empty or NVIDIA bearer token and rejects the chat-completion request.
Rule Used: When this PR changes user-facing code, configurati... (source)
Knowledge Base Used: Query Pipeline
Prompt To Fix With AI
This is a comment left during a code review.
Path: docs/docs/extraction/workflow-agentic-retrieval.md
Line: 71-73
Comment:
**Agentic gateway key is ignored**
When users follow this example and export `ORCAROUTER_API_KEY`, the agentic service does not read that variable; it reuses the embedding credential resolved from `NVIDIA_API_KEY` or `NGC_API_KEY`. OrcaRouter consequently receives an empty or NVIDIA bearer token and rejects the chat-completion request.
**Rule Used:** When this PR changes user-facing code, configurati... ([source](.greptile))
**Knowledge Base Used:** [Query Pipeline](https://app.greptile.com/nvidia-public-github/-/custom-context/knowledge-base/nvidia/nemo-retriever/-/docs/query-pipeline.md)
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.
Description
Adds OrcaRouter as a named OpenAI-compatible gateway example in the documentation. With one API key, users get 150+ models from OpenAI, Anthropic, Google, DeepSeek, Qwen, MiniMax and xAI behind a single endpoint. Because NeMo Retriever's OpenAI-compatible client paths are a thin base-URL swap, any NeMo Retriever pipeline or agent that uses them also inherits OrcaRouter's gateway-level, zero-trust security controls for AI agents — with no application code changes. The gateway screens every prompt and response and governs every tool call on a default-deny basis, across four layers:
What changed
Documentation only — three pages under
docs/docs/extraction/:workflow-agentic-retrieval.md— added a named agentic-service configuration example routingllm_model/invoke_urlthrough OrcaRouter, plus theORCAROUTER_API_KEYenvironment note.nemo-retriever-api-reference.md— added aTextGenerationParams.from_kwargs(...)example usingopenai/orcarouter/autowithapi_base="https://api.orcarouter.ai/v1".api-keys.md— notedos.environ/ORCAROUTER_API_KEYas the credential reference for OpenAI-compatible gateways.No code, configuration, or dependency changes. The examples follow the existing OpenAI-compatible wiring already documented: LiteLLM
openai/<model>+api_basefor the Python library, andinvoke_url+llm_modelfor agentic service mode.Verification
Both documented patterns were exercised live against
https://api.orcarouter.ai/v1before writing the examples:openai/orcarouter/auto(and the namespacedopenai/anthropic/claude-sonnet-4.6,openai/deepseek/deepseek-v4-pro) returned successful completions.I'm an engineer on the OrcaRouter team.
Checklist