docs: document OrcaRouter as an OpenAI-compatible sampling provider - #9995
Open
nissrin2020ali-ux wants to merge 1 commit into
Open
docs: document OrcaRouter as an OpenAI-compatible sampling provider#9995nissrin2020ali-ux wants to merge 1 commit into
nissrin2020ali-ux wants to merge 1 commit into
Conversation
Add OrcaRouter as a named example alongside the existing DashScope base_url in the Sampling From Large Model section of both the English and Chinese Sampling docs, mirroring the current OpenAI API example. The swift sample OpenAIEngine client already supports arbitrary OpenAI-compatible base_url via --engine_kwargs, so OrcaRouter works out of the box; this change documents the provider and its endpoint. Co-Authored-By: Claude <noreply@anthropic.com>
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
1 participant
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.
PR type
PR information
Summary
This PR documents OrcaRouter as a named, OpenAI-compatible sampling provider in the "Sampling From Large Model" section of the Sampling guide (English and Chinese), mirroring the existing DashScope
base_urlexample.SWIFT already ships a fully generic OpenAI-compatible sampling path:
swift sample --sampler_engine clientusesOpenAIEngine(swift/pipelines/sampling/distill_sampler.py), which constructs anopenai.OpenAIclient from--engine_kwargs '{"base_url": ...}'. Any OpenAI-compatible endpoint works today, so OrcaRouter requires no code change. This PR only surfaces it as a first-class provider in the docs, in the same way DashScope is documented today.OrcaRouter is an OpenAI-compatible AI gateway built for both models and agents. Like OpenRouter, it exposes a provider/model namespace across many models — but it also combines adaptive routing, automatic failover, zero-markup inference, observability, guardrails, and agent-tool governance behind the same endpoint. Adding orcarouter as a first-class provider means this project's users can use that stack directly, without treating OrcaRouter as an anonymous custom base URL. It also runs gateway-level, zero-trust security for AI agents on the same endpoint — screening every prompt/response and governing every tool call on a default-deny basis, with no application code changes.
Changes
docs/source_en/Instruction/Sample.md: added an OrcaRouter example after the DashScope one, using--engine_kwargs '{"base_url":"https://api.orcarouter.ai/v1"}'and the gateway modeldeepseek/deepseek-reasoner(mirroring the existing DeepSeek-R1 note aboutreasoning_content).docs/source/Instruction/Sample.md: same change in Chinese.Verification
pre-commit run --fileson both changed files: all hooks pass.https://api.orcarouter.ai/v1using the OpenAI client exactly asOpenAIEnginedoes (non-stream and--stream true): both return HTTP 200 with a valid completion, and thedeepseek/deepseek-reasonermodel returnsreasoning_contentmatching the existing doc note.Discord: discord.gg/YEubt8enRA · X: https://x.com/OrcaRouter
I'm an engineer on the OrcaRouter team.