Skip to content

docs: document OrcaRouter as an embedding provider - #280

Open
martinzudergaming-a11y wants to merge 1 commit into
cocoindex-io:mainfrom
martinzudergaming-a11y:docs/orcarouter-provider
Open

docs: document OrcaRouter as an embedding provider#280
martinzudergaming-a11y wants to merge 1 commit into
cocoindex-io:mainfrom
martinzudergaming-a11y:docs/orcarouter-provider

Conversation

@martinzudergaming-a11y

Copy link
Copy Markdown

Summary

This adds OrcaRouter as a documented embedding provider, mirroring how the README already documents named providers like Ollama, OpenAI, Gemini, Voyage, and Nebius.

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.

Why this change

cocoindex-code lets users choose any LiteLLM embedding backend. OrcaRouter serves many embedding models (openai/text-embedding-3-small, google/gemini-embedding-001, …) behind a single OpenAI-compatible endpoint with automatic failover and adaptive routing. It plugs into the existing LiteLLM bridge with a normal openai/ route — no custom code required.

What changed

  • README.md — added an "OrcaRouter" block under "Embedding Models", in the same <details> format as the existing named providers. It explains the openai/openai/<model-id> model string (LiteLLM strips one openai/ and OrcaRouter resolves the remaining provider-qualified id) and sets OPENAI_BASE_URL to https://api.orcarouter.ai/v1.
  • EMBEDDINGS.md — added an "OrcaRouter (aggregated cloud gateway)" section under "LiteLLM Remote (Cloud Providers)" with a working YAML example.

Verification

I verified the documented config against a live OrcaRouter endpoint using the same LiteLLM call path the daemon uses for ccc init / ccc doctor (litellm.aembedding with model: openai/openai/text-embedding-3-small and OPENAI_BASE_URL: https://api.orcarouter.ai/v1). It returned HTTP 200 with 2 embeddings of dimension 1536.

All pre-commit hooks that apply to Markdown (trailing-whitespace, end-of-file-fixer) pass on the changed files.

I'm an engineer on the OrcaRouter team.

Discord: discord.gg/YEubt8enRA · X: https://x.com/OrcaRouter

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