GeminiConfig

org.llm4s.llmconnect.config.GeminiConfig
See theGeminiConfig companion object
@Stable
final case class GeminiConfig extends ProviderConfig

Configuration for the Google Gemini API.

Prefer GeminiConfig.fromValues, which validates the values, normalises baseUrl and resolves contextWindow and reserveCompletion from the bundled model catalogue. The constructor is private: build one with the companion apply and adjust it with the with* setters. Java and Kotlin, which cannot see Scala default arguments, use GeminiConfig.apply(apiKey, model) and the setters, so adding a field never breaks them.

Value parameters

apiKey

Google API key; redacted in toString.

apiKeyProvider

asked for the key on every request instead of sending apiKey, so a rotated key is used without rebuilding the client (#2477): a section's apiKeyFile sets one

baseUrl

API base URL; defaults to GeminiConfig.DEFAULT_BASE_URL.

contextWindow

Model's total token capacity (prompt + completion combined).

googleSearch

whether to ground answers in Google Search: the section's googleSearch key. When set, every request carries Gemini's google_search tool, the model may search before answering, and the sources it used arrive on Completion.citations. Off by default; billed by Google.

model

Model identifier, e.g. "gemini-2.0-flash".

reserveCompletion

Tokens held back from prompt history for the completion.

timeouts

how long a request and a stream may take: the section's timeouts block. An absent value keeps the client's own default (ProviderTimeouts)

Attributes

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

Members list

Value members

Concrete methods

override def endpointUrl: Option[String]

The endpoint this config will contact, when it is known statically.

The endpoint this config will contact, when it is known statically.

Used by policy checks and diagnostics that need to know where traffic will go without knowing which provider it belongs to. None means the config carries no single URL — not that it makes no network calls.

Attributes

Definition Classes
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any

The same config, its client asking provider for the key on each request, so a rotated key is used without rebuilding the client.

The same config, its client asking provider for the key on each request, so a rotated key is used without rebuilding the client.

The loader calls this for a section that sets apiKeyFile. The default returns this: a config whose client cannot take a provider ignores it, and its apiKeyProvider stays None - which the loader reports as an error for apiKeyFile and code setting a provider should check. A config that supports it overrides this with its own return type.

Attributes

Definition Classes
def withBaseUrl(baseUrl: String): GeminiConfig
def withContextWindow(contextWindow: Int): GeminiConfig
def withGoogleSearch(enabled: Boolean): GeminiConfig
override def withModel(model: String): GeminiConfig

The same provider and credentials, pointed at a different model.

The same provider and credentials, pointed at a different model.

Attributes

Definition Classes
override def withNetwork(network: HttpNetworkSettings): GeminiConfig

The same config with the given proxy and TLS settings.

The same config with the given proxy and TLS settings.

The loader calls this on every config a descriptor builds, as it does withTimeouts, so a descriptor does not read the http block itself. The default returns this: a config that does not carry the setting ignores it. A config that does overrides this with its own return type.

Attributes

Definition Classes
def withReserveCompletion(reserveCompletion: Int): GeminiConfig
override def withTimeouts(timeouts: ProviderTimeouts): GeminiConfig

The same config with the given timeouts.

The same config with the given timeouts.

The loader calls this on every config a descriptor builds, passing the section's timeouts block, so a descriptor does not read the block itself. The default returns this: a config that does not carry timeouts, such as one supplied by another module, ignores them. A config that does overrides this with its own return type.

Attributes

Definition Classes

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product

Concrete fields

override val providerId: ProviderId

Canonical id of the provider this config addresses, e.g. ProviderId("openai").

Canonical id of the provider this config addresses, e.g. ProviderId("openai").

Attributes