ProviderConfigSpec

org.llm4s.llmconnect.spi.ProviderConfigSpec
See theProviderConfigSpec companion class

Attributes

Companion
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Members list

Type members

Inherited and Abstract types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

def apiKeyAndDefaultBaseUrl(defaultBaseUrl: String, apiKeyEnv: Seq[String]): ProviderConfigSpec

The common shape: an API key, and a base URL that defaults to the provider's public endpoint.

The common shape: an API key, and a base URL that defaults to the provider's public endpoint.

Value parameters

apiKeyEnv

the variables the module binds to llm4s.credentials.<id>.apiKey; see ProviderConfigSpec.apiKeyEnv.

Attributes

def apply(requiresApiKey: Boolean, requiresBaseUrl: Boolean, defaultBaseUrl: Option[String], baseUrlExample: String, baseUrlEnv: Option[String], extras: Seq[ProviderConfigKey], apiKeyEnv: Seq[String], authExtras: Seq[ProviderConfigKey], keylessWhen: Option[(String, String)]): ProviderConfigSpec

Creates a ProviderConfigSpec. Named arguments are the supported way to construct one.

Creates a ProviderConfigSpec. Named arguments are the supported way to construct one.

Attributes

def apply(requiresApiKey: Boolean, requiresBaseUrl: Boolean, defaultBaseUrl: Option[String], baseUrlExample: String, baseUrlEnv: Option[String], extras: Seq[ProviderConfigKey], apiKeyEnv: Seq[String], authExtras: Seq[ProviderConfigKey]): ProviderConfigSpec

The shape before keylessWhen (#2274), with no keyless authentication.

The shape before keylessWhen (#2274), with no keyless authentication.

Attributes

Concrete fields

val BuiltinAliasKeys: Set[String]

The built-in fields that can be a deprecated alias (ProviderConfigKey.deprecatedAliases): those with a string form. provider and model select and drive every provider, and headers is a map, so none of them can stand in for a provider-specific key.

The built-in fields that can be a deprecated alias (ProviderConfigKey.deprecatedAliases): those with a string form. provider and model select and drive every provider, and headers is a map, so none of them can stand in for a provider-specific key.

Attributes

val BuiltinKeys: Set[String]

The fields every named provider section may carry, whatever its provider. An ProviderConfigKey cannot reuse one of these names.

The fields every named provider section may carry, whatever its provider. An ProviderConfigKey cannot reuse one of these names.

Anything vendor-specific - Azure's endpoint and apiVersion, OpenAI's organization, the generic openai-compatible provider's contextWindow - is a ProviderConfigKey its provider declares, not a built-in, and is unknown to every provider that does not declare it.

Attributes