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

FinishNode

class FinishNode<TOutput> : AIAgentNode<TOutput, TOutput> (source)

Represents a specialized node within an AI agent strategy graph that marks the endpoint of a subgraph. This node serves as a "finish" node and directly passes its input to its output without modification.

This node enforces the following constraints:

It cannot have outgoing edges, meaning no further nodes can follow it in the execution graph.
It simply returns the input it receives as its output, ensuring no modification occurs at the end of execution.

The name property of the node reflects a uniquely identifiable pattern using the prefix "finish" and the optional subgraph name, enabling traceability of execution flow in multi-subgraph setups.

Parameters

subgraphName

The name of the related subgraph

type

TypeToken representing TOutput

Type Parameters

TOutput

The type of data this node processes and produces.

Constructors

FinishNode

constructor(subgraphName: String? = null, type: KType)

Secondary constructor for FinishNode allowing initialization with a KType instead of a TypeToken.

Properties

edges

var edges: List<AIAgentEdge<TOutput, *>>

Represents the directed edges connecting the current node in the AI agent strategy graph to other nodes. Each edge defines the flow and transformation of output data from this node to another.

execute

val execute: suspend AIAgentGraphContextBase.(input: TOutput) -> TOutput

A suspendable lambda function that defines the execution logic of the node. It operates in the context of an AIAgentGraphContextBase, taking an input of type TInput and producing an output of type TOutput.

val id: String

Represents the unique identifier of the AI agent node.

inputType

open override val inputType: TypeToken

The TypeToken representing the expected type of input for the node.

name

open override val name: String

The name of the node, used for identification within the graph.

outputType

open override val outputType: TypeToken

The TypeToken representing the type of output produced by the node.

Functions

addEdge

open override fun addEdge(edge: AIAgentEdge<TOutput, *>)

Adds a directed edge from the current node, enabling connections between this node and other nodes in the AI agent strategy graph.

execute

open suspend override fun execute(context: AIAgentGraphContextBase, input: TOutput): TOutput

Executes a specific operation based on the given context and input.

executeUnsafe

suspend fun executeUnsafe(context: AIAgentGraphContextBase, input: Any?): Any?

Executes the node operation using the provided execution context and input, bypassing type safety checks. This method internally calls the type-safe execute method after casting the input.

forwardTo

infix fun <OutgoingInput> forwardTo(otherNode: AIAgentNodeBase<OutgoingInput, *>): AIAgentEdgeBuilderIntermediate<TOutput, TOutput, OutgoingInput>

Creates a directed edge from this AIAgentNodeBase to another AIAgentNodeBase, allowing data to flow from the output of the current node to the input of the specified node.

forwardTo

infix fun <IncomingOutput, OutgoingInput> AIAgentNodeBase<*, IncomingOutput>.~~forwardTo~~(otherNode: AIAgentNodeBase<OutgoingInput, *>): AIAgentEdgeBuilderIntermediate<IncomingOutput, IncomingOutput, OutgoingInput>

Creates a directed edge from this AIAgentNodeBase to another AIAgentNodeBase, allowing data to flow from the output of the current node to the input of the specified node.

resolveEdge

suspend fun resolveEdge(context: AIAgentGraphContextBase, nodeOutput: TOutput): AIAgentNodeBase.ResolvedEdge?

Resolves the edge associated with the provided node output and execution context. Iterates through available edges and identifies the first edge that can successfully process the given node output within the provided context. If a resolvable edge is found, it returns a ResolvedEdge containing the edge and its output. Otherwise, returns null.