hashbrown

UseChatOptions

Options for the useChat hook.

API

interface UseChatOptions<Tools extends Chat.AnyTool>  {
debounceTime?: number;
debugName?: string;
messages?: Chat.Message<string, Tools>[];
model:  ModelInput; 
retries?: number;
system: string;
threadId?: string;
tools?: Tools[];
transport?: TransportOrFactory;
}
UseChatOptions
@typeTools
Chat.AnyTool
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

model
ModelInput

The LLM model to use for the chat.

retries
number

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

system
string

The system message to use for the chat.

threadId
string

Optional thread identifier used to load or continue an existing conversation.

tools
Tools[]

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

transport
TransportOrFactory

Optional transport override for this hook.