hashbrown

UseStructuredChatOptions

Options for the useStructuredChat hook.

API

interface UseStructuredChatOptions<Schema extends s.HashbrownType, Tools extends Chat.AnyTool, Output extends s.Infer<Schema> = s.Infer<Schema>>  {
debounceTime?: number;
debugName?: string;
messages?: Chat.Message<Output, Tools>[];
model:  KnownModelIds ;
retries?: number;
schema: Schema;
system: string;
tools?: Tools[];
}
UseStructuredChatOptions
@typeSchema
s.HashbrownType
@typeTools
Chat.AnyTool
@typeOutput
s.Infer<Schema>
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<Output, Tools>[]

The initial messages for the chat. default: 1.0

model
KnownModelIds

The LLM model to use for the chat.

retries
number

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

schema
Schema

The schema to use for the chat.

system
string

The system message to use for the chat.

tools
Tools[]

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