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

AIAgentGraphPipeline

expect open class AIAgentGraphPipeline : AIAgentPipeline, AIAgentGraphPipelineAPI(source)

Represents a pipeline for AI agent graph execution, extending the functionality of AIAgentPipeline. This class manages the execution of specific nodes in the pipeline using registered handlers.

actual open class AIAgentGraphPipeline : AIAgentPipeline, AIAgentGraphPipelineAPI(source)

Represents a pipeline for AI agent graph execution, extending the functionality of AIAgentPipeline. This class manages the execution of specific nodes in the pipeline using registered handlers.

actual open class AIAgentGraphPipeline : AIAgentPipeline, AIAgentGraphPipelineAPI(source)

Represents a pipeline for AI agent graph execution, extending the functionality of AIAgentPipeline. This class manages the execution of specific nodes in the pipeline using registered handlers.

Constructors

AIAgentGraphPipeline

expect constructor(agentConfig: AIAgentConfig, clock: KoogClock = KoogClock.System, basePipelineDelegate: AIAgentPipelineImpl = AIAgentPipelineImpl(agentConfig, clock))

actual constructor(agentConfig: AIAgentConfig, clock: ERROR CLASS: Symbol not found for KoogClock, basePipelineDelegate: AIAgentPipelineImpl)

actual constructor(agentConfig: AIAgentConfig, clock: KoogClock, basePipelineDelegate: AIAgentPipelineImpl)

Properties

clock

expect open override val clock: KoogClock

Provides access to a Clock instance representing the current system time. The Clock can be used to retrieve the current time, create date-time instances, or perform operations based on a specific moment in time.

open override val clock: ai/koog/utils/time/KoogClock

open override val clock: KoogClock

config

expect open override val config: AIAgentConfig

Represents the configuration settings for the AI agent.

open override val config: AIAgentConfig

Functions

closeAllFeaturesMessageProcessors

expect open suspend override fun closeAllFeaturesMessageProcessors()

open suspend override fun closeAllFeaturesMessageProcessors()

collectToolCallMetadata

expect open suspend override 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.

open suspend override fun collectToolCallMetadata(eventId: String, executionInfo: AgentExecutionInfo, runId: String, toolCallId: String?, toolName: String, toolDescription: String?, toolArgs: ai/koog/serialization/JSONObject, context: AIAgentContext): ai/koog/agents/core/tools/ToolCallMetadata

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

open suspend override 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

expect open override fun <TFeature : Any> feature(featureClass: KClass<TFeature>, feature: AIAgentFeature<*, TFeature>): TFeature?

Retrieves a feature implementation from the current pipeline using the specified feature, if it is registered.

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

install

expect fun <TConfig : FeatureConfig, TFeatureImpl : Any> install(feature: AIAgentGraphFeature<TConfig, TFeatureImpl>, configure: TConfig.() -> Unit)

Installs a feature into the pipeline with the provided configuration.

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

Installs a feature into the AI agent storage using the provided feature key, configuration, and implementation.

actual fun <TConfig : FeatureConfig, TFeatureImpl : Any> install(feature: AIAgentGraphFeature<TConfig, TFeatureImpl>, configure: TConfig.() -> Unit)

Installs a feature into the pipeline with the provided configuration.

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

actual fun <TConfig : FeatureConfig, TFeatureImpl : Any> install(feature: AIAgentGraphFeature<TConfig, TFeatureImpl>, configure: TConfig.() -> Unit)

Installs a feature into the pipeline with the provided configuration.

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

interceptAgentClosing

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

Intercepts and sets a handler to be invoked before an agent is closed.

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

interceptAgentClosingBlocking

fun interceptAgentClosingBlocking(feature: AIAgentFeature<*, *>, handle: Interceptor<AgentClosingContext>)

Intercepts and sets a handler to be invoked before an agent is closed.

interceptAgentCompleted

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

Intercepts the completion of an agent's operation and assigns a custom handler to process the result.

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

interceptAgentCompletedBlocking

fun interceptAgentCompletedBlocking(feature: AIAgentFeature<*, *>, handle: Interceptor<AgentCompletedContext>)

Intercepts the completion of an agent's operation and assigns a custom handler to process the result.

interceptAgentExecutionFailed

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

Intercepts and handles errors occurring during the execution of an AI agent's strategy.

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

interceptAgentExecutionFailedBlocking

fun interceptAgentExecutionFailedBlocking(feature: AIAgentFeature<*, *>, handle: Interceptor<AgentExecutionFailedContext>)

Intercepts and handles errors occurring during the execution of an AI agent's strategy.

