agents-core/ai.koog.agents.core.agent.session/AIAgentLLMWriteSessionCommon

AIAgentLLMWriteSessionCommon

abstract class AIAgentLLMWriteSessionCommon : AutoCloseable(source)

Common base implementation for mutable LLM sessions shared across platform-specific actual classes.

Inheritors

AIAgentLLMWriteSession

Properties

clock

val clock: Clock

config

val config: AIAgentConfig

environment

val environment: AIAgentEnvironment

model

var model: LLModel

Represents the active language model used within the session.

prompt

var prompt: Prompt

Represents the current prompt associated with the LLM session.

responseProcessor

var responseProcessor: ResponseProcessor?

Represents the active response processor within the session.

toolRegistry

val toolRegistry: ToolRegistry

tools

var tools: List<ToolDescriptor>

Provides a list of available tools in the session.

Functions

appendPrompt

fun appendPrompt(body: PromptBuilder.() -> Unit)

Appends messages to the current prompt using PromptBuilder.

changeLLMParams

fun changeLLMParams(newParams: LLMParams)

Updates LLM parameters on the current prompt.

changeModel

fun changeModel(newModel: LLModel)

Updates the active model in this session.

clearHistory

fun clearHistory()

Clears the history of messages in the current AI Agent LLM Write Session.

open override fun close()

dropLastNMessages

fun dropLastNMessages(n: Int, preserveSystemMessages: Boolean = true)

Removes the last n messages from the current prompt in the write session.

dropTrailingToolCalls

fun dropTrailingToolCalls()

Drops all trailing tool call messages from the current prompt

findTool

fun <TArgs, TResult> findTool(tool: Tool<TArgs, TResult>): SafeTool<TArgs, TResult>

Finds a specific tool instance from the tool registry by a tool instance type.

fun <TArgs, TResult> findTool(toolClass: KClass<out Tool<TArgs, TResult>>): SafeTool<TArgs, TResult>

Finds a specific tool instance from the tool registry by tool class.

leaveLastNMessages

fun leaveLastNMessages(n: Int, preserveSystemMessages: Boolean = true)

Keeps only the last N messages in the session's prompt by removing all earlier messages.

leaveMessagesFromTimestamp

fun leaveMessagesFromTimestamp(timestamp: Instant, preserveSystemMessages: Boolean = true)

Removes all messages from the current session's prompt that have a timestamp earlier than the specified timestamp.

parseResponseToStructuredResponse

suspend fun <T> parseResponseToStructuredResponse(response: Message.Assistant, config: StructuredRequestConfig<T>, fixingParser: StructureFixingParser? = null): StructuredResponse<T>

Parses a structured response from an assistant message using the specified configuration.

replaceHistoryWithTLDR

suspend fun replaceHistoryWithTLDR(strategy: HistoryCompressionStrategy = HistoryCompressionStrategy.WholeHistory, preserveMemory: Boolean = true)

Rewrites LLM message history, leaving only user message and resulting TLDR.

requestLLM

suspend fun requestLLM(): Message.Response

Sends a request to LLM and appends the response to the prompt.

requestLLMForceOneTool

suspend fun requestLLMForceOneTool(tool: ToolDescriptor): Message.Response

suspend fun requestLLMForceOneTool(tool: Tool<*, *>): Message.Response

Sends a request while forcing a specific tool and appends the response to the prompt.

requestLLMMultiple

suspend fun requestLLMMultiple(): List<Message.Response>

Sends a request to LLM and appends all received responses to the prompt.

requestLLMMultipleChoices

suspend fun requestLLMMultipleChoices(): List<LLMChoice>

Sends a request to LLM and returns all available response choices.

requestLLMMultipleOnlyCallingTools

suspend fun requestLLMMultipleOnlyCallingTools(): List<Message.Response>

Sends a request that enforces tool calling and appends all received responses to the prompt.

requestLLMMultipleWithoutTools

suspend fun requestLLMMultipleWithoutTools(): List<Message.Response>

Sends a request without tool usage and appends all received responses to the prompt.

requestLLMOnlyCallingTools

suspend fun requestLLMOnlyCallingTools(): Message.Response

Sends a request that enforces tool calling and appends the received response to the prompt.

requestLLMStreaming

suspend fun requestLLMStreaming(): Flow<StreamFrame>

