Interface IChat

Public interface for interacting with a chat session.

interface IChat {
    fetchMessages(continuation?: boolean): Promise<void>;
    getMessages(): ChatMessage[];
    onChange(handler: ChatChangeHandler): ChatChangeUnsubscribe;
    sendMessage(content: string, request: SendMessageRequest): Promise<void>;
    sendObservation(request: SendMessageRequest): Promise<void>;
    sendRecursive(content: string, request: SendMessageRequest): Promise<void>;
    setTool(tool: ChatTool): () => void;
}

Index

Methods

fetchMessages getMessages onChange sendMessage sendObservation sendRecursive setTool

Methods

fetchMessages

fetchMessages(continuation?: boolean): Promise<void>
Fetch messages from the backend. Pass false or omit to reload from the beginning, true to load the next page of older messages.
Parameters
- Optionalcontinuation: boolean
Returns Promise<void>
- Defined in models/IChat.ts:32

getMessages

getMessages(): ChatMessage[]
Return the current list of messages.

Returns ChatMessage[]
- Defined in models/IChat.ts:35

onChange

onChange(handler: ChatChangeHandler): ChatChangeUnsubscribe
Subscribe to chat state changes. Returns an unsubscribe function. No-op on a by-ID chat — subscribe before calling sendMessage and read getMessages() after the returned Promise resolves instead.
Parameters
- handler: ChatChangeHandler
Returns ChatChangeUnsubscribe
- Defined in models/IChat.ts:42

sendMessage

sendMessage(content: string, request: SendMessageRequest): Promise<void>
Send a message and receive a reply.
Parameters
- content: string
- request: SendMessageRequest
Returns Promise<void>
- Defined in models/IChat.ts:20

sendObservation

sendObservation(request: SendMessageRequest): Promise<void>
Run the local tool for the last assistant action and send its observation. Throws if the last message does not contain an action.
Parameters
- request: SendMessageRequest
Returns Promise<void>
- Defined in models/IChat.ts:26

sendRecursive

sendRecursive(content: string, request: SendMessageRequest): Promise<void>
Send a message and automatically resolve tool actions until the response is complete.
Parameters
- content: string
- request: SendMessageRequest
Returns Promise<void>
- Defined in models/IChat.ts:48

setTool

setTool(tool: ChatTool): () => void
Register a tool for this chat. Returns a function that removes this registration.
Parameters
- tool: ChatTool
Returns () => void
- Defined in models/IChat.ts:17