agents-core/ai.koog.agents.planner/PlannerAIAgent

PlannerAIAgent

class PlannerAIAgent<Input, Output>(val promptExecutor: PromptExecutor, val agentConfig: AIAgentConfig, val strategy: AIAgentPlannerStrategy<Input, Output, *>, val toolRegistry: ToolRegistry = ToolRegistry.EMPTY, id: String? = null, val clock: Clock = Clock.System, val installFeatures: PlannerAIAgent.FeatureContext.() -> Unit = {}) : AIAgentBase<Input, Output, AIAgentPlannerContext> (source)

Represents an instance of planner agent using AIAgentPlannerStrategy.

Parameters

State

The type of the state.

Plan

The type of the plan.

Constructors

PlannerAIAgent

constructor(promptExecutor: PromptExecutor, agentConfig: AIAgentConfig, strategy: AIAgentPlannerStrategy<Input, Output, *>, toolRegistry: ToolRegistry = ToolRegistry.EMPTY, id: String? = null, clock: Clock = Clock.System, installFeatures: PlannerAIAgent.FeatureContext.() -> Unit = {})

Types

Companion

object Companion

Companion object providing the static builder() method.

FeatureContext

class FeatureContext

Represents a context for managing and configuring features in an AI agent. Provides functionality to install and configure features into a specific instance of an AI agent.

Properties

agentConfig

open override val agentConfig: AIAgentConfig

The configuration for the agent.

clock

val clock: Clock

The clock used to calculate message timestamps

override val id: String

Represents the unique identifier for the AI agent.

installFeatures

val installFeatures: PlannerAIAgent.FeatureContext.() -> Unit

Lambda for installing additional features within the agent environment.

pipeline

open override val pipeline: AIAgentPlannerPipeline

Represents the pipeline used by the AI agent for processing tasks or data.

promptExecutor

val promptExecutor: PromptExecutor

The executor responsible for processing prompts.

strategy

open override val strategy: AIAgentPlannerStrategy<Input, Output, *>

The strategy for processing input and generating output.

toolRegistry

val toolRegistry: ToolRegistry

The registry of tools available for the agent. Defaults to an empty registry if not specified.

Functions

asTool

inline fun <Input, Output> AIAgent<Input, Output>.~~asTool~~(agentName: String, agentDescription: String, inputDescription: String? = null, inputSerializer: KSerializer<Input> = serializer(), outputSerializer: KSerializer<Output> = serializer(), json: Json = Json.Default): Tool<Input, AIAgentTool.AgentToolResult<Output>>

Converts the current AI agent into a tool to allow using it in other agents as a tool.

open suspend override fun close()

Closes the AI Agent and performs necessary cleanup operations.

createSession

open override fun createSession(sessionId: String?): AIAgentRunSession<Input, Output, AIAgentPlannerContext>

Creates a new AIAgentRunSession for executing the agent with the given input.

prepareContext

open suspend override fun prepareContext(agentInput: Input, runId: String, eventId: String): AIAgentPlannerContext

Prepares and initializes the agent context required to handle the given input and run ID.

run

open suspend override fun run(agentInput: Input, sessionId: String?): Output

Executes the agent's main functionality, coordinating with various components such as pipelines and strategies. Ensures the agent is run in a thread-safe manner using locking mechanisms.