Skip to content

#1 Persistent memory for AI coding agents based on real-world benchmarks

fix(embed): allow separate OPENAI_EMBEDDING_BASE_URL + OPENAI_EMBEDDING_API_KEY (#503)

efenex051d5ac2eb9d
diff --git a/src/providers/embedding/openai.ts b/src/providers/embedding/openai.ts
index ea5a0efa..7384d513 100644
--- a/src/providers/embedding/openai.ts
+++ b/src/providers/embedding/openai.ts
@@ -48,16 +48,30 @@ function resolveDimensions(model: string, override: string | undefined): number
* `api-key` header instead of `Authorization: Bearer`.
*
* Required env vars:
- * OPENAI_API_KEY — API key
+ * OPENAI_API_KEY — API key (fallback for OPENAI_EMBEDDING_API_KEY)
*
* Optional:
- * OPENAI_BASE_URL — base URL without path (default: https://api.openai.com).
- * Azure: https://<resource>.openai.azure.com/openai/deployments/<deployment>
- * OPENAI_API_VERSION — Azure api-version query param (default: 2024-08-01-preview)
- * OPENAI_EMBEDDING_MODEL — model name (default: text-embedding-3-small)
- * OPENAI_EMBEDDING_DIMENSIONS — override reported dimensions (required for
- * custom / self-hosted models not in the
- * MODEL_DIMENSIONS table above)
+ * OPENAI_BASE_URL — base URL without path (default: https://api.openai.com).
+ * Azure: https://<resource>.openai.azure.com/openai/deployments/<deployment>
+ * OPENAI_EMBEDDING_BASE_URL — embedding-specific base URL override (defaults
+ * to OPENAI_BASE_URL). Lets operators run
+ * embeddings on a separate endpoint from chat —
+ * e.g. local Ollama / LM Studio / llama.cpp /
+ * vLLM at http://localhost:1234 for unlimited
+ * free embeddings, while keeping chat
+ * completions on a rate-limited but high-quality
+ * hosted provider. Azure detection runs on
+ * whichever URL ends up selected.
+ * OPENAI_EMBEDDING_API_KEY — separate API key for the embedding endpoint
+ * (defaults to OPENAI_API_KEY). Useful when the
+ * embedding endpoint requires a different key
+ * or no key at all (set to e.g. "local" for
+ * endpoints that ignore Authorization).
+ * OPENAI_API_VERSION — Azure api-version query param (default: 2024-08-01-preview)
+ * OPENAI_EMBEDDING_MODEL — model name (default: text-embedding-3-small)
+ * OPENAI_EMBEDDING_DIMENSIONS — override reported dimensions (required for
+ * custom / self-hosted models not in the
+ * MODEL_DIMENSIONS table above)
*/
export class OpenAIEmbeddingProvider implements EmbeddingProvider {
readonly name = "openai";
@@ -69,9 +83,26 @@ export class OpenAIEmbeddingProvider implements EmbeddingProvider {
private azureApiVersion: string;
constructor(apiKey?: string) {
- this.apiKey = apiKey || getEnvVar("OPENAI_API_KEY") || "";
- if (!this.apiKey) throw new Error("OPENAI_API_KEY is required");
- this.baseUrl = normalizeBaseUrl(getEnvVar("OPENAI_BASE_URL"));
+ // Separate API key path: caller-passed wins, then OPENAI_EMBEDDING_API_KEY,
+ // then fall back to OPENAI_API_KEY. Allows e.g. a placeholder key for
+ // local endpoints that ignore Authorization (most do).
+ this.apiKey =
+ apiKey ||
+ getEnvVar("OPENAI_EMBEDDING_API_KEY") ||
+ getEnvVar("OPENAI_API_KEY") ||
+ "";
+ if (!this.apiKey) {
+ throw new Error(
+ "API key is required (via constructor, OPENAI_EMBEDDING_API_KEY, or OPENAI_API_KEY)",
+ );
+ }
+ // Embedding-specific base URL override; falls back to OPENAI_BASE_URL,
+ // then normalizeBaseUrl's default. The chat-LLM path (src/providers/openai.ts)
+ // still reads only OPENAI_BASE_URL, so setting OPENAI_EMBEDDING_BASE_URL
+ // alone moves embeddings to the new endpoint without affecting chat.
+ this.baseUrl = normalizeBaseUrl(
+ getEnvVar("OPENAI_EMBEDDING_BASE_URL") || getEnvVar("OPENAI_BASE_URL"),
+ );
this.model = getEnvVar("OPENAI_EMBEDDING_MODEL") || DEFAULT_MODEL;
this.dimensions = resolveDimensions(
this.model,
diff --git a/test/embedding-provider.test.ts b/test/embedding-provider.test.ts
index e6442ae4..6c2d263e 100644
--- a/test/embedding-provider.test.ts
+++ b/test/embedding-provider.test.ts
@@ -58,6 +58,8 @@ describe("OpenAIEmbeddingProvider", () => {
beforeEach(() => {
process.env = { ...originalEnv };
delete process.env["OPENAI_BASE_URL"];
+ delete process.env["OPENAI_EMBEDDING_BASE_URL"];
+ delete process.env["OPENAI_EMBEDDING_API_KEY"];
delete process.env["OPENAI_EMBEDDING_MODEL"];
delete process.env["OPENAI_EMBEDDING_DIMENSIONS"];
});
@@ -74,7 +76,8 @@ describe("OpenAIEmbeddingProvider", () => {
it("throws when no API key is provided", () => {
delete process.env["OPENAI_API_KEY"];
- expect(() => new OpenAIEmbeddingProvider()).toThrow("OPENAI_API_KEY is required");
+ delete process.env["OPENAI_EMBEDDING_API_KEY"];
+ expect(() => new OpenAIEmbeddingProvider()).toThrow(/API key is required.*OPENAI_EMBEDDING_API_KEY.*OPENAI_API_KEY/);
});
it("respects OPENAI_BASE_URL env var", async () => {