Skip to content

Commit 0234f54

Browse files
authored
docs(readme): document OpenAI-compatible endpoint configuration (#168)
Add an "OpenAI-compatible (custom endpoint)" section under Embedding Models showing the `openai/` prefix plus `OPENAI_BASE_URL` / `OPENAI_API_KEY` env vars, and link the LiteLLM "Setting API Keys" doc from the general LiteLLM note so users of any provider can find the canonical env-var list.
1 parent cc55f32 commit 0234f54

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -524,6 +524,23 @@ envs:
524524

525525
</details>
526526

527+
<details>
528+
<summary>OpenAI-compatible (custom endpoint)</summary>
529+
530+
Many providers (vLLM, LM Studio, LocalAI, Together, Fireworks, DeepInfra, …) expose an OpenAI-compatible embedding API. Use the `openai/` prefix and point `OPENAI_BASE_URL` at your endpoint:
531+
532+
```yaml
533+
embedding:
534+
model: openai/your-model-name
535+
envs:
536+
OPENAI_BASE_URL: https://your-endpoint/v1
537+
OPENAI_API_KEY: your-api-key
538+
```
539+
540+
Don't append `/embeddings` to the base URL — LiteLLM handles that.
541+
542+
</details>
543+
527544
<details>
528545
<summary>Azure OpenAI</summary>
529546

@@ -612,7 +629,7 @@ envs:
612629

613630
</details>
614631

615-
Any [LiteLLM-supported model](https://docs.litellm.ai/docs/embedding/supported_embedding) works. When using a LiteLLM model, set `provider: litellm` (or omit `provider` — LiteLLM is the default for non-`sentence-transformers` models).
632+
Any [LiteLLM-supported model](https://docs.litellm.ai/docs/embedding/supported_embedding) works. When using a LiteLLM model, set `provider: litellm` (or omit `provider` — LiteLLM is the default for non-`sentence-transformers` models). For the full list of env vars each provider reads (API keys, base URLs, regions, …), see LiteLLM's [Setting API Keys](https://docs.litellm.ai/docs/set_keys).
616633

617634
### Local SentenceTransformers Models
618635

0 commit comments

Comments
 (0)