agents-core/ai.koog.agents.core.feature.pipeline/AIAgentPlannerPipelineAPI

AIAgentPlannerPipelineAPI

interface AIAgentPlannerPipelineAPI : AIAgentPipelineAPI(source)

Platform-agnostic API for planner agent pipelines, extending the base pipeline API with planner-specific functionality.

Inheritors

AIAgentPlannerPipelineImpl

AIAgentPlannerPipeline

Properties

clock

abstract val clock: KoogClock

config

abstract val config: AIAgentConfig

Functions

closeAllFeaturesMessageProcessors

abstract suspend fun closeAllFeaturesMessageProcessors()

collectToolCallMetadata

abstract suspend fun collectToolCallMetadata(eventId: String, executionInfo: AgentExecutionInfo, runId: String, toolCallId: String?, toolName: String, toolDescription: String?, toolArgs: JSONObject, context: AIAgentContext): ToolCallMetadata

Collects metadata contributions from every feature that registered a handler via provideToolCallMetadata and returns the combined map.

feature

abstract fun <TFeature : Any> feature(featureClass: KClass<TFeature>, feature: AIAgentFeature<*, TFeature>): TFeature?

install

abstract fun <TConfig : FeatureConfig, TFeatureImpl : Any> install(featureKey: AIAgentStorageKey<TFeatureImpl>, featureConfig: TConfig, featureImpl: TFeatureImpl)

interceptAgentClosing

abstract fun interceptAgentClosing(feature: AIAgentFeature<*, *>, handle: suspend (eventContext: AgentClosingContext) -> Unit)

interceptAgentCompleted

abstract fun interceptAgentCompleted(feature: AIAgentFeature<*, *>, handle: suspend (eventContext: AgentCompletedContext) -> Unit)

interceptAgentExecutionFailed

abstract fun interceptAgentExecutionFailed(feature: AIAgentFeature<*, *>, handle: suspend (eventContext: AgentExecutionFailedContext) -> Unit)

interceptAgentStarting

abstract fun interceptAgentStarting(feature: AIAgentFeature<*, *>, handle: suspend (AgentStartingContext) -> Unit)

interceptEnvironmentCreated

abstract fun interceptEnvironmentCreated(feature: AIAgentFeature<*, *>, handle: suspend (eventContext: AgentEnvironmentTransformingContext, environment: AIAgentEnvironment) -> AIAgentEnvironment)

interceptLLMCallCompleted

abstract fun interceptLLMCallCompleted(feature: AIAgentFeature<*, *>, handle: suspend (eventContext: LLMCallCompletedContext) -> Unit)

interceptLLMCallFailed

abstract fun interceptLLMCallFailed(feature: AIAgentFeature<*, *>, handle: suspend (eventContext: LLMCallFailedContext) -> Unit)

interceptLLMCallStarting

abstract fun interceptLLMCallStarting(feature: AIAgentFeature<*, *>, handle: suspend (eventContext: LLMCallStartingContext) -> Unit)

interceptLLMStreamingCompleted

abstract fun interceptLLMStreamingCompleted(feature: AIAgentFeature<*, *>, handle: suspend (eventContext: LLMStreamingCompletedContext) -> Unit)

interceptLLMStreamingFailed

abstract fun interceptLLMStreamingFailed(feature: AIAgentFeature<*, *>, handle: suspend (eventContext: LLMStreamingFailedContext) -> Unit)

interceptLLMStreamingFrameReceived

abstract fun interceptLLMStreamingFrameReceived(feature: AIAgentFeature<*, *>, handle: suspend (eventContext: LLMStreamingFrameReceivedContext) -> Unit)

interceptLLMStreamingStarting

abstract fun interceptLLMStreamingStarting(feature: AIAgentFeature<*, *>, handle: suspend (eventContext: LLMStreamingStartingContext) -> Unit)

interceptPlanCompletionEvaluationCompleted

abstract fun interceptPlanCompletionEvaluationCompleted(feature: AIAgentFeature<*, *>, handle: suspend (PlanCompletionEvaluationCompletedContext) -> Unit)

