docs(migration): explain the "No default base_url" config-load error - #1881
Conversation
A v0.21 configuration that uses an engine whose HTTP API is not
OpenAI-compatible (anthropic, cohere, vertexai, google_genai,
huggingface_endpoint, huggingface_pipeline, trt_llm, self_hosted, ...)
fails to load on v0.22 unless the user has opted into LangChain. The
default framework raises:
No default base_url for provider 'X'. If your endpoint is
OpenAI-compatible, set parameters.base_url. Otherwise, set
NEMOGUARDRAILS_LLM_FRAMEWORK=langchain and install the matching
langchain-<provider> package (see migration guide).
The migration guide already covered the parameter-rename path
(`openai_api_base` to `base_url`) but did not contain the verbatim
string above. A user pasting the error into the docs search landed
on nothing.
Add a new "Unsupported Engine on the Default Framework" section after
"Mixed-Shape Configs" that quotes the error verbatim with a
placeholder provider name, names the engines that typically trigger
it, and links the two existing remediation sections: "Using LangChain"
for the opt-in route and "OpenAI-Compatible Providers" for the
endpoint-swap route.
Doc-only; the error message itself is unchanged.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis PR adds a migration guidance section to the 0.22 documentation, explaining a configuration-load failure that occurs when loading non-OpenAI-compatible LLM engines without explicitly opting into LangChain. The section describes the error message and provides two concrete remediation paths for affected users. Changes0.22 Migration Guide Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 6✅ Passed checks (6 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. Comment |
Documentation preview |
Greptile SummaryThis PR adds a new "Unsupported Engine on the Default Framework" section to the v0.22 migration guide and updates the summary table to reference both remediation paths (LangChain opt-in or OpenAI-compatible
|
| Filename | Overview |
|---|---|
| docs/migration/0.22.md | Adds a new "Unsupported Engine on the Default Framework" section with the verbatim error message and two remediation bullets; updates the summary table row for unsupported engines to reference the new section. No inconsistencies found. |
Reviews (3): Last reviewed commit: "docs: edit pass" | Re-trigger Greptile
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Apply two reviewer suggestions on the Unsupported-Engine section: - Prefix the verbatim error with `ValueError:` to match how troubleshooting.md (line 76) renders the same error, so a traceback- paste search hits both reference docs. - Update the migration-summary table row for non-OpenAI-compatible engines to point at the new section title and to mention the "switch to OpenAI-compatible" remediation alongside the LangChain opt-in. The new section already cross-links both fix paths internal
2 participants
Description
VDR feedback: developers hitting
No default base_url for provider 'X'.on v0.22 couldn't find the verbatim error in the migration guide and had nothing to search for. Add a new "Unsupported Engine on the Default Framework" section that quotes the error verbatim and points at the two real remediations (LangChain opt-in or OpenAI-compatible base_url).Related Issue(s)
Checklist
Summary by CodeRabbit