interceptAgentStarting

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

Intercepts on before an agent started to modify or enhance the agent.

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

interceptAgentStartingBlocking

fun interceptAgentStartingBlocking(feature: AIAgentFeature<*, *>, handle: Interceptor<AgentStartingContext>)

Intercepts on before an agent started to modify or enhance the agent.

interceptEnvironmentCreated

expect open override fun interceptEnvironmentCreated(feature: AIAgentFeature<*, *>, handle: suspend (AgentEnvironmentTransformingContext, AIAgentEnvironment) -> AIAgentEnvironment)

Intercepts environment creation to allow features to modify or enhance the agent environment.

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

interceptEnvironmentCreatedBlocking

fun interceptEnvironmentCreatedBlocking(feature: AIAgentFeature<*, *>, transform: TransformInterceptor<AgentEnvironmentTransformingContext, AIAgentEnvironment>)

Intercepts environment creation to allow features to modify or enhance the agent environment.

interceptLLMCallCompleted

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

Intercepts LLM calls after they are made to process or log the response.

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

interceptLLMCallCompletedBlocking

fun interceptLLMCallCompletedBlocking(feature: AIAgentFeature<*, *>, handle: Interceptor<LLMCallCompletedContext>)

Intercepts LLM calls after they are made to process or log the response.

interceptLLMCallFailed

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

Intercepts errors during LLM calls.

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

interceptLLMCallFailedBlocking

fun interceptLLMCallFailedBlocking(feature: AIAgentFeature<*, *>, handle: Interceptor<LLMCallFailedContext>)

Intercepts a failed call to the Language Learning Model (LLM) within a specific AI agent feature and delegates the handling of the failure context to the provided interceptor.

interceptLLMCallStarting

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

Intercepts LLM calls before they are made to modify or log the prompt.

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

interceptLLMCallStartingBlocking

fun interceptLLMCallStartingBlocking(feature: AIAgentFeature<*, *>, handle: Interceptor<LLMCallStartingContext>)

Intercepts LLM calls before they are made to modify or log the prompt.

interceptLLMStreamingCompleted

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

Intercepts streaming operations after they complete to perform post-processing or cleanup.

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

interceptLLMStreamingCompletedBlocking

fun interceptLLMStreamingCompletedBlocking(feature: AIAgentFeature<*, *>, handle: Interceptor<LLMStreamingCompletedContext>)

Intercepts streaming operations after they complete to perform post-processing or cleanup.

interceptLLMStreamingFailed

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

Intercepts errors during the streaming process.

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

interceptLLMStreamingFailedBlocking

fun interceptLLMStreamingFailedBlocking(feature: AIAgentFeature<*, *>, handle: Interceptor<LLMStreamingFailedContext>)

Intercepts errors during the streaming process.

interceptLLMStreamingFrameReceived

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

Intercepts stream frames as they are received during the streaming process.

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

interceptLLMStreamingFrameReceivedBlocking

fun interceptLLMStreamingFrameReceivedBlocking(feature: AIAgentFeature<*, *>, handle: Interceptor<LLMStreamingFrameReceivedContext>)

Intercepts stream frames as they are received during the streaming process.

interceptLLMStreamingStarting

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

Intercepts streaming operations before they begin to modify or log the streaming request.

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

interceptLLMStreamingStartingBlocking

fun interceptLLMStreamingStartingBlocking(feature: AIAgentFeature<*, *>, handle: Interceptor<LLMStreamingStartingContext>)

Intercepts streaming operations before they begin to modify or log the streaming request.

interceptNodeExecutionCompleted

expect open override fun interceptNodeExecutionCompleted(feature: AIAgentGraphFeature<*, *>, handle: suspend (eventContext: NodeExecutionCompletedContext) -> Unit)

Intercepts node execution after it completes.

open override fun interceptNodeExecutionCompleted(feature: AIAgentGraphFeature<*, *>, handle: suspend (eventContext: NodeExecutionCompletedContext) -> Unit)

interceptNodeExecutionCompletedBlocking

fun interceptNodeExecutionCompletedBlocking(feature: AIAgentGraphFeature<*, *>, handle: Interceptor<NodeExecutionCompletedContext>)

Intercepts node execution after it is successfully completed.

interceptNodeExecutionFailed

expect open override fun interceptNodeExecutionFailed(feature: AIAgentGraphFeature<*, *>, handle: suspend (eventContext: NodeExecutionFailedContext) -> Unit)

Intercepts and handles node execution errors for a given feature.

