core
API
Generated with
core/org.llm4s/org.llm4s.config/ProvidersConfigModel

ProvidersConfigModel

org.llm4s.config.ProvidersConfigModel
object ProvidersConfigModel

Shared model types and configuration data structures for the multi-provider configuration system.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

final case class NamedProviderConfig(provider: ProviderKind, model: ModelName, baseUrl: Option[BaseUrl], apiKey: Option[ApiKey], organization: Option[String], endpoint: Option[String], apiVersion: Option[String])

Validated and normalised configuration for a single named provider.

Validated and normalised configuration for a single named provider.

Value parameters

apiKey

provider-dependent credential: an API key for most providers, or a path to a service-account credentials file for VertexAI

apiVersion

optional API version string (Azure-specific)

baseUrl

optional base URL override

endpoint

provider-dependent: the endpoint URL for Azure, or the GCP project ID for VertexAI

model

the model name to use

organization

provider-dependent: the organisation identifier for OpenAI, or the GCP region/location for VertexAI

provider

the resolved ProviderKind

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class ProvidersConfig(selectedProvider: Option[ProviderName], namedProviders: Map[ProviderName, NamedProviderConfig])

Validated top-level providers configuration, including all named provider entries.

Validated top-level providers configuration, including all named provider entries.

Value parameters

namedProviders

map of provider name to validated NamedProviderConfig

selectedProvider

the name of the default provider, if configured

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class RawNamedProviderSection(provider: Option[String], model: Option[String], baseUrl: Option[String], apiKey: Option[String], organization: Option[String], endpoint: Option[String], apiVersion: Option[String])

Raw, unvalidated provider section as read directly from the configuration source.

Raw, unvalidated provider section as read directly from the configuration source.

Value parameters

apiKey

provider-dependent credential: an API key for most providers, or a path to a service-account credentials file for VertexAI

apiVersion

optional API version string (Azure-specific)

baseUrl

optional override for the provider's base URL

endpoint

provider-dependent: the endpoint URL for Azure, or the GCP project ID for VertexAI

model

the model name string

organization

provider-dependent: the organisation identifier for OpenAI, or the GCP region/location for VertexAI

provider

the provider kind string (e.g. "openai", "anthropic")

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class RawProvidersConfig(selectedProvider: Option[ProviderName], namedProviders: Map[ProviderName, RawNamedProviderSection])

Raw top-level providers configuration as read from the configuration source.

Raw top-level providers configuration as read from the configuration source.

Value parameters

namedProviders

map of provider name to its raw section

selectedProvider

the name of the default provider, if set

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Exports

Defined exports

final val ApiKey: ApiKey
Exported from ProviderModelTypes
final type ApiKey = ApiKey
Exported from ProviderModelTypes$
final val BaseUrl: BaseUrl
Exported from ProviderModelTypes
final type BaseUrl = BaseUrl
Exported from ProviderModelTypes$
final val ModelName: ModelName
Exported from ProviderModelTypes
final type ModelName = ModelName
Exported from ProviderModelTypes$
final val ProviderKind: ProviderKind
Exported from ProviderModelTypes
final type ProviderKind = ProviderKind
Exported from ProviderModelTypes$
final val ProviderName: ProviderName
Exported from ProviderModelTypes
final type ProviderName = ProviderName
Exported from ProviderModelTypes$
Generated with