Class ToolOutputFilterPlugin

Hierarchy (view full)

BasePlugin
- ToolOutputFilterPlugin

Index

Constructors

Properties

Methods

onUserMessageCallback? beforeRunCallback? onEventCallback? afterRunCallback? beforeAgentCallback? afterAgentCallback? beforeModelCallback? afterModelCallback? onModelErrorCallback? beforeToolCallback? onToolErrorCallback? afterToolCallback close

Constructors

constructor

new ToolOutputFilterPlugin(options): ToolOutputFilterPlugin
Parameters
- options: ToolOutputFilterPluginOptions
Returns ToolOutputFilterPlugin
Overrides BasePlugin.constructor
- Defined in packages/adk/src/plugins/tool-filter-plugin.ts:55

Properties

`Readonly`name

name: string

Methods

`Optional`onUserMessageCallback

onUserMessageCallback(_params): Promise<Content>
Parameters
- _params: {
  invocationContext: InvocationContext;
  userMessage: Content;
  }
  - invocationContext: InvocationContext
  - userMessage: Content
Returns Promise<Content>
Inherited from BasePlugin.onUserMessageCallback
- Defined in packages/adk/src/plugins/base-plugin.ts:14

`Optional`beforeRunCallback

beforeRunCallback(_params): Promise<Event>
Parameters
- _params: {
  invocationContext: InvocationContext;
  }
  - invocationContext: InvocationContext
Returns Promise<Event>
Inherited from BasePlugin.beforeRunCallback
- Defined in packages/adk/src/plugins/base-plugin.ts:21

`Optional`onEventCallback

onEventCallback(_params): Promise<Event>
Parameters
- _params: {
  invocationContext: InvocationContext;
  event: Event;
  }
  - invocationContext: InvocationContext
  - event: Event
Returns Promise<Event>
Inherited from BasePlugin.onEventCallback
- Defined in packages/adk/src/plugins/base-plugin.ts:27

`Optional`afterRunCallback

afterRunCallback(_params): Promise<void>
Parameters
- _params: {
  invocationContext: InvocationContext;
  result?: any;
  }
  - invocationContext: InvocationContext
  - Optionalresult?: any
Returns Promise<void>
Inherited from BasePlugin.afterRunCallback
- Defined in packages/adk/src/plugins/base-plugin.ts:34

`Optional`beforeAgentCallback

beforeAgentCallback(_params): Promise<Content>
Parameters
- _params: {
  agent: BaseAgent;
  callbackContext: CallbackContext;
  }
  - agent: BaseAgent
  - callbackContext: CallbackContext
Returns Promise<Content>
Inherited from BasePlugin.beforeAgentCallback
- Defined in packages/adk/src/plugins/base-plugin.ts:45

`Optional`afterAgentCallback

afterAgentCallback(_params): Promise<Content>
Parameters
- _params: {
      agent: BaseAgent;
      callbackContext: CallbackContext;
      result?: any;
  }
  - agent: BaseAgent
  - callbackContext: CallbackContext
  - Optionalresult?: any
Returns Promise<Content>
Inherited from BasePlugin.afterAgentCallback
- Defined in packages/adk/src/plugins/base-plugin.ts:52

`Optional`beforeModelCallback

beforeModelCallback(_params): Promise<LlmResponse>
Parameters
- _params: {
  callbackContext: CallbackContext;
  llmRequest: LlmRequest;
  }
  - callbackContext: CallbackContext
  - llmRequest: LlmRequest
Returns Promise<LlmResponse>
Inherited from BasePlugin.beforeModelCallback
- Defined in packages/adk/src/plugins/base-plugin.ts:60

`Optional`afterModelCallback

afterModelCallback(_params): Promise<LlmResponse>
Parameters
- _params: {
      callbackContext: CallbackContext;
      llmResponse: LlmResponse;
      llmRequest?: LlmRequest;
  }
  - callbackContext: CallbackContext
  - llmResponse: LlmResponse
  - OptionalllmRequest?: LlmRequest
Returns Promise<LlmResponse>
Inherited from BasePlugin.afterModelCallback
- Defined in packages/adk/src/plugins/base-plugin.ts:67

`Optional`onModelErrorCallback

onModelErrorCallback(_params): Promise<LlmResponse>
Parameters
- _params: {
      callbackContext: CallbackContext;
      llmRequest: LlmRequest;
      error: unknown;
  }
  - callbackContext: CallbackContext
  - llmRequest: LlmRequest
  - error: unknown
