Function commitUserMessage

Commits a user message to the active agent's history in a swarm session without triggering a response.

This function commits a user message to the history of the specified agent, ensuring the agent is still active in the swarm session. It performs validation checks on the agent, session, and swarm, logs the operation if enabled, and delegates the commit operation to the session public service. The execution is wrapped in beginContext to ensure it runs outside of existing method and execution contexts, providing a clean execution environment.

Throws

If validation fails (e.g., invalid agent, session, or swarm) or if the session public service encounters an error during the commit operation.

Example

await commitUserMessage("User input message", "client-123", "AgentX");
  • commitUserMessage<Payload extends object = object>(
        content: string,
        mode: ExecutionMode,
        clientId: string,
        agentName: string,
        payload?: Payload,
    ): Promise<void>

    Type Parameters

    • Payload extends object = object

    Parameters

    • content: string

      The content of the user message to be committed.

    • mode: ExecutionMode
    • clientId: string

      The unique identifier of the client session associated with the operation.

    • agentName: string

      The name of the agent to whose history the message will be committed.

    • Optionalpayload: Payload

    Returns Promise<void>

    A promise that resolves when the message is successfully committed, or immediately if the operation is skipped due to an agent change.

Settings

Member Visibility