Interface ICommitActionParams<T>

Configuration parameters for creating a commit action handler (WRITE pattern). Defines validation, action execution, and response messages for state-modifying operations.

Param: error

The error object thrown during execution

Param: clientId

The client identifier

Param: agentName

The name of the current agent

  • Called when executeAction throws an exception
  • Error message is automatically committed as tool output and failureMessage is executed

Param: dto

Validation context object

Param: dto.clientId

The client identifier

Param: dto.agentName

The name of the current agent

Param: dto.toolCalls

Array of tool calls in current execution

Param: dto.params

Tool call parameters

Returns

Error message if validation fails, null if valid

Param: params

Tool call parameters (validated if validateParams was provided)

Param: clientId

The client identifier

Param: agentName

The name of the current agent

Returns

Result string to commit as tool output (empty string if action produced no result)

Param: params

Tool call parameters

Param: clientId

The client identifier

Param: agentName

The name of the current agent

Returns

Message to commit as tool output

Default

"Action executed but produced no result"

Example

// Payment action with validation and error handling
const paymentAction = createCommitAction({
  fallback: (error, clientId, agentName) => {
    console.error(`Payment action failed for ${clientId} (${agentName}):`, error);
  },
  validateParams: async ({ params, clientId, agentName, toolCalls }) => {
    if (!params.bank_name) return "Bank name is required";
    if (!params.amount) return "Amount is required";
    return null; // Valid
  },
  executeAction: async (params, clientId) => {
    await commitAppAction(clientId, "credit-payment", params);
    return "Payment page opened successfully";
  },
  successMessage: "what is this page about",
  failureMessage: "Could not open payment page",
});
interface ICommitActionParams<T = Record<string, any>> {
    emptyContent?: (
        params: T,
        clientId: string,
        agentName: string,
    ) => string | Promise<string>;
    executeAction: (
        params: T,
        clientId: string,
        agentName: string,
    ) => string | Promise<string>;
    failureMessage?:
        | string
        | (
            params: T,
            clientId: string,
            agentName: string,
        ) => string | Promise<string>;
    fallback?: (error: Error, clientId: string, agentName: string) => void;
    successMessage:
        | string
        | (
            params: T,
            clientId: string,
            agentName: string,
        ) => string | Promise<string>;
    validateParams?: (
        dto: {
            agentName: string;
            clientId: string;
            params: T;
            toolCalls: IToolCall[];
        },
    ) => string
    | Promise<string>;
}

Type Parameters

  • T = Record<string, any>

    The type of parameters expected by the action ICommitActionParams

Properties

emptyContent? executeAction failureMessage? fallback? successMessage validateParams?

Properties

OptionalemptyContent

emptyContent?: (
    params: T,
    clientId: string,
    agentName: string,
) => string | Promise<string>

Optional function to handle when executeAction returns empty result

executeAction

executeAction: (
    params: T,
    clientId: string,
    agentName: string,
) => string | Promise<string>

Function to execute the actual action (e.g., commitAppAction)

OptionalfailureMessage

failureMessage?:
    | string
    | (
        params: T,
        clientId: string,
        agentName: string,
    ) => string | Promise<string>

Optional message to execute using executeForce when validation fails

  • Can be static string or function that returns string
  • If function: receives (params, clientId, agentName) as arguments
  • If not provided: uses the validation error message instead

Optionalfallback

fallback?: (error: Error, clientId: string, agentName: string) => void

Optional error handler for executeAction failures

successMessage

successMessage:
    | string
    | (
        params: T,
        clientId: string,
        agentName: string,
    ) => string | Promise<string>

Message to execute using executeForce after successful action

  • Can be static string or function that returns string
  • If function: receives (params, clientId, agentName) as arguments

OptionalvalidateParams

validateParams?: (
    dto: {
        agentName: string;
        clientId: string;
        params: T;
        toolCalls: IToolCall[];
    },
) => string
| Promise<string>

Optional function to validate action parameters

Settings

Member Visibility

On This Page

The error object thrown during executionThe client identifierValidation context objectThe client identifierThe name of the current agentArray of tool calls in current executionTool call parametersTool call parameters (validated if validateParams was provided)The client identifierThe name of the current agentTool call parametersThe client identifierThe name of the current agentMessage to commit as tool output
Properties