Class SecurityPlugin

Readonlyname

afterAgentCallback

• afterAgentCallback(
      params: { agent: BaseAgent; callbackContext: Context },
  ): Promise<Content | undefined>

  Callback executed after an agent's primary logic has completed.

  This callback can be used to inspect, log, or modify the agent's final result before it is returned.

  Parameters

  • params: { agent: BaseAgent; callbackContext: Context }

    • agent: BaseAgent

      The agent that has just run.

    • callbackContext: Context

      The context for the agent invocation.

  Returns Promise<Content | undefined>

  An optional Content object. If a value is returned, it will replace the agent's original result. Returning undefined uses the original, unmodified result.

afterModelCallback

• afterModelCallback(
      params: { callbackContext: Context; llmResponse: LlmResponse },
  ): Promise<LlmResponse | undefined>

  Callback executed after a response is received from the model.

  This is the ideal place to log model responses, collect metrics on token usage, or perform post-processing on the raw LlmResponse.

  Parameters

  • params: { callbackContext: Context; llmResponse: LlmResponse }

    • callbackContext: Context

      The context for the current agent call.

    • llmResponse: LlmResponse

      The response object received from the model.

  Returns Promise<LlmResponse | undefined>

  An optional value. A non-undefined return may be used by the framework to modify or replace the response. Returning undefined allows the original response to be used.

afterRunCallback

• afterRunCallback(
      params: { invocationContext: InvocationContext },
  ): Promise<void>

  Callback executed after an ADK runner run has completed.

  This is the final callback in the ADK lifecycle, suitable for cleanup, final logging, or reporting tasks.

  Parameters

  • params: { invocationContext: InvocationContext }

    • invocationContext: InvocationContext

      The context for the entire invocation.

  Returns Promise<void>

  undefined

afterToolCallback

• afterToolCallback(
      params: {
          result: Record<string, unknown>;
          tool: BaseTool;
          toolArgs: Record<string, unknown>;
          toolContext: Context;
      },
  ): Promise<Record<string, unknown> | undefined>

  Callback executed after a tool has been called.

  This callback allows for inspecting, logging, or modifying the result returned by a tool.

  Parameters

  • params: {
        result: Record<string, unknown>;
        tool: BaseTool;
        toolArgs: Record<string, unknown>;
        toolContext: Context;
    }

    • result: Record<string, unknown>

      The dictionary returned by the tool invocation.

    • tool: BaseTool

      The tool instance that has just been executed.

    • toolArgs: Record<string, unknown>

      The original arguments that were passed to the tool.

    • toolContext: Context

      The context specific to the tool execution.

  Returns Promise<Record<string, unknown> | undefined>

  An optional dictionary. If a dictionary is returned, it will replace the original result from the tool. This allows for post-processing or altering tool outputs. Returning undefined uses the original, unmodified result.

beforeAgentCallback

• beforeAgentCallback(
      params: { agent: BaseAgent; callbackContext: Context },
  ): Promise<Content | undefined>

  Callback executed before an agent's primary logic is invoked.

  This callback can be used for logging, setup, or to short-circuit the agent's execution by returning a value.

  Parameters

  • params: { agent: BaseAgent; callbackContext: Context }

    • agent: BaseAgent

      The agent that is about to run.

    • callbackContext: Context

      The context for the agent invocation.

  Returns Promise<Content | undefined>

  An optional Content object. If a value is returned, it will bypass the agent's callbacks and its execution, and return this value directly. Returning undefined allows the agent to proceed normally.

beforeModelCallback

• beforeModelCallback(
      params: { callbackContext: Context; llmRequest: LlmRequest },
  ): Promise<LlmResponse | undefined>

  Callback executed before a request is sent to the model.

  This provides an opportunity to inspect, log, or modify the LlmRequest object. It can also be used to implement caching by returning a cached LlmResponse, which would skip the actual model call.

  Parameters

  • params: { callbackContext: Context; llmRequest: LlmRequest }

    • callbackContext: Context

      The context for the current agent call.

    • llmRequest: LlmRequest

      The prepared request object to be sent to the model.

  Returns Promise<LlmResponse | undefined>

  An optional value. The interpretation of a non-undefined trigger an early exit and returns the response immediately. Returning undefined allows the LLM request to proceed normally.