open override fun interceptNodeExecutionFailed(feature: AIAgentGraphFeature<*, *>, handle: suspend (eventContext: NodeExecutionFailedContext) -> Unit)

interceptNodeExecutionFailedBlocking

fun interceptNodeExecutionFailedBlocking(feature: AIAgentGraphFeature<*, *>, handle: Interceptor<NodeExecutionFailedContext>)

Intercepts node execution when it fails.

interceptNodeExecutionStarting

expect open override fun interceptNodeExecutionStarting(feature: AIAgentGraphFeature<*, *>, handle: suspend (eventContext: NodeExecutionStartingContext) -> Unit)

Intercepts node execution before it starts.

open override fun interceptNodeExecutionStarting(feature: AIAgentGraphFeature<*, *>, handle: suspend (eventContext: NodeExecutionStartingContext) -> Unit)

interceptNodeExecutionStartingBlocking

fun interceptNodeExecutionStartingBlocking(feature: AIAgentGraphFeature<*, *>, handle: Interceptor<NodeExecutionStartingContext>)

Intercepts node execution before it starts.

interceptStrategyCompleted

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

Sets up an interceptor to handle the completion of a strategy for the given feature.

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

interceptStrategyCompletedBlocking

fun interceptStrategyCompletedBlocking(feature: AIAgentFeature<*, *>, handle: Interceptor<StrategyCompletedContext>)

Sets up an interceptor to handle the completion of a strategy for the given feature.

interceptStrategyStarting

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

Intercepts the strategy starting event to perform actions when an agent strategy begins execution.

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

interceptStrategyStartingBlocking

fun interceptStrategyStartingBlocking(feature: AIAgentFeature<*, *>, handle: Interceptor<StrategyStartingContext>)

Intercepts starting strategy event to perform actions when an agent strategy begins execution.

interceptSubgraphExecutionCompleted

expect open override fun interceptSubgraphExecutionCompleted(feature: AIAgentGraphFeature<*, *>, handle: suspend (eventContext: SubgraphExecutionCompletedContext) -> Unit)

Intercepts the completion of a subgraph execution and allows handling of the event.

open override fun interceptSubgraphExecutionCompleted(feature: AIAgentGraphFeature<*, *>, handle: suspend (eventContext: SubgraphExecutionCompletedContext) -> Unit)

interceptSubgraphExecutionCompletedBlocking

fun interceptSubgraphExecutionCompletedBlocking(feature: AIAgentGraphFeature<*, *>, handle: Interceptor<SubgraphExecutionCompletedContext>)

Intercepts subgraph execution after it is successfully completed.

interceptSubgraphExecutionFailed

expect open override fun interceptSubgraphExecutionFailed(feature: AIAgentGraphFeature<*, *>, handle: suspend (eventContext: SubgraphExecutionFailedContext) -> Unit)

Intercepts and handles subgraph execution failures for a given feature.

open override fun interceptSubgraphExecutionFailed(feature: AIAgentGraphFeature<*, *>, handle: suspend (eventContext: SubgraphExecutionFailedContext) -> Unit)

interceptSubgraphExecutionFailedBlocking

fun interceptSubgraphExecutionFailedBlocking(feature: AIAgentGraphFeature<*, *>, handle: Interceptor<SubgraphExecutionFailedContext>)

Intercepts subgraph execution when it fails.

interceptSubgraphExecutionStarting

expect open override fun interceptSubgraphExecutionStarting(feature: AIAgentGraphFeature<*, *>, handle: suspend (eventContext: SubgraphExecutionStartingContext) -> Unit)

Intercepts the execution of a subgraph when it starts.

open override fun interceptSubgraphExecutionStarting(feature: AIAgentGraphFeature<*, *>, handle: suspend (eventContext: SubgraphExecutionStartingContext) -> Unit)

interceptSubgraphExecutionStartingBlocking

fun interceptSubgraphExecutionStartingBlocking(feature: AIAgentGraphFeature<*, *>, handle: Interceptor<SubgraphExecutionStartingContext>)

Intercepts subgraph execution before it starts.

interceptToolCallCompleted

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

Intercepts the result of a tool call with a custom handler for a specific feature.

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

interceptToolCallCompletedBlocking

fun interceptToolCallCompletedBlocking(feature: AIAgentFeature<*, *>, handle: Interceptor<ToolCallCompletedContext>)

Intercepts the result of a tool call with a custom handler for a specific feature.

interceptToolCallFailed

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

Sets up an interception mechanism to handle tool call failures for a specific feature.

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

interceptToolCallFailedBlocking

