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

AIAgentLLMReadSessionCommon

abstract class AIAgentLLMReadSessionCommon : AutoCloseable(source)

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

Inheritors

AIAgentLLMReadSession

Properties

config

val config: AIAgentConfig

Config of the agent running the session.

model

val model: LLModel

Represents the active language model used within the session.

prompt

val prompt: Prompt

Represents the current prompt associated with the LLM session. The prompt contains the input messages, model configuration, and parameters.

responseProcessor

val responseProcessor: ResponseProcessor?

Represents the active response processor within the session.

tools

val tools: List<ToolDescriptor>

Provides a list of available tools in the session.

Functions

open override fun close()

executeMultiple

suspend fun executeMultiple(prompt: Prompt, tools: List<ToolDescriptor>): List<Message.Response>

Executes a request for the provided prompt and tools and returns all response messages.

executeSingle

suspend fun executeSingle(prompt: Prompt, tools: List<ToolDescriptor>): Message.Response

Executes a request for the provided prompt and tools and returns the first response.

executeStreaming

fun executeStreaming(prompt: Prompt, tools: List<ToolDescriptor>): Flow<StreamFrame>

Executes a streaming request for the provided prompt and tools.

parseResponseToStructuredResponse

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

Parses a structured response from a language model message using the specified configuration.

requestLLM

suspend fun requestLLM(): Message.Response

Sends a request to the underlying LLM and returns the first non-reasoning response.

requestLLMForceOneTool

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

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

Sends a request to the language model while enforcing the use of a specific tool.

requestLLMMultiple

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

Sends a request to the language model and returns all response messages.

requestLLMMultipleChoices

suspend fun requestLLMMultipleChoices(): List<LLMChoice>

Sends a request to the language model and returns all available response choices.

requestLLMMultipleOnlyCallingTools

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

Sends a request to the language model that enforces the usage of tools and retrieves all responses.

requestLLMMultipleWithoutTools

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

Sends a request to the language model without utilizing any tools and returns multiple responses.

requestLLMOnlyCallingTools

suspend fun requestLLMOnlyCallingTools(): Message.Response

Sends a request to the language model that enforces the usage of tools and retrieves the response.

requestLLMStreaming

suspend fun requestLLMStreaming(): Flow<StreamFrame>

Sends a streaming request to the underlying LLM and returns the streamed response.

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.

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 to the language model without utilizing any tools and returns the response.

requestModeration

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

Sends a moderation request to the specified or default model.