beforeRunCallback

• beforeRunCallback(
      params: { invocationContext: InvocationContext },
  ): Promise<Content | undefined>

  Callback executed before the ADK runner runs.

  This is the first callback to be called in the lifecycle, ideal for global setup or initialization tasks.

  Parameters

  • params: { invocationContext: InvocationContext }

    • invocationContext: InvocationContext

      The context for the entire invocation, containing session information, the root agent, etc.

  Returns Promise<Content | undefined>

  An optional Event to be returned to the ADK. Returning a value to halt execution of the runner and ends the runner with that event. Return undefined to proceed normally.

onEventCallback

• onEventCallback(
      params: { event: Event; invocationContext: InvocationContext },
  ): Promise<Event | undefined>

  Callback executed after an event is yielded from runner.

  This is the ideal place to make modification to the event before the event is handled by the underlying agent app.

  Parameters

  • params: { event: Event; invocationContext: InvocationContext }

    • event: Event

      The event raised by the runner.

    • invocationContext: InvocationContext

      The context for the entire invocation.

  Returns Promise<Event | undefined>

  An optional value. A non-undefined return may be used by the framework to modify or replace the response. Returning undefined allows the original response to be used.

onModelErrorCallback

• onModelErrorCallback(
      params: {
          callbackContext: Context;
          error: Error;
          llmRequest: LlmRequest;
      },
  ): Promise<LlmResponse | undefined>

  Callback executed when a model call encounters an error.

  This callback provides an opportunity to handle model errors gracefully, potentially providing alternative responses or recovery mechanisms.

  Parameters

  • params: { callbackContext: Context; error: Error; llmRequest: LlmRequest }

    • callbackContext: Context

      The context for the current agent call.

    • error: Error

      The exception that was raised during model execution.

    • llmRequest: LlmRequest

      The request that was sent to the model when the error occurred.

  Returns Promise<LlmResponse | undefined>

  An optional LlmResponse. If an LlmResponse is returned, it will be used instead of propagating the error. Returning undefined allows the original error to be raised.

onToolErrorCallback

• onToolErrorCallback(
      params: {
          error: Error;
          tool: BaseTool;
          toolArgs: Record<string, unknown>;
          toolContext: Context;
      },
  ): Promise<Record<string, unknown> | undefined>

  Callback executed when a tool call encounters an error. tool: BaseTool; toolArgs: Record<string, unknown>; toolContext: Context; result: Record<string, unknown>; }): Promise<Record<string, unknown> | undefined> { return; }

  /** Callback executed when a tool call encounters an error.

  This callback provides an opportunity to handle tool errors gracefully, potentially providing alternative responses or recovery mechanisms.

  Parameters

  • params: {
        error: Error;
        tool: BaseTool;
        toolArgs: Record<string, unknown>;
        toolContext: Context;
    }

    • error: Error

      The exception that was raised during tool execution.

    • tool: BaseTool

      The tool instance that encountered an error.

    • toolArgs: Record<string, unknown>

      The arguments that were passed to the tool.

    • toolContext: Context

      The context specific to the tool execution.

  Returns Promise<Record<string, unknown> | undefined>

  An optional dictionary. If a dictionary is returned, it will be used as the tool response instead of propagating the error. Returning undefined allows the original error to be raised.

onUserMessageCallback

• onUserMessageCallback(
      params: { invocationContext: InvocationContext; userMessage: Content },
  ): Promise<Content | undefined>

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

  This callback helps logging and modifying the user message before the runner starts the invocation.

  Parameters

  • params: { invocationContext: InvocationContext; userMessage: Content }

    • invocationContext: InvocationContext

      The context for the entire invocation.

    • userMessage: Content

      The message content input by user.

  Returns Promise<Content | undefined>

  An optional Content to be returned to the ADK. Returning a value to replace the user message. Returning undefined to proceed normally.