fun interceptToolCallFailedBlocking(feature: AIAgentFeature<*, *>, handle: Interceptor<ToolCallFailedContext>)

Sets up an interception mechanism to handle tool call failures for a specific feature.

interceptToolCallStarting

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

Intercepts and handles tool calls for the specified feature.

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

interceptToolCallStartingBlocking

fun interceptToolCallStartingBlocking(feature: AIAgentFeature<*, *>, handle: Interceptor<ToolCallStartingContext>)

Intercepts and handles tool calls for the specified feature.

interceptToolValidationFailed

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

Intercepts validation errors encountered during the execution of tools associated with the specified feature.

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

interceptToolValidationFailedBlocking

fun interceptToolValidationFailedBlocking(feature: AIAgentFeature<*, *>, handle: Interceptor<ToolValidationFailedContext>)

Intercepts validation errors encountered during the execution of tools associated with the specified feature.

onAgentClosing

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

Invoked before an agent is closed to perform necessary pre-closure operations.

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

onAgentCompleted

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

Notifies all registered handlers that an agent has finished execution.

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

onAgentEnvironmentTransforming

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

Transforms the agent environment by applying all registered environment transformers.

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

onAgentExecutionFailed

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

Notifies all registered handlers about an error that occurred during agent execution.

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

onAgentStarting

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

Notifies all registered handlers that an agent has started execution.

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

onLLMCallCompleted

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

Notifies all registered LLM handlers after a language model call has completed.

open suspend override fun onLLMCallCompleted(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, runId: String, prompt: ai/koog/prompt/Prompt, model: ai/koog/prompt/llm/LLModel, tools: List<ai/koog/agents/core/tools/ToolDescriptor>, response: ai/koog/prompt/message/Message.Assistant??, moderationResponse: ai/koog/prompt/dsl/ModerationResult?? = null)

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

onLLMCallFailed

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

Notifies all registered LLM handlers if a validation error occurs during a language model call.

open suspend override fun onLLMCallFailed(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, runId: String, prompt: ai/koog/prompt/Prompt, model: ai/koog/prompt/llm/LLModel, tools: List<ai/koog/agents/core/tools/ToolDescriptor>, error: Throwable)

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

onLLMCallStarting

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

Notifies all registered LLM handlers before a language model call is made.

open suspend override fun onLLMCallStarting(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, runId: String, prompt: ai/koog/prompt/Prompt, model: ai/koog/prompt/llm/LLModel, tools: List<ai/koog/agents/core/tools/ToolDescriptor>)

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

onLLMStreamingCompleted

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

Invoked after streaming from a language model completes.

open suspend override fun onLLMStreamingCompleted(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, runId: String, prompt: ai/koog/prompt/Prompt, model: ai/koog/prompt/llm/LLModel, tools: List<ai/koog/agents/core/tools/ToolDescriptor>)

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

onLLMStreamingFailed

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

Invoked if an error occurs during the streaming process.

open suspend override fun onLLMStreamingFailed(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, runId: String, prompt: ai/koog/prompt/Prompt, model: ai/koog/prompt/llm/LLModel, error: Throwable)

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

onLLMStreamingFrameReceived

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

Invoked when a stream frame is received during the streaming process.

open suspend override fun onLLMStreamingFrameReceived(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, runId: String, prompt: ai/koog/prompt/Prompt, model: ai/koog/prompt/llm/LLModel, streamFrame: ai/koog/prompt/streaming/StreamFrame)

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

onLLMStreamingStarting

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

Invoked before streaming from a language model begins.

open suspend override fun onLLMStreamingStarting(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, runId: String, prompt: ai/koog/prompt/Prompt, model: ai/koog/prompt/llm/LLModel, tools: List<ai/koog/agents/core/tools/ToolDescriptor>)

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

onNodeExecutionCompleted

expect open suspend override fun onNodeExecutionCompleted(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentGraphContextBase, node: AIAgentNodeBase<*, *>, input: Any?, inputType: TypeToken, output: Any?, outputType: TypeToken)

Notifies all registered node handlers after a node has been executed.

open suspend override fun onNodeExecutionCompleted(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentGraphContextBase, node: AIAgentNodeBase<*, *>, input: Any?, inputType: ai/koog/serialization/TypeToken, output: Any?, outputType: ai/koog/serialization/TypeToken)

onNodeExecutionFailed

expect open suspend override fun onNodeExecutionFailed(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentGraphContextBase, node: AIAgentNodeBase<*, *>, input: Any?, inputType: TypeToken, error: Throwable)

Handles errors occurring during the execution of a node by invoking all registered node execution error handlers.

