@hashbrownai/core.ChatRuntime: Hashbrown API

A stateful client runtime for sending messages, processing AG-UI events, executing tools, and exposing reactive chat state.

API

error:  StateSignal <
   Error  | undefined
>;

exhaustedRetries:  StateSignal <boolean>;

generatingError:  StateSignal <
   Error  | undefined
>;

isGenerating:  StateSignal <boolean>;

isLoading:  StateSignal <boolean>;

isReceiving:  StateSignal <boolean>;

readonly isResuming: StateSignal<boolean>;

isRunningToolCalls:  StateSignal <boolean>;

isSending:  StateSignal <boolean>;

lastAssistantMessage:  StateSignal <
   Chat.AssistantMessage <Output, Tools> | undefined
>;

messages:  StateSignal <
   Chat.Message <Output, Tools>[]
>;

readonly pendingInterrupts: StateSignal<PendingInterruptBatch | undefined>;

resendMessages: () => void;

resume(options: ResumeOptions): void;

sendingError:  StateSignal <
   Error  | undefined
>;

sendMessage: (message: Chat.Message<Output, Tools>) => void;

setMessages: (messages: Chat.Message<Output, Tools>[]) => void;

setState(state: State): void;

start: () => () => void;

readonly state: StateSignal<State | undefined>;

stop: (clearStreamingMessage?: boolean) => void;

threadId:  StateSignal <string | undefined>;

updateOptions: (options: Partial<{
        debugName?: string;
        system: string;
        tools: Tools[];
        responseSchema: s.SchemaOutput;
        debounce: number;
        retries: number;
        transport: TransportOrFactory;
        ui?: boolean;
        threadId?: string | undefined;
    }>) => void;

ChatRuntime
@typeOutput
@typeToolsChat.AnyTool
@typeState

Whether the whole resumed interaction is still executing.

lastAssistantMessageStateSignal<Chat.AssistantMessage<Output, Tools> | undefined>

The current batch, retained until the server acknowledges resume.

Resend messages and update state. Often used manually after an error.

Send a new message to the LLM and update state.

Replace the current set of messages in the chat state.

Start the runtime effect loop and return a function that disposes it.

The currently visible shared agent state.

Stop the current LLM interaction.

The opaque AG-UI thread identity used by the current and subsequent runs.

updateOptions

(options: Partial<{
        debugName?: string;
        system: string;
        tools: Tools[];
        responseSchema: s.SchemaOutput;
        debounce: number;
        retries: number;
        transport: TransportOrFactory;
        ui?: boolean;
        threadId?: string | undefined;
    }>) => void

Update the chat options after initialization