Embabel Agent Documentation/com.embabel.common.ai.model/LlmOptions

LlmOptions

data class LlmOptions constructor(var modelSelectionCriteria: ModelSelectionCriteria? = null, var model: String? = null, var role: String? = null, var temperature: Double? = null, var frequencyPenalty: Double? = null, var maxTokens: Int? = null, var presencePenalty: Double? = null, var topK: Int? = null, var topP: Double? = null, var thinking: Thinking? = null, var timeout: Duration? = null, extensions: Map<String, Any> = emptyMap()) : LlmHyperparameters

Portable LLM options.

Parameters

modelSelectionCriteria

explicit model selection criteria. If provided, overrides model and role.

model

Optional model name to use. If provided, specifies an LLM by name. Takes precedence over role.

role

Optional role to use for model selection. If provided, and model is not specified, used to find an LLM by role

timeout

Optional timeout for this LLM call. If provided, overrides the default client timeout.

Constructors

constructor(modelSelectionCriteria: ModelSelectionCriteria? = null, model: String? = null, role: String? = null, temperature: Double? = null, frequencyPenalty: Double? = null, maxTokens: Int? = null, presencePenalty: Double? = null, topK: Int? = null, topP: Double? = null, thinking: Thinking? = null, timeout: Duration? = null, extensions: Map<String, Any> = emptyMap())

Types

object Companion

Properties

val criteria: ModelSelectionCriteria

frequencyPenalty

open override var frequencyPenalty: Double?

open override var maxTokens: Int?

var model: String?

val modelName: String?

The model these options name, however they name it.

modelSelectionCriteria

var modelSelectionCriteria: ModelSelectionCriteria?

presencePenalty

open override var presencePenalty: Double?

var role: String?

open override var temperature: Double?

var thinking: Thinking?

var timeout: Duration?

open override var topK: Int?

open override var topP: Double?

Functions

fun <T> getExtension(key: String): T?

Get a provider-specific extension value by key. Returns null if the extension is not present or cannot be cast to type T.

getNativeStructuredOutput

fun LlmOptions.getNativeStructuredOutput(): NativeStructuredOutputMode?

Read the native structured-output mode from LlmOptions.

open fun infoString(verbose: Boolean?, indent: Int): String

withDefaultsFrom

fun withDefaultsFrom(defaults: LlmOptions): LlmOptions

Fill in anything this instance leaves unset from defaults, keeping every value set here.

fun withExtension(key: String, value: Any): LlmOptions

Add or update a provider-specific extension. Returns a new LlmOptions with the extension added/updated.

withFrequencyPenalty

fun withFrequencyPenalty(frequencyPenalty: Double): LlmOptions

fun withMaxTokens(maxTokens: Int): LlmOptions

withNativeStructuredOutput

fun LlmOptions.withNativeStructuredOutput(mode: NativeStructuredOutputMode): LlmOptions

Attach a native structured-output mode to LlmOptions.

withoutThinking

fun withoutThinking(): LlmOptions

withPresencePenalty

fun withPresencePenalty(presencePenalty: Double): LlmOptions

withTemperature

fun withTemperature(temperature: Double?): LlmOptions

Create a copy with a default temperature for the LLM. If null, uses the default temperature for the model.

fun withThinking(thinking: Thinking): LlmOptions

fun withTimeout(timeout: Duration): LlmOptions

fun withTopK(topK: Int): LlmOptions

fun withTopP(topP: Double): LlmOptions