hashbrown

UseChatOptions

Options for the useChat hook.

API

interface UseChatOptions<Tools extends Chat.AnyTool, State = unknown>  {
debounceTime?: number;
debugName?: string;
messages?: Chat.Message<string, Tools>[];
retries?: number;
state?: State;
system: string;
threadId?: string | undefined;
tools?: Tools[];
transport?: TransportOrFactory;
}
UseChatOptions
@typeTools
Chat.AnyTool
@typeState
debounceTime
number

The debounce time between sends to the endpoint. default: 150

debugName
string

The name of the hook, useful for debugging.

messages
Chat.Message<string, Tools>[]

The initial messages for the chat. default: 1.0

retries
number

Number of retries if an error is received. default: 0

state
State

The initial shared agent state.

system
string

The system message to use for the chat.

threadId
string | undefined

Optional opaque AG-UI thread identity.

tools
Tools[]

The tools to make available use for the chat. default: []

transport
TransportOrFactory

Optional transport override for this hook.