OpenAIConfigKeys
Environment-variable names recognised by llm4s-openai: OpenAI, Requesty, Azure OpenAI and OpenAI embeddings.
These were ConfigKeys.OPENAI_*, ConfigKeys.REQUESTY_BASE_URL and ConfigKeys.AZURE_* in llm4s-core until the providers moved to their own module (#1132): a key belongs with the code that reads it, so that ConfigKeys does not name variables for a provider that may not be on the classpath. OpenRouter's alias is OpenAICompatibleConfigKeys.OPENROUTER_BASE_URL in llm4s-openai-compatible.
Attributes
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
OpenAIConfigKeys.type
Members list
Value members
Concrete fields
Azure OpenAI deployment endpoint URL, e.g. "https://my-resource.openai.azure.com/...".
Azure OpenAI deployment endpoint URL, e.g. "https://my-resource.openai.azure.com/...".
Attributes
Azure OpenAI API version string, e.g. "2025-01-01-preview".
Azure OpenAI API version string, e.g. "2025-01-01-preview".
Attributes
Azure OpenAI API key, the variable the openai SDK's AzureOpenAI client reads. Bound to the shared llm4s.credentials.azure.apiKey.
Azure OpenAI API key, the variable the openai SDK's AzureOpenAI client reads. Bound to the shared llm4s.credentials.azure.apiKey.
This replaced AZURE_API_KEY, which older llm4s docs suggested binding by hand and which no SDK reads.
Attributes
OpenAI API key (sk-...), the variable OpenAI's own SDKs read.
OpenAI API key (sk-...), the variable OpenAI's own SDKs read.
llm4s-openai's reference.conf binds it to the shared llm4s.credentials.openai.apiKey, which every OpenAI chat section and the OpenAI embeddings block use when they set no apiKey of their own.
Attributes
Overrides the OpenAI API base URL.
Overrides the OpenAI API base URL.
Defaults to "https://api.openai.com/v1". Set to an OpenRouter URL (containing "openrouter.ai") to route through OpenRouter without a separate config type - the same org.llm4s.llmconnect.config.OpenAIConfig is reused and the client detects OpenRouter from this URL.
Attributes
Overrides the base URL used for OpenAI embedding requests.
Overrides the base URL used for OpenAI embedding requests.
Useful when routing embeddings through a proxy or compatible endpoint independently of the LLM base URL.
Attributes
Selects the OpenAI embedding model when using the legacy provider format.
Selects the OpenAI embedding model when using the legacy provider format.
Attributes
Optional OpenAI organisation ID forwarded in the OpenAI-Organization header.
Optional OpenAI organisation ID forwarded in the OpenAI-Organization header.
Attributes
Requesty API key, as Requesty's quickstart names it. Bound to the shared llm4s.credentials.requesty.apiKey.
Requesty API key, as Requesty's quickstart names it. Bound to the shared llm4s.credentials.requesty.apiKey.
Attributes
Requesty base URL alias.
Requesty base URL alias.
Requesty is an OpenAI-compatible gateway and uses the same OPENAI_BASE_URL variable - there is no separate REQUESTY_BASE_URL. Point OPENAI_BASE_URL at the Requesty router endpoint and configure a named provider with provider = "requesty".