OpenAIProvider
Registration for the OpenAI API.
Attributes
- Graph
-
- Supertypes
- Self type
-
OpenAIProvider.type
Members list
Value members
Concrete methods
Constructs the client for a ProviderConfig this provider produced.
Constructs the client for a ProviderConfig this provider produced.
config is whatever the caller passed, so implementations must check the type rather than cast — ProviderDescriptor.expectConfig does that and produces the standard mismatch error.
Attributes
Turns a validated config section into the runtime ProviderConfig for this provider.
Turns a validated config section into the runtime ProviderConfig for this provider.
The section has already been checked against configSpec, so required fields are present and section.extras holds exactly the declared provider-specific keys that have a value (defaults applied, deprecated aliases resolved). A Left here means something configSpec cannot express (a malformed value, say).
Value parameters
- providerName
-
the user's instance name (
llm4s.providers.<name>), for error messages.
Attributes
Inherited methods
Alternative spellings accepted in provider = "...", folded onto id.
Alternative spellings accepted in provider = "...", folded onto id.
For example Gemini accepts "google". Aliases are matched after the same trim/lowercase canonicalisation as id itself.
Attributes
- Inherited from:
- ProviderDescriptor
What this provider's client implements. Defaults to the full interface.
What this provider's client implements. Defaults to the full interface.
Attributes
- Inherited from:
- ProviderDescriptor
Concrete fields
The OpenAI API base URL used when a provider section sets no baseUrl.
The OpenAI API base URL used when a provider section sets no baseUrl.
This was DefaultConfig.DEFAULT_OPENAI_BASE_URL in llm4s-core until the provider moved to llm4s-openai (#1132).
Attributes
The key falls back to llm4s.credentials.openai.apiKey, bound to OPENAI_API_KEY; a section with an auth block uses workload identity federation instead and needs no key.
The key falls back to llm4s.credentials.openai.apiKey, bound to OPENAI_API_KEY; a section with an auth block uses workload identity federation instead and needs no key.
Attributes
Canonical id, e.g. ProviderId("openai"). Must be unique within a registry.
Canonical id, e.g. ProviderId("openai"). Must be unique within a registry.
Attributes
Live model discovery, when the provider's API offers it.
Live model discovery, when the provider's API offers it.