ConfigKeys

org.llm4s.config.ConfigKeys
@Stable
object ConfigKeys

Canonical environment-variable names bound by llm4s-core's reference.conf.

Each is read through a ${?VAR} substitution under the llm4s config tree, so the config key it feeds can also be set directly in application.conf or as a JVM system property. This object centralises the names to avoid typos and make grep-friendly references possible.

== Quick reference ==

  • Chat providers: a named section under llm4s.providers sets no key of its own by default; it uses its vendor's llm4s.credentials.<id>.apiKey, which the provider's module binds to the vendor's variable (llm4s-openai binds OPENAI_API_KEY, see OpenAIConfigKeys). Nothing reads LLM_MODEL.
  • TRACING_MODE — optional; console (default) or none, or a backend module's mode: langfuse (llm4s-observability), opentelemetry (llm4s-observability-otel).
  • EMBEDDING_MODEL — required when using embeddings; format provider/model.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
ConfigKeys.type

Members list

Value members

Concrete fields

val CHUNKING_ENABLED: String

Enables or disables document chunking (true/false). Default: true.

Enables or disables document chunking (true/false). Default: true.

Attributes

val CHUNK_OVERLAP: String

Token overlap between consecutive chunks. Default: 100.

Token overlap between consecutive chunks. Default: 100.

Attributes

val CHUNK_SIZE: String

Token count per chunk when splitting documents for embedding. Default: 1000.

Token count per chunk when splitting documents for embedding. Default: 1000.

Attributes

val EMBEDDING_INPUT_PATH: String

Path to the file or directory to embed.

Path to the file or directory to embed.

Attributes

val EMBEDDING_MODEL: String

Unified embedding provider and model selector.

Unified embedding provider and model selector.

Format: provider/model, e.g. "openai/text-embedding-3-small", "voyage/voyage-3", "ollama/nomic-embed-text". Takes precedence over the legacy EMBEDDING_PROVIDER variable.

Attributes

val EMBEDDING_PROVIDER: String

Legacy embedding provider selector; superseded by EMBEDDING_MODEL.

Legacy embedding provider selector; superseded by EMBEDDING_MODEL.

Attributes

val EMBEDDING_QUERY: String

Query string used when searching an embedding index.

Query string used when searching an embedding index.

Attributes