Skip to content

~95% on SimpleQA (e.g. Qwen3.6-27B on a 3090). Supports all local and cloud LLMs (llama.cpp, Ollama, Google, ...). 10+ search engines - arXiv, PubMed, your private documents. Everything Local & Encrypted.

fix(embeddings): correct OpenAIEmbeddingsProvider.requires_api_key to False (#4036)

LearningCircuite6432db8bdd4
diff --git a/src/local_deep_research/embeddings/providers/implementations/openai.py b/src/local_deep_research/embeddings/providers/implementations/openai.py
index 043a72f31a..1113880d81 100644
--- a/src/local_deep_research/embeddings/providers/implementations/openai.py
+++ b/src/local_deep_research/embeddings/providers/implementations/openai.py
@@ -23,12 +23,11 @@ class OpenAIEmbeddingsProvider(BaseEmbeddingProvider):
provider_name = "OpenAI"
provider_key = "OPENAI"
- # An API key is required for the OpenAI cloud, but optional for
- # keyless OpenAI-compatible local servers; we keep the class-level
- # flag for callers that gate UI prompts on it, and handle the
- # base_url-set / key-empty case explicitly in ``is_available`` and
- # ``create_embeddings``.
- requires_api_key = True
+ # Not strictly required: the OpenAI cloud needs a key, but
+ # OpenAI-compatible local servers (LM Studio, vLLM, llama.cpp)
+ # don't. ``is_available`` and ``create_embeddings`` enforce the
+ # cloud-needs-key rule at runtime when no base_url is set.
+ # Inherits ``requires_api_key = False`` from BaseEmbeddingProvider.
supports_local = False
default_model = "text-embedding-3-small" # type: ignore[assignment]
# Placeholder key used when targeting an OpenAI-compatible local
diff --git a/tests/embeddings/test_openai_embeddings.py b/tests/embeddings/test_openai_embeddings.py
index e2a92e5cc7..c89540a4fb 100644
--- a/tests/embeddings/test_openai_embeddings.py
+++ b/tests/embeddings/test_openai_embeddings.py
@@ -32,12 +32,21 @@ class TestOpenAIEmbeddingsProviderMetadata:
assert OpenAIEmbeddingsProvider.provider_key == "OPENAI"
def test_requires_api_key(self):
- """Test that OpenAI requires API key."""
+ """Provider does not strictly require an API key.
+
+ Cloud OpenAI does need one, but OpenAI-compatible local servers
+ (LM Studio, vLLM, llama.cpp) don't — the runtime path in
+ ``is_available`` / ``create_embeddings`` enforces the rule when
+ a base_url is *not* set. The class-level flag therefore stays
+ ``False`` (inherited from BaseEmbeddingProvider) so any future
+ UI consumer doesn't show a misleading "API key required" badge
+ for keyless local-server users.
+ """
from local_deep_research.embeddings.providers.implementations.openai import (
OpenAIEmbeddingsProvider,
)
- assert OpenAIEmbeddingsProvider.requires_api_key is True
+ assert OpenAIEmbeddingsProvider.requires_api_key is False
def test_supports_local(self):
"""Test that OpenAI does not support local."""