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

AIAgentStrategy

class AIAgentStrategy<Input, Output>(val name: String, val nodeStart: StartNode<Input>, val nodeFinish: FinishNode<Output>, toolSelectionStrategy: ToolSelectionStrategy, serializer: Json = Json { prettyPrint = true }) : AIAgentSubgraph<Input, Output> (source)

Represents a strategy for managing and executing AI agent workflows built as subgraphs of interconnected nodes.

Constructors

AIAgentStrategy

constructor(name: String, nodeStart: StartNode<Input>, nodeFinish: FinishNode<Output>, toolSelectionStrategy: ToolSelectionStrategy, serializer: Json = Json { prettyPrint = true })

Properties

edges

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

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.

finish

val finish: FinishNode<Output>

val id: String

Represents the unique identifier of the AI agent node.

inputType

open override val inputType: KType

The KType of the Input

metadata

lateinit var metadata: SubgraphMetadata

Represents the metadata of the subgraph associated with the AI agent strategy.

name

open override val name: String

The unique identifier for the strategy.

nodeFinish

val nodeFinish: FinishNode<Output>

The finishing node of the strategy, marking the subgraph's endpoint.

nodeStart

val nodeStart: StartNode<Input>

The starting node of the strategy, initiating the subgraph execution. By default, the start node gets the agent input and returns

outputType

open override val outputType: KType

The KType of the Output

start

val start: StartNode<Input>

Functions

addEdge

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

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

enforceExecutionPoint

open override fun enforceExecutionPoint(node: AIAgentNodeBase<*, *>, input: Any?)

Sets a forced node for the entity.

execute

open suspend override fun execute(context: AIAgentContextBase, input: Input): Output?

Executes the desired operation based on the input and the provided context. This function determines the execution strategy based on the tool selection strategy configured in the class.

executeUnsafe

suspend fun executeUnsafe(context: AIAgentContextBase, 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. The lifecycle hooks onBeforeNode and onAfterNode are invoked before and after the execution respectively.

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.

getExecutionPoint

open override fun getExecutionPoint(): ExecutionPoint?

Retrieves the current execution point, which consists of a specific node in the execution graph and an optional input. If no forced node is defined, the method returns null.

resetExecutionPoint

open override fun resetExecutionPoint()

Resets the currently enforced execution point for the AI agent, including clearing any forced node and input data. Once the execution point is reset, the system will revert to its default execution behavior without targeting a specific node explicitly.

resolveEdge

suspend fun resolveEdge(context: AIAgentContextBase, nodeOutput: Output): 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.

setExecutionPoint

fun setExecutionPoint(nodeId: String, input: JsonElement)

Finds and sets the node for the strategy based on the provided context.