agents-core/ai.koog.agents.core.dsl.builder/AIAgentSubgraphBuilderBase

AIAgentSubgraphBuilderBase

abstract class AIAgentSubgraphBuilderBase<Input, Output>(source)

Inheritors

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
Link copied to clipboard
fun <Input, Output> node(name: String? = null, execute: suspend AIAgentContextBase.(input: Input) -> Output): AIAgentNodeDelegateBase<Input, Output>

Defines a new node in the agent's stage, representing a unit of execution that takes an input and produces an output.

Link copied to clipboard
fun <T> AIAgentSubgraphBuilderBase<*, *>.nodeDoNothing(name: String? = null): AIAgentNodeDelegateBase<T, T>

A pass-through node that does nothing and returns input as output

Link copied to clipboard
fun AIAgentSubgraphBuilderBase<*, *>.nodeExecuteMultipleTools(name: String? = null, parallelTools: Boolean = false): AIAgentNodeDelegateBase<List<Message.Tool.Call>, List<ReceivedToolResult>>

A node that executes multiple tool calls. These calls can optionally be executed in parallel.

Link copied to clipboard
inline fun <ToolArg : Tool.Args, TResult : ToolResult> AIAgentSubgraphBuilderBase<*, *>.nodeExecuteSingleTool(name: String? = null, tool: Tool<ToolArg, TResult>, doUpdatePrompt: Boolean = true): AIAgentNodeDelegateBase<ToolArg, SafeTool.Result<TResult>>

A node that calls a specific tool directly using the provided arguments.

Link copied to clipboard
fun AIAgentSubgraphBuilderBase<*, *>.nodeExecuteTool(name: String? = null): AIAgentNodeDelegateBase<Message.Tool.Call, ReceivedToolResult>

A node that executes a tool call and returns its result.

Link copied to clipboard
fun <T> AIAgentSubgraphBuilderBase<*, *>.nodeLLMCompressHistory(name: String? = null, strategy: HistoryCompressionStrategy = HistoryCompressionStrategy.WholeHistory, preserveMemory: Boolean = true): AIAgentNodeDelegateBase<T, T>

A node that compresses the current LLM prompt (message history) into a summary, replacing messages with a TLDR.

Link copied to clipboard
fun AIAgentSubgraphBuilderBase<*, *>.nodeLLMRequest(name: String? = null, allowToolCalls: Boolean = true): AIAgentNodeDelegateBase<String, Message.Response>

A node that appends a user message to the LLM prompt and gets a response with optional tool usage.

Link copied to clipboard
fun AIAgentSubgraphBuilderBase<*, *>.nodeLLMRequestMultiple(name: String? = null): AIAgentNodeDelegateBase<String, List<Message.Response>>

A node that appends a user message to the LLM prompt and gets multiple LLM responses with tool calls enabled.

Link copied to clipboard
fun AIAgentSubgraphBuilderBase<*, *>.nodeLLMRequestStreaming(name: String? = null, structureDefinition: StructuredDataDefinition? = null): AIAgentNodeDelegateBase<String, Flow<String>>

A node that appends a user message to the LLM prompt and streams LLM response without transformation.

fun <T> AIAgentSubgraphBuilderBase<*, *>.nodeLLMRequestStreaming(name: String? = null, structureDefinition: StructuredDataDefinition? = null, transformStreamData: suspend (Flow<String>) -> Flow<T>): AIAgentNodeDelegateBase<String, Flow<T>>

A node that appends a user message to the LLM prompt, streams LLM response and transforms the stream data.

Link copied to clipboard
fun <T> AIAgentSubgraphBuilderBase<*, *>.nodeLLMRequestStructured(name: String? = null, structure: StructuredData<T>, retries: Int, fixingModel: LLModel): AIAgentNodeDelegateBase<String, Result<StructuredResponse<T>>>

A node that appends a user message to the LLM prompt and requests structured data from the LLM with error correction capabilities.

Link copied to clipboard
fun AIAgentSubgraphBuilderBase<*, *>.nodeLLMSendMessageForceOneTool(name: String? = null, tool: ToolDescriptor): AIAgentNodeDelegateBase<String, Message.Response>

A node that that appends a user message to the LLM prompt and forces the LLM to use a specific tool.

fun AIAgentSubgraphBuilderBase<*, *>.nodeLLMSendMessageForceOneTool(name: String? = null, tool: Tool<*, *>): AIAgentNodeDelegateBase<String, Message.Response>

A node that appends a user message to the LLM prompt and forces the LLM to use a specific tool.

Link copied to clipboard
fun AIAgentSubgraphBuilderBase<*, *>.nodeLLMSendMessageOnlyCallingTools(name: String? = null): AIAgentNodeDelegateBase<String, Message.Response>

A node that appends a user message to the LLM prompt and gets a response where the LLM can only call tools.

Link copied to clipboard
fun AIAgentSubgraphBuilderBase<*, *>.nodeLLMSendMultipleToolResults(name: String? = null): AIAgentNodeDelegateBase<List<ReceivedToolResult>, List<Message.Response>>

A node that adds multiple tool results to the prompt and gets multiple LLM responses.

Link copied to clipboard
fun AIAgentSubgraphBuilderBase<*, *>.nodeLLMSendToolResult(name: String? = null): AIAgentNodeDelegateBase<ReceivedToolResult, Message.Response>

A node that adds a tool result to the prompt and requests an LLM response.

Link copied to clipboard
fun AIAgentSubgraphBuilderBase<*, *>.nodeUpdatePrompt(name: String? = null, body: PromptBuilder.() -> Unit): AIAgentNodeDelegateBase<Unit, Unit>

A node that adds messages to the LLM prompt using the provided prompt builder.

Link copied to clipboard
fun <Input, Output> subgraph(name: String? = null, toolSelectionStrategy: ToolSelectionStrategy = ToolSelectionStrategy.ALL, define: AIAgentSubgraphBuilderBase<Input, Output>.() -> Unit): AIAgentSubgraphDelegateBase<Input, Output>

Creates a subgraph with specified tool selection strategy.

fun <Input, Output> subgraph(name: String? = null, tools: List<Tool<*, *>>, define: AIAgentSubgraphBuilderBase<Input, Output>.() -> Unit): AIAgentSubgraphDelegateBase<Input, Output>

Creates a subgraph with specified tools.

Link copied to clipboard