google-adk-kotlin-core/com.google.adk.kt.plugins/Plugin

Plugin

interface Plugin

Interface for creating plugins.

Plugins provide a structured way to intercept and modify agent, tool, and LLM behaviors at critical execution points in a callback manner.

Inheritors

LoggingPlugin

Properties

name

abstract val name: String

The unique name of the plugin.

Functions

afterAgent

open suspend fun afterAgent(context: CallbackContext): CallbackChoice<Unit, Content>

Callback executed after a specific agent finishes its processing.

afterModel

open suspend fun afterModel(context: CallbackContext, response: LlmResponse): LlmResponse

Callback executed after an LLM response is received.

afterRun

open suspend fun afterRun(invocationContext: InvocationContext)

Callback executed after the ADK runner completes its execution.

afterTool

open suspend fun afterTool(context: ToolContext, tool: BaseTool, args: Map<String, Any>, result: Map<String, Any>): Map<String, Any>

Callback executed after a tool finishes its execution.

beforeAgent

open suspend fun beforeAgent(context: CallbackContext): CallbackChoice<EventActions, Content>

Callback executed before a specific agent starts processing.

beforeModel

open suspend fun beforeModel(context: CallbackContext, request: LlmRequest): CallbackChoice<LlmRequest, LlmResponse>

Callback executed before an LLM request is sent.

beforeRun

open suspend fun beforeRun(invocationContext: InvocationContext): CallbackChoice<Unit, Content>

Callback executed before the ADK runner starts the main execution loop.

beforeTool

open suspend fun beforeTool(context: ToolContext, tool: BaseTool, args: Map<String, Any>): CallbackChoice<Map<String, Any>, Map<String, Any>>

Callback executed before a tool is invoked.

open suspend fun close()

Method executed when the runner is closed.

onEvent

open suspend fun onEvent(invocationContext: InvocationContext, event: Event): Event

Callback executed when an event is yielded by an agent during execution.

onModelError

open suspend fun onModelError(context: CallbackContext, request: LlmRequest, error: Throwable): CallbackChoice<Unit, LlmResponse>

Callback executed when an error occurs during an LLM interaction.

onToolError

open suspend fun onToolError(context: ToolContext, tool: BaseTool, args: Map<String, Any>, error: Throwable): CallbackChoice<Unit, Map<String, Any>>

Callback executed when an error occurs during a tool invocation.

onUserMessage

open suspend fun onUserMessage(invocationContext: InvocationContext, userMessage: Content): Content

Callback executed when a user message is received before an invocation starts.