open suspend override fun onNodeExecutionFailed(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentGraphContextBase, node: AIAgentNodeBase<*, *>, input: Any?, inputType: ai/koog/serialization/TypeToken, error: Throwable)

onNodeExecutionStarting

expect open suspend override fun onNodeExecutionStarting(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentGraphContextBase, node: AIAgentNodeBase<*, *>, input: Any?, inputType: TypeToken)

Notifies all registered node handlers before a node is executed.

open suspend override fun onNodeExecutionStarting(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentGraphContextBase, node: AIAgentNodeBase<*, *>, input: Any?, inputType: ai/koog/serialization/TypeToken)

open suspend override fun onNodeExecutionStarting(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentGraphContextBase, node: AIAgentNodeBase<*, *>, input: Any?, inputType: TypeToken)

onStrategyCompleted

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

Notifies all registered strategy handlers that a strategy has finished execution.

open suspend override fun onStrategyCompleted(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, strategy: AIAgentStrategy<*, *, *>, result: Any?, resultType: ai/koog/serialization/TypeToken)

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

onStrategyStarting

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

Notifies all registered strategy handlers that a strategy has started execution.

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

onSubgraphExecutionCompleted

expect open suspend override fun onSubgraphExecutionCompleted(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentGraphContextBase, subgraph: AIAgentSubgraphBase<*, *>, input: Any?, inputType: TypeToken, output: Any?, outputType: TypeToken)

Notifies all registered subgraph handlers after a subgraph has been executed.

open suspend override fun onSubgraphExecutionCompleted(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentGraphContextBase, subgraph: AIAgentSubgraphBase<*, *>, input: Any?, inputType: ai/koog/serialization/TypeToken, output: Any?, outputType: ai/koog/serialization/TypeToken)

onSubgraphExecutionFailed

expect open suspend override fun onSubgraphExecutionFailed(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentGraphContextBase, subgraph: AIAgentSubgraphBase<*, *>, input: Any?, inputType: TypeToken, error: Throwable)

Notifies all registered subgraph handlers when a subgraph execution fails.

open suspend override fun onSubgraphExecutionFailed(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentGraphContextBase, subgraph: AIAgentSubgraphBase<*, *>, input: Any?, inputType: ai/koog/serialization/TypeToken, error: Throwable)

onSubgraphExecutionStarting

expect open suspend override fun onSubgraphExecutionStarting(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentGraphContextBase, subgraph: AIAgentSubgraphBase<*, *>, input: Any?, inputType: TypeToken)

Notifies all registered subgraph handlers before a subgraph is executed.

open suspend override fun onSubgraphExecutionStarting(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentGraphContextBase, subgraph: AIAgentSubgraphBase<*, *>, input: Any?, inputType: ai/koog/serialization/TypeToken)

onToolCallCompleted

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

Notifies all registered tool handlers about the result of a tool call.

open suspend override fun onToolCallCompleted(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, runId: String, toolCallId: String?, toolName: String, toolDescription: String?, toolArgs: ai/koog/serialization/JSONObject, toolResult: ai/koog/serialization/JSONElement??)

onToolCallFailed

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

Notifies all registered tool handlers when a tool call fails with an exception.

open suspend override fun onToolCallFailed(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, runId: String, toolCallId: String?, toolName: String, toolDescription: String?, toolArgs: ai/koog/serialization/JSONObject, message: String, error: Throwable?)

onToolCallStarting

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

Notifies all registered tool handlers when a tool is called.

open suspend override fun onToolCallStarting(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, runId: String, toolCallId: String?, toolName: String, toolDescription: String?, toolArgs: ai/koog/serialization/JSONObject)

onToolValidationFailed

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

Notifies all registered tool handlers when a validation error occurs during a tool call.

open suspend override fun onToolValidationFailed(eventId: String, executionInfo: AgentExecutionInfo, context: AIAgentContext, runId: String, toolCallId: String?, toolName: String, toolDescription: String?, toolArgs: ai/koog/serialization/JSONObject, message: String, error: Throwable)

prepareFeatures

expect open suspend override fun prepareFeatures()

open suspend override fun prepareFeatures()

provideToolCallMetadata

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

Registers a handler that contributes per-call metadata before a tool executes.

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

Registers a handler that contributes metadata for every tool call.

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

Registers a handler that contributes metadata for every tool call.

uninstall

expect open suspend override fun uninstall(featureKey: AIAgentStorageKey<*>)

Uninstalls the specified feature associated with the given key from storage.

open suspend override fun uninstall(featureKey: AIAgentStorageKey<*>)