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

AIAgentLLMReadSession

expect class AIAgentLLMReadSession : AIAgentLLMReadSessionCommon(source)

Represents a session for interacting with a language model (LLM) in a read-only context within an AI agent setup.

actual class AIAgentLLMReadSession : AIAgentLLMReadSessionCommon(source)

JVM actual implementation of a read-only LLM session.

In addition to common suspend APIs, this class exposes Java-friendly wrappers that run session operations on the strategy dispatcher.

actual class AIAgentLLMReadSession : AIAgentLLMReadSessionCommon(source)

Represents a session for interacting with a language model (LLM) in a read-only context within an AI agent setup.

Constructors

AIAgentLLMReadSession

actual constructor(tools: List<ERROR CLASS: Symbol not found for ToolDescriptor>, executor: ERROR CLASS: Symbol not found for PromptExecutor, prompt: ERROR CLASS: Symbol not found for Prompt, model: ERROR CLASS: Symbol not found for LLModel, responseProcessor: ERROR CLASS: Symbol not found for ResponseProcessor??, config: AIAgentConfig)

actual constructor(tools: List<ToolDescriptor>, executor: PromptExecutor, prompt: Prompt, model: LLModel, responseProcessor: ResponseProcessor?, config: AIAgentConfig)

Properties

config

val config: AIAgentConfig

Config of the agent running the session.

val config: AIAgentConfig

Config of the agent running the session.

val config: AIAgentConfig

Config of the agent running the session.

model

val model: LLModel

Represents the active language model used within the session.

val model: ai/koog/prompt/llm/LLModel

Represents the active language model used within the session.

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.

val prompt: ai/koog/prompt/Prompt

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

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.

val responseProcessor: ai/koog/prompt/processor/ResponseProcessor??

Represents the active response processor within the session.

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.

val tools: List<ai/koog/agents/core/tools/ToolDescriptor>

Provides a list of available tools in the session.

val tools: List<ToolDescriptor>

Provides a list of available tools in the session.

Functions

open override fun close()

executeBlocking

fun executeBlocking(prompt: ERROR CLASS: Symbol not found for Prompt, tools: List<ERROR CLASS: Symbol not found for ToolDescriptor>): ERROR CLASS: Symbol not found for Message.Assistant

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.

suspend fun <T> parseResponseToStructuredResponse(response: ai/koog/prompt/message/Message.Assistant, config: ai/koog/prompt/structure/StructuredRequestConfig<T>, fixingParser: ai/koog/prompt/executor/model/StructureFixingParser?? = null): ai/koog/prompt/structure/StructuredResponse<T>

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

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.

parseResponseToStructuredResponseBlocking

fun <T> parseResponseToStructuredResponseBlocking(response: ERROR CLASS: Symbol not found for Message.Assistant, config: ERROR CLASS: Symbol not found for StructuredRequestConfig<T>, fixingParser: ERROR CLASS: Symbol not found for StructureFixingParser?? = null): ERROR CLASS: Symbol not found for StructuredResponse<T>

requestLLM

suspend fun requestLLM(): Message.Assistant

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

suspend fun requestLLM(): ai/koog/prompt/message/Message.Assistant

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

suspend fun requestLLM(): Message.Assistant

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

requestLLMBlocking

fun requestLLMBlocking(): ERROR CLASS: Symbol not found for Message.Assistant

requestLLMForceOneTool

suspend fun requestLLMForceOneTool(tool: ToolBase<*, *>): Message.Assistant

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

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

suspend fun requestLLMForceOneTool(tool: ai/koog/agents/core/tools/ToolBase<*, *>): ai/koog/prompt/message/Message.Assistant

suspend fun requestLLMForceOneTool(tool: ai/koog/agents/core/tools/ToolDescriptor): ai/koog/prompt/message/Message.Assistant

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

suspend fun requestLLMForceOneTool(tool: ToolBase<*, *>): Message.Assistant

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

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

requestLLMForceOneToolBlocking

fun requestLLMForceOneToolBlocking(tool: ERROR CLASS: Symbol not found for ToolBase<*, *>): ERROR CLASS: Symbol not found for Message.Assistant