Intercepts plan completion evaluation completed event to perform actions when a plan is evaluated for completion.

interceptPlanCompletionEvaluationStarting

abstract fun interceptPlanCompletionEvaluationStarting(feature: AIAgentFeature<*, *>, handle: suspend (PlanCompletionEvaluationStartingContext) -> Unit)

Intercepts plan completion evaluation starting event to perform actions when a plan is about to be evaluated for completion.

interceptPlanCreationCompleted

abstract fun interceptPlanCreationCompleted(feature: AIAgentFeature<*, *>, handle: suspend (PlanCreationCompletedContext) -> Unit)

Intercepts plan creation completed event to perform actions when a plan completes creation.

interceptPlanCreationStarting

abstract fun interceptPlanCreationStarting(feature: AIAgentFeature<*, *>, handle: suspend (PlanCreationStartingContext) -> Unit)

Intercepts plan creation starting event to perform actions when a plan begins creation.

interceptStepExecutionCompleted

abstract fun interceptStepExecutionCompleted(feature: AIAgentFeature<*, *>, handle: suspend (StepExecutionCompletedContext) -> Unit)

Intercepts step execution completed event to perform actions when a plan step completes execution.

interceptStepExecutionStarting

abstract fun interceptStepExecutionStarting(feature: AIAgentFeature<*, *>, handle: suspend (StepExecutionStartingContext) -> Unit)

Intercepts step execution starting event to perform actions when a plan step begins execution.

interceptStrategyCompleted

abstract fun interceptStrategyCompleted(feature: AIAgentFeature<*, *>, handle: suspend (StrategyCompletedContext) -> Unit)

interceptStrategyStarting

abstract fun interceptStrategyStarting(feature: AIAgentFeature<*, *>, handle: suspend (StrategyStartingContext) -> Unit)

interceptToolCallCompleted

abstract fun interceptToolCallCompleted(feature: AIAgentFeature<*, *>, handle: suspend (eventContext: ToolCallCompletedContext) -> Unit)

interceptToolCallFailed

abstract fun interceptToolCallFailed(feature: AIAgentFeature<*, *>, handle: suspend (eventContext: ToolCallFailedContext) -> Unit)

interceptToolCallStarting

abstract fun interceptToolCallStarting(feature: AIAgentFeature<*, *>, handle: suspend (eventContext: ToolCallStartingContext) -> Unit)

interceptToolValidationFailed

abstract fun interceptToolValidationFailed(feature: AIAgentFeature<*, *>, handle: suspend (eventContext: ToolValidationFailedContext) -> Unit)

onAgentClosing

abstract suspend fun onAgentClosing(eventId: String, executionInfo: AgentExecutionInfo, agent: AIAgent<*, *>)

onAgentCompleted

abstract suspend fun onAgentCompleted(eventId: String, executionInfo: AgentExecutionInfo, agent: AIAgent<*, *>, context: AIAgentContext, runId: String, result: Any?)

onAgentEnvironmentTransforming

abstract suspend fun onAgentEnvironmentTransforming(eventId: String, executionInfo: AgentExecutionInfo, agent: AIAgent<*, *>, baseEnvironment: AIAgentEnvironment): AIAgentEnvironment

onAgentExecutionFailed

abstract suspend fun onAgentExecutionFailed(eventId: String, executionInfo: AgentExecutionInfo, agent: AIAgent<*, *>, context: AIAgentContext, runId: String, error: Throwable)

onAgentStarting

abstract suspend fun <TInput, TOutput> onAgentStarting(eventId: String, executionInfo: AgentExecutionInfo, agent: AIAgent<*, *>, context: AIAgentContext, runId: String)

onLLMCallCompleted

abstract suspend fun onLLMCallCompleted(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, runId: String, prompt: Prompt, model: LLModel, tools: List<ToolDescriptor>, response: Message.Assistant?, moderationResponse: ModerationResult? = null)

onLLMCallFailed

abstract suspend fun onLLMCallFailed(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, runId: String, prompt: Prompt, model: LLModel, tools: List<ToolDescriptor>, error: Throwable)

