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

AIAgentGraphPipelineAPI

interface AIAgentGraphPipelineAPI : AIAgentPipelineAPI(source)

Public API surface for graph-specific pipeline operations (nodes and subgraphs).

Implemented by both the common expect AIAgentGraphPipeline and the concrete implementation AIAgentGraphPipelineImpl, and used by all platform actual classes via delegation.

Inheritors

AIAgentGraphPipeline

Properties

clock

abstract val clock: Clock

config

abstract val config: AIAgentConfig

Functions

closeAllFeaturesMessageProcessors

abstract suspend fun closeAllFeaturesMessageProcessors()

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)

interceptAfterLLMCall

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

interceptAgentBeforeClose

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

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)

interceptAgentFinished

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

interceptAgentRunError

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

interceptAgentStarting

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

interceptBeforeAgentStarted

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

interceptBeforeLLMCall

abstract fun interceptBeforeLLMCall(feature: AIAgentFeature<*, *>, handle: suspend (eventContext: LLMCallStartingContext) -> 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)

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)

interceptNodeExecutionCompleted

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

interceptNodeExecutionFailed

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

interceptNodeExecutionStarting

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

interceptStrategyCompleted

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

interceptStrategyFinished

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

interceptStrategyStart

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

interceptStrategyStarting

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

interceptSubgraphExecutionCompleted

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

interceptSubgraphExecutionFailed

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

interceptSubgraphExecutionStarting

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

interceptToolCall

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

interceptToolCallCompleted

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

interceptToolCallFailed

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

interceptToolCallFailure

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

interceptToolCallResult

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

interceptToolCallStarting

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

interceptToolValidationError

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

interceptToolValidationFailed

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

onAgentClosing

abstract suspend fun onAgentClosing(eventId: String, executionInfo: AgentExecutionInfo, agentId: String)

onAgentCompleted

abstract suspend fun onAgentCompleted(eventId: String, executionInfo: AgentExecutionInfo, agentId: String, runId: String, result: Any?, context: AIAgentContext)

onAgentEnvironmentTransforming

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

onAgentExecutionFailed

abstract suspend fun onAgentExecutionFailed(eventId: String, executionInfo: AgentExecutionInfo, agentId: String, runId: String, throwable: Throwable, context: AIAgentContext)

onAgentStarting

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

onLLMCallCompleted

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

onLLMCallStarting

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

onLLMStreamingCompleted

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

onLLMStreamingFailed

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

onLLMStreamingFrameReceived

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

onLLMStreamingStarting

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

onNodeExecutionCompleted

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

onNodeExecutionFailed

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

onNodeExecutionStarting

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

onStrategyCompleted

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

onStrategyStarting

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

onSubgraphExecutionCompleted

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

onSubgraphExecutionFailed

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

onSubgraphExecutionStarting

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

onToolCallCompleted

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

onToolCallFailed

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

onToolCallStarting

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

onToolValidationFailed

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

prepareFeatures

abstract suspend fun prepareFeatures()

uninstall

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