fun requestLLMForceOneToolBlocking(tool: ERROR CLASS: Symbol not found for ToolDescriptor): ERROR CLASS: Symbol not found for Message.Assistant

requestLLMMultipleChoices

suspend fun requestLLMMultipleChoices(): LLMChoice

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

suspend fun requestLLMMultipleChoices(): List<ai/koog/prompt/message/Message.Assistant>

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

suspend fun requestLLMMultipleChoices(): LLMChoice

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

requestLLMMultipleChoicesBlocking

fun requestLLMMultipleChoicesBlocking(): ERROR CLASS: Symbol not found for LLMChoice

requestLLMOnlyCallingTools

suspend fun requestLLMOnlyCallingTools(): Message.Assistant

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

suspend fun requestLLMOnlyCallingTools(): ai/koog/prompt/message/Message.Assistant

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

suspend fun requestLLMOnlyCallingTools(): Message.Assistant

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

requestLLMOnlyCallingToolsBlocking

fun requestLLMOnlyCallingToolsBlocking(): ERROR CLASS: Symbol not found for Message.Assistant

requestLLMStreaming

suspend fun requestLLMStreaming(): Flow<StreamFrame>

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

suspend fun requestLLMStreaming(): kotlinx/coroutines/flow/Flow<ai/koog/prompt/streaming/StreamFrame>

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

suspend fun requestLLMStreaming(): Flow<StreamFrame>

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

requestLLMStreamingBlocking

fun requestLLMStreamingBlocking(): Flow.Publisher<ERROR CLASS: Symbol not found for StreamFrame>

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.

suspend fun <T> requestLLMStructured(config: ai/koog/prompt/structure/StructuredRequestConfig<T>, fixingParser: ai/koog/prompt/executor/model/StructureFixingParser?? = null): kotlin/Result<ai/koog/prompt/structure/StructuredResponse<T>>

suspend fun <T> requestLLMStructured(serializer: kotlinx/serialization/KSerializer<T>, examples: List<T> = emptyList(), fixingParser: ai/koog/prompt/executor/model/StructureFixingParser?? = null): kotlin/Result<ai/koog/prompt/structure/StructuredResponse<T>>

Sends a request to LLM and gets a structured response.

inline suspend fun <T> requestLLMStructured(examples: List<T> = emptyList(), fixingParser: ai/koog/prompt/executor/model/StructureFixingParser?? = null): kotlin/Result<ai/koog/prompt/structure/StructuredResponse<T>>

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

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.

requestLLMStructuredBlocking

fun <T> requestLLMStructuredBlocking(config: ERROR CLASS: Symbol not found for StructuredRequestConfig<T>, fixingParser: ERROR CLASS: Symbol not found for StructureFixingParser?? = null): ERROR CLASS: Symbol not found for Result<ERROR CLASS: Symbol not found for StructuredResponse<T>>

fun <T> requestLLMStructuredBlocking(serializer: ERROR CLASS: Symbol not found for KSerializer<T>, examples: List<T> = emptyList(), fixingParser: ERROR CLASS: Symbol not found for StructureFixingParser?? = null): ERROR CLASS: Symbol not found for Result<ERROR CLASS: Symbol not found for StructuredResponse<T>>

requestLLMWithoutTools

suspend fun requestLLMWithoutTools(): Message.Assistant

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

suspend fun requestLLMWithoutTools(): ai/koog/prompt/message/Message.Assistant

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

suspend fun requestLLMWithoutTools(): Message.Assistant

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

requestLLMWithoutToolsBlocking

fun requestLLMWithoutToolsBlocking(): ERROR CLASS: Symbol not found for Message.Assistant

requestModeration

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

Sends a moderation request to the specified or default model.

suspend fun requestModeration(moderatingModel: ai/koog/prompt/llm/LLModel?? = null): ai/koog/prompt/dsl/ModerationResult

Sends a moderation request to the specified or default model.

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

Sends a moderation request to the specified or default model.

requestModerationBlocking

fun requestModerationBlocking(moderatingModel: ERROR CLASS: Symbol not found for LLModel?? = null): ERROR CLASS: Symbol not found for ModerationResult