llm4s-docs
API
Generated with
llm4s-docs/org.llm4s/org.llm4s.config/ApiKeySource

ApiKeySource

org.llm4s.config.ApiKeySource
@Stable
enum ApiKeySource

Where a named chat section's API key comes from.

A section that sets no apiKey of its own uses its vendor's shared key, llm4s.credentials.<providerId>.apiKey. That is the convenient default - set OPENAI_API_KEY and every OpenAI section works - and also the way a section meant for a second account, missing its key, silently bills the first. Llm4sConfig.apiKeySources reports which sections do which, so a policy can insist on explicit keys in production.

Attributes

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

Members list

Type members

Enum entries

final case class Credentials(path: String)

The section sets no apiKey, so it uses the vendor's shared key - whether or not that key is set in the environment the check runs in.

The section sets no apiKey, so it uses the vendor's shared key - whether or not that key is set in the environment the check runs in.

Value parameters

path

the shared key's path, e.g. llm4s.credentials.openai.apiKey

Attributes

final case class Section(path: String)

The section sets its own apiKey, or an apiKeyFile holding it.

The section sets its own apiKey, or an apiKeyFile holding it.

Value parameters

path

where, e.g. llm4s.providers.openai-main.apiKey or llm4s.providers.openai-main.apiKeyFile

Attributes

final case class WorkloadIdentity(path: String)

The section authenticates with workload identity - an auth block, or a keyless authentication its provider declares (ProviderConfigSpec.keylessWhen, such as Azure OpenAI's authentication = "entra-id") - so it uses no API key, its own or shared.

The section authenticates with workload identity - an auth block, or a keyless authentication its provider declares (ProviderConfigSpec.keylessWhen, such as Azure OpenAI's authentication = "entra-id") - so it uses no API key, its own or shared.

Value parameters

path

the block's or the setting's path, e.g. llm4s.providers.databricks-main.auth or llm4s.providers.azure-prod.authentication

Attributes

Generated with