Interface INavigateToAgentParams

Configuration parameters for creating a navigation handler to a specific agent. Defines optional messages or functions to handle flush, emission, execution, and tool output scenarios during navigation, incorporating the last user message where applicable.

INavigateToAgentParams

Example

// Static message configuration
const params: INavigateToAgentParams = {
  flushMessage: "Session reset.",
  toolOutput: "Navigation completed.",
};

Example

// Dynamic message configuration with last message
const params: INavigateToAgentParams = {
  executeMessage: (clientId, lastMessage, agent) => `Processing ${lastMessage} for ${clientId} on ${agent}`,
  emitMessage: (clientId, lastMessage, agent) => `Emitted ${lastMessage} for ${clientId} on ${agent}`,
};
interface INavigateToAgentParams {
    beforeNavigate?: (
        clientId: string,
        lastMessage: string,
        lastAgent: string,
        agentName: string,
    ) => void | Promise<void>;
    emitMessage?:
        | string
        | (
            clientId: string,
            lastMessage: string,
            lastAgent: string,
            agentName: string,
        ) => string | Promise<string>;
    executeMessage?:
        | string
        | (
            clientId: string,
            lastMessage: string,
            lastAgent: string,
            agentName: string,
        ) => string | Promise<string>;
    flushMessage?:
        | string
        | (clientId: string, defaultAgent: string) => string | Promise<string>;
    lastMessage?: (
        clientId: string,
        lastMessage: string,
        lastAgent: string,
        agentName: string,
    ) => string | Promise<string>;
    toolOutput?:
        | string
        | (
            clientId: string,
            lastAgent: string,
            agentName: string,
        ) => string | Promise<string>;
}

Properties

beforeNavigate? emitMessage? executeMessage? flushMessage? lastMessage? toolOutput?

Properties

OptionalbeforeNavigate

beforeNavigate?: (
    clientId: string,
    lastMessage: string,
    lastAgent: string,
    agentName: string,
) => void | Promise<void>

Optional callback function executed before navigation begins. Allows for custom pre-navigation logic and validation.

OptionalemitMessage

emitMessage?:
    | string
    | (
        clientId: string,
        lastMessage: string,
        lastAgent: string,
        agentName: string,
    ) => string | Promise<string>

Optional message or function to emit when navigation occurs without execution. If a function, it receives the client ID, last user message, and agent name, returning a string or promise of a string.

OptionalexecuteMessage

executeMessage?:
    | string
    | (
        clientId: string,
        lastMessage: string,
        lastAgent: string,
        agentName: string,
    ) => string | Promise<string>

Optional message or function to execute when navigation occurs with execution. If a function, it receives the client ID, last user message, and agent name, returning a string or promise of a string.

OptionalflushMessage

flushMessage?:
    | string
    | (clientId: string, defaultAgent: string) => string | Promise<string>

Optional message or function to emit after flushing the session. If a function, it receives the client ID and agent name, returning a string or promise of a string. Defaults to a generic retry message.

OptionallastMessage

lastMessage?: (
    clientId: string,
    lastMessage: string,
    lastAgent: string,
    agentName: string,
) => string | Promise<string>

Optional function to transform the last user message for navigation context. Allows customization of how the previous message is processed.

OptionaltoolOutput

toolOutput?:
    | string
    | (
        clientId: string,
        lastAgent: string,
        agentName: string,
    ) => string | Promise<string>

Optional message or function for tool output when navigation occurs. If a function, it receives the client ID and agent name, returning a string or promise of a string. Defaults to a message indicating successful navigation.

Settings

Member Visibility

On This Page

Properties