Class BasePluginAbstract

constructor

• new BasePlugin(name): BasePlugin

• Parameters

  • name: string

  Returns BasePlugin

Readonlyname

OptionalonUserMessageCallback

• onUserMessageCallback(_params): Promise<Content>

• Parameters

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

    • invocationContext: InvocationContext

    • userMessage: Content

  Returns Promise<Content>

OptionalbeforeRunCallback

• beforeRunCallback(_params): Promise<Event>

• Parameters

  • _params: {
        invocationContext: InvocationContext;
    }

    • invocationContext: InvocationContext

  Returns Promise<Event>

OptionalonEventCallback

• onEventCallback(_params): Promise<Event>

• Parameters

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

    • invocationContext: InvocationContext

    • event: Event

  Returns Promise<Event>

OptionalafterRunCallback

• afterRunCallback(_params): Promise<void>

• Parameters

  • _params: {
        invocationContext: InvocationContext;
        result?: any;
    }

    • invocationContext: InvocationContext

    • Optionalresult?: any

  Returns Promise<void>

Optionalclose

• close(): Promise<void>

• Returns Promise<void>

OptionalbeforeAgentCallback

• beforeAgentCallback(_params): Promise<Content>

• Parameters

  • _params: {
        agent: BaseAgent;
        callbackContext: CallbackContext;
    }

    • agent: BaseAgent

    • callbackContext: CallbackContext

  Returns Promise<Content>

OptionalafterAgentCallback

• afterAgentCallback(_params): Promise<Content>

• Parameters

  • _params: {
        agent: BaseAgent;
        callbackContext: CallbackContext;
        result?: any;
    }

    • agent: BaseAgent

    • callbackContext: CallbackContext

    • Optionalresult?: any

  Returns Promise<Content>

OptionalbeforeModelCallback

• beforeModelCallback(_params): Promise<LlmResponse>

• Parameters

  • _params: {
        callbackContext: CallbackContext;
        llmRequest: LlmRequest;
    }

    • callbackContext: CallbackContext

    • llmRequest: LlmRequest

  Returns Promise<LlmResponse>

OptionalafterModelCallback

• afterModelCallback(_params): Promise<LlmResponse>

• Parameters

  • _params: {
        callbackContext: CallbackContext;
        llmResponse: LlmResponse;
        llmRequest?: LlmRequest;
    }

    • callbackContext: CallbackContext

    • llmResponse: LlmResponse

    • OptionalllmRequest?: LlmRequest

  Returns Promise<LlmResponse>

OptionalonModelErrorCallback

• onModelErrorCallback(_params): Promise<LlmResponse>

• Parameters

  • _params: {
        callbackContext: CallbackContext;
        llmRequest: LlmRequest;
        error: unknown;
    }

    • callbackContext: CallbackContext

    • llmRequest: LlmRequest

    • error: unknown

  Returns Promise<LlmResponse>

OptionalbeforeToolCallback

• 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>>

OptionalafterToolCallback

• 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>>

OptionalonToolErrorCallback

• 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>>