Function commitUserMessageForce

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

This function forcefully commits a user message to the history of the active agent in the specified swarm session, bypassing the check for whether the agent is still active. It performs validation on the 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 session or swarm) or if the session public service encounters an error during the commit operation.

Example

await commitUserMessageForce("User input message", "client-123");
  • commitUserMessageForce<Payload extends object = object>(
        content: string,
        mode: ExecutionMode,
        clientId: 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.

    • Optionalpayload: Payload

    Returns Promise<void>

    A promise that resolves when the message is successfully committed.

Settings

Member Visibility