agents-core/ai.koog.agents.core.agent.entity/FullAgentEdgeBuilder

FullAgentEdgeBuilder

open class FullAgentEdgeBuilder<IncomingOutput, IntermediateOutput, OutgoingInput>(source)

A builder class for constructing a specialized edge in an AI agent strategy graph. This edge enables data flow between two nodes while supporting a composition of the output transformation logic.

Parameters

fromNode

The source node in the strategy graph. This node produces the input data.

toNode

The destination node in the strategy graph. This node consumes the transformed data.

forwardOutputComposition

A suspendable function that transforms the output of the fromNode into an intermediate format before passing it to the toNode. The transformation output is represented as an Option type, allowing for optional chaining and flexibility in data flow.

Type Parameters

IncomingOutput

The type of input data from the fromNode.

IntermediateOutput

The type of processed data output by the forwardOutputComposition function.

OutgoingInput

The type of input data expected by the toNode.

Inheritors

CompatibleFullAgentEdgeBuilder

Functions

asToolResultMessage

fun asToolResultMessage(condition: SimpleCondition<ReceivedToolResult> = { true }): FullAgentEdgeBuilder<IncomingOutput, ERROR CLASS: Symbol not found for Message.User, OutgoingInput>

Creates an edge that transforms an intermediate output into a Message.User using the provided transform.

asUserMessage

fun asUserMessage(transformation: SimpleTransformation<IntermediateOutput, String> = { it.toString() }): FullAgentEdgeBuilder<IncomingOutput, ERROR CLASS: Symbol not found for Message.User, OutgoingInput>

Creates an edge that transforms an intermediate output into a Message.User using the provided transform.

build

open fun build(): AIAgentEdge<IncomingOutput, OutgoingInput>

Builds the edge between the source and destination nodes.

onCondition

open fun onCondition(condition: ContextualCondition<IntermediateOutput>): FullAgentEdgeBuilder<IncomingOutput, IntermediateOutput, OutgoingInput>

Applies a contextual condition to filter the output being processed and forwarded within the graph.

open fun onCondition(condition: SimpleCondition<IntermediateOutput>): FullAgentEdgeBuilder<IncomingOutput, IntermediateOutput, OutgoingInput>

Attaches a condition that filters intermediate outputs before they are propagated to the target node within the agent's processing graph.

onIsInstance

open fun <OutputSubtype : IntermediateOutput> onIsInstance(clazz: Class<OutputSubtype>): FullAgentEdgeBuilder<IncomingOutput, OutputSubtype, OutgoingInput>

Filters the outputs of the current processing edge based on their type, forwarding only those that are instances of the specified class.

open fun <CompatibleOutput : OutgoingInput> onIsInstance(clazz: Class<CompatibleOutput>): CompatibleFullAgentEdgeBuilder<IncomingOutput, CompatibleOutput, OutgoingInput>

Filters intermediate outputs to only process those that are instances of the specified class type.

onMessageParts

fun <T : ERROR CLASS: Symbol not found for MessagePart> onMessageParts(clazz: Class<T>): FullAgentEdgeBuilder<IncomingOutput, List<T>, OutgoingInput>

Filters the intermediate output to only Message instances that contain parts of type T, and transforms the output to a list of those parts.

onTextMessage

fun onTextMessage(): FullAgentEdgeBuilder<IncomingOutput, String, OutgoingInput>

Creates an edge that extracts text content from message parts.

onToolCalls

fun onToolCalls(condition: SimpleCondition<ERROR CLASS: Symbol not found for MessagePart.Tool.Call> = { true }): FullAgentEdgeBuilder<IncomingOutput, ToolCalls, OutgoingInput>

Creates an edge that filters assistant messages containing tool calls matching the provided condition. The default condition onToolCalls { true } accepts any message with at least one tool call.

transformed

fun <CompatibleOutput : OutgoingInput> transformed(transformation: ContextualTransformation<IntermediateOutput, CompatibleOutput>): CompatibleFullAgentEdgeBuilder<IncomingOutput, CompatibleOutput, OutgoingInput>

fun <TransformedOutput> transformed(transformation: ContextualTransformation<IntermediateOutput, TransformedOutput>): FullAgentEdgeBuilder<IncomingOutput, TransformedOutput, OutgoingInput>

fun <CompatibleOutput : OutgoingInput> transformed(transformation: SimpleTransformation<IntermediateOutput, CompatibleOutput>): CompatibleFullAgentEdgeBuilder<IncomingOutput, CompatibleOutput, OutgoingInput>

fun <TransformedOutput> transformed(transformation: SimpleTransformation<IntermediateOutput, TransformedOutput>): FullAgentEdgeBuilder<IncomingOutput, TransformedOutput, OutgoingInput>

Transforms the intermediate output of the AIAgentNode by applying a given transformation block.

withAction

fun <NewOutput : OutgoingInput> withAction(action: ContextualTransformation<IntermediateOutput, NewOutput>): CompatibleFullAgentEdgeBuilder<IncomingOutput, NewOutput, OutgoingInput>

fun <NewOutput : OutgoingInput> withAction(action: SimpleTransformation<IntermediateOutput, NewOutput>): CompatibleFullAgentEdgeBuilder<IncomingOutput, NewOutput, OutgoingInput>

Transforms the intermediate output of the edge by applying the given action. This is an alias for transformed providing naming consistency with the node builder API.