onLLMCallStarting

abstract suspend fun onLLMCallStarting(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, runId: String, prompt: Prompt, model: LLModel, tools: List<ToolDescriptor>)

onLLMStreamingCompleted

abstract suspend fun onLLMStreamingCompleted(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, runId: String, prompt: Prompt, model: LLModel, tools: List<ToolDescriptor>)

onLLMStreamingFailed

abstract suspend fun onLLMStreamingFailed(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, runId: String, prompt: Prompt, model: LLModel, error: Throwable)

onLLMStreamingFrameReceived

abstract suspend fun onLLMStreamingFrameReceived(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, runId: String, prompt: Prompt, model: LLModel, streamFrame: StreamFrame)

onLLMStreamingStarting

abstract suspend fun onLLMStreamingStarting(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, runId: String, prompt: Prompt, model: LLModel, tools: List<ToolDescriptor>)

onPlanCompletionEvaluationCompleted

abstract suspend fun onPlanCompletionEvaluationCompleted(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, state: Any, stateType: TypeToken?, plan: Any, planType: TypeToken?, stepIndex: Int, isCompleted: Boolean)

Notifies all registered planner handlers when evaluating whether a plan is completed.

onPlanCompletionEvaluationStarting

abstract suspend fun onPlanCompletionEvaluationStarting(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, state: Any, stateType: TypeToken?, plan: Any, planType: TypeToken?, stepIndex: Int)

Notifies all registered planner handlers when evaluating whether a plan is completed.

onPlanCreationCompleted

abstract suspend fun onPlanCreationCompleted(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, state: Any, stateType: TypeToken?, plan: Any?, planType: TypeToken?, stepIndex: Int, updatedPlan: Any)

Notifies all registered planner handlers that a plan creation has completed.

onPlanCreationStarting

abstract suspend fun onPlanCreationStarting(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, state: Any, stateType: TypeToken?, plan: Any?, planType: TypeToken?, stepIndex: Int)

Notifies all registered planner handlers that a plan creation has started.

onStepExecutionCompleted

abstract suspend fun onStepExecutionCompleted(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, state: Any, stateType: TypeToken?, plan: Any, planType: TypeToken?, stepIndex: Int)

Notifies all registered planner handlers that a plan step execution has completed.

onStepExecutionStarting

abstract suspend fun onStepExecutionStarting(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, state: Any, stateType: TypeToken?, plan: Any, planType: TypeToken?, stepIndex: Int)

Notifies all registered planner handlers that a plan step execution has started.

onStrategyCompleted

abstract suspend fun onStrategyCompleted(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, strategy: AIAgentStrategy<*, *, *>, result: Any?, resultType: TypeToken)

onStrategyStarting

abstract suspend fun onStrategyStarting(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, strategy: AIAgentStrategy<*, *, *>)

onToolCallCompleted

abstract suspend fun onToolCallCompleted(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, runId: String, toolCallId: String?, toolName: String, toolDescription: String?, toolArgs: JSONObject, toolResult: JSONElement?)

onToolCallFailed

abstract suspend fun onToolCallFailed(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, runId: String, toolCallId: String?, toolName: String, toolDescription: String?, toolArgs: JSONObject, message: String, error: Throwable?)

onToolCallStarting

abstract suspend fun onToolCallStarting(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, runId: String, toolCallId: String?, toolName: String, toolDescription: String?, toolArgs: JSONObject)

onToolValidationFailed

abstract suspend fun onToolValidationFailed(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, runId: String, toolCallId: String?, toolName: String, toolDescription: String?, toolArgs: JSONObject, message: String, error: Throwable)

prepareFeatures

abstract suspend fun prepareFeatures()

provideToolCallMetadata

abstract fun provideToolCallMetadata(feature: AIAgentFeature<*, *>, handle: suspend (eventContext: ToolCallStartingContext) -> Map<String, Any?>)

Registers a handler that contributes metadata for every tool call.

uninstall

abstract suspend fun uninstall(featureKey: AIAgentStorageKey<*>)