docs: clarify OpenAI-compatible endpoint configuration - #321
Open
lakshya-dhariwal wants to merge 1 commit into
Open
lakshya-dhariwal wants to merge 1 commit into
lakshya-dhariwal wants to merge 1 commit into
Conversation
This branch has not been deployed
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.
What changed
Add an OpenAI-compatible endpoint example to the CLI guide. It explains why a remote server needs
--backend openai, how to choose the API root for--base-url, and why the full/chat/completionsURL is wrong. It also covers the server's model ID, the unset-key fallback, and the evaluation sandbox.Provider-specific URLs are unchanged. In particular,
/v1is not required by every provider.Fixes #315.
Validation
OpenAIChatDecoderagainst a local HTTP server with the OpenAI client. All four cases passed: roots with and without/v1, each with a configured key and an unset key. The captured requests used the expected chat path, model ID, and authentication fallback.docs/cli.md; Python and YAML hooks correctly skipped this Markdown-only change.git diff --checkpassed.AI assistance
Prepared and checked with AI assistance. No independent human code review is claimed.