Sends a streaming request to LLM.

suspend fun requestLLMStreaming(definition: StructureDefinition? = null): Flow<StreamFrame>

Streams a response from LLM, optionally adding a structure definition to the prompt beforehand.

requestLLMStructured

suspend fun <T> requestLLMStructured(config: StructuredRequestConfig<T>, fixingParser: StructureFixingParser? = null): Result<StructuredResponse<T>>

suspend fun <T> requestLLMStructured(serializer: KSerializer<T>, examples: List<T> = emptyList(), fixingParser: StructureFixingParser? = null): Result<StructuredResponse<T>>

Sends a request to LLM and gets a structured response, appending the assistant message on success.

inline suspend fun <T> requestLLMStructured(examples: List<T> = emptyList(), fixingParser: StructureFixingParser? = null): Result<StructuredResponse<T>>

Requests a structured response from the language model using a reified serializer.

requestLLMWithoutTools

suspend fun requestLLMWithoutTools(): Message.Response

Sends a request without tool usage and appends the received response to the prompt.

requestModeration

suspend fun requestModeration(moderatingModel: LLModel? = null): ModerationResult

Sends a moderation request using the specified moderating model or the session model.

rewritePrompt

fun rewritePrompt(body: (prompt: Prompt) -> Prompt)

Rewrites the current prompt by applying a transformation function.

setToolChoice

fun setToolChoice(toolChoice: LLMParams.ToolChoice?)

Sets the ai.koog.prompt.params.LLMParams.ToolChoice for this LLM session.

setToolChoiceAuto

fun setToolChoiceAuto()

Set the ai.koog.prompt.params.LLMParams.ToolChoice to ai.koog.prompt.params.LLMParams.ToolChoice.Auto to make LLM automatically decide between calling tools and generating text

setToolChoiceNamed

fun setToolChoiceNamed(toolName: String)

Set the ai.koog.prompt.params.LLMParams.ToolChoice to ai.koog.prompt.params.LLMParams.ToolChoice.None to make LLM call one specific tool toolName

setToolChoiceNone

fun setToolChoiceNone()

Set the ai.koog.prompt.params.LLMParams.ToolChoice to ai.koog.prompt.params.LLMParams.ToolChoice.None to make LLM never call tools

setToolChoiceRequired

fun setToolChoiceRequired()

Set the ai.koog.prompt.params.LLMParams.ToolChoice to ai.koog.prompt.params.LLMParams.ToolChoice.Required to make LLM always call tools

toParallelToolCalls

inline fun <TArgs, TResult> Flow<TArgs>.toParallelToolCalls(safeTool: SafeTool<TArgs, TResult>, concurrency: Int = 16): Flow<SafeTool.Result<TResult>>

Converts each flow item into a parallel tool call using an already resolved SafeTool.

inline fun <TArgs, TResult> Flow<TArgs>.toParallelToolCalls(tool: Tool<TArgs, TResult>, concurrency: Int = 16): Flow<SafeTool.Result<TResult>>

Converts each flow item into a parallel tool call using a tool instance.

inline fun <TArgs, TResult> Flow<TArgs>.toParallelToolCalls(toolClass: KClass<out Tool<TArgs, TResult>>, concurrency: Int = 16): Flow<SafeTool.Result<TResult>>

Converts each flow item into a parallel tool call using a tool class.

toParallelToolCallsRaw

inline fun <TArgs, TResult> Flow<TArgs>.toParallelToolCallsRaw(safeTool: SafeTool<TArgs, TResult>, concurrency: Int = 16): Flow<String>

Converts each flow item into a parallel tool call and emits only raw string content.

inline fun <TArgs, TResult> Flow<TArgs>.toParallelToolCallsRaw(toolClass: KClass<out Tool<TArgs, TResult>>, concurrency: Int = 16): Flow<String>

Converts each flow item into a parallel tool call using a tool class and emits raw string content.

unsetToolChoice

fun unsetToolChoice()

Unset the ai.koog.prompt.params.LLMParams.ToolChoice. Mostly, if left unspecified, the default value of this parameter is ai.koog.prompt.params.LLMParams.ToolChoice.Auto

updatePrompt

fun ~~updatePrompt~~(body: PromptBuilder.() -> Unit)

Updates the current prompt by applying modifications defined in the provided block.