Returns Promise<LlmResponse>
Inherited from BasePlugin.onModelErrorCallback
- Defined in packages/adk/src/plugins/base-plugin.ts:75

`Optional`beforeToolCallback

beforeToolCallback(_params): Promise<Record<string, any>>
Parameters
- _params: {
      tool: BaseTool;
      toolArgs: Record<string, any>;
      toolContext: ToolContext;
  }
  - tool: BaseTool
  - toolArgs: Record<string, any>
  - toolContext: ToolContext
Returns Promise<Record<string, any>>
Inherited from BasePlugin.beforeToolCallback
- Defined in packages/adk/src/plugins/base-plugin.ts:83

`Optional`onToolErrorCallback

onToolErrorCallback(_params): Promise<Record<string, any>>
Parameters
- _params: {
      tool: BaseTool;
      toolArgs: Record<string, any>;
      toolContext: ToolContext;
      error: unknown;
  }
  - tool: BaseTool
  - toolArgs: Record<string, any>
  - toolContext: ToolContext
  - error: unknown
Returns Promise<Record<string, any>>
Inherited from BasePlugin.onToolErrorCallback
- Defined in packages/adk/src/plugins/base-plugin.ts:100

afterToolCallback

afterToolCallback(params): Promise<Record<string, any>>
Parameters
- params: {
      tool: BaseTool;
      toolArgs: Record<string, any>;
      toolContext: ToolContext;
      result: Record<string, any>;
  }
  - tool: BaseTool
  - toolArgs: Record<string, any>
  - toolContext: ToolContext
  - result: Record<string, any>
Returns Promise<Record<string, any>>
Overrides BasePlugin.afterToolCallback
- Defined in packages/adk/src/plugins/tool-filter-plugin.ts:66

close

close(): Promise<void>
Returns Promise<void>
Overrides BasePlugin.close
- Defined in packages/adk/src/plugins/tool-filter-plugin.ts:645

Class ToolOutputFilterPlugin

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ToolOutputFilterPlugin

Properties

Readonlyname

Methods

OptionalonUserMessageCallback

Parameters

invocationContext: InvocationContext

userMessage: Content

Returns Promise<Content>

OptionalbeforeRunCallback

Parameters

invocationContext: InvocationContext

Returns Promise<Event>

OptionalonEventCallback

Parameters

invocationContext: InvocationContext

event: Event

Returns Promise<Event>

OptionalafterRunCallback

Parameters

invocationContext: InvocationContext

Optionalresult?: any

Returns Promise<void>

OptionalbeforeAgentCallback

Parameters

agent: BaseAgent

callbackContext: CallbackContext

Returns Promise<Content>

OptionalafterAgentCallback

Parameters

agent: BaseAgent

callbackContext: CallbackContext

Optionalresult?: any

Returns Promise<Content>

OptionalbeforeModelCallback

Parameters

callbackContext: CallbackContext

llmRequest: LlmRequest

Returns Promise<LlmResponse>

OptionalafterModelCallback

Parameters

callbackContext: CallbackContext

llmResponse: LlmResponse

OptionalllmRequest?: LlmRequest

Returns Promise<LlmResponse>

OptionalonModelErrorCallback

Parameters

callbackContext: CallbackContext

llmRequest: LlmRequest

error: unknown

Returns Promise<LlmResponse>

OptionalbeforeToolCallback

Parameters

tool: BaseTool

toolArgs: Record<string, any>

toolContext: ToolContext

Returns Promise<Record<string, any>>

OptionalonToolErrorCallback

Parameters

tool: BaseTool

toolArgs: Record<string, any>

toolContext: ToolContext

error: unknown

Returns Promise<Record<string, any>>

afterToolCallback

Parameters

tool: BaseTool

toolArgs: Record<string, any>

toolContext: ToolContext

result: Record<string, any>

Returns Promise<Record<string, any>>

`Readonly`name

`Optional`onUserMessageCallback

`Optional`beforeRunCallback

`Optional`onEventCallback

`Optional`afterRunCallback

`Optional`result?: any

`Optional`beforeAgentCallback

`Optional`afterAgentCallback

`Optional`result?: any

`Optional`beforeModelCallback

`Optional`afterModelCallback

`Optional`llmRequest?: LlmRequest

`Optional`onModelErrorCallback

`Optional`beforeToolCallback

`Optional`onToolErrorCallback