hashbrown

ChatResourceOptions

Configuration options for the chat resource.

API

interface ChatResourceOptions<Tools extends Chat.AnyTool>  {
apiUrl?: ReactiveOption<string>;
debounce?: number;
debugName?: string;
messages?: Chat.Message<string, Tools>[] | Signal<Chat.Message<string, Tools>[]>;
model:  ReactiveOption < ModelInput >;
system:  ReactiveOption <string>;
threadId?: ReactiveOption<string | undefined>;
tools?: Tools[];
transport?: TransportOrFactory;
}
ChatResourceOptions
@typeTools
Chat.AnyTool
apiUrl
ReactiveOption<string>

The API URL to use for the chat.

debounce
number

The debounce time for the chat.

debugName
string

The debug name for the chat.

messages
Chat.Message<string, Tools>[] | Signal<Chat.Message<string, Tools>[]>

The initial messages for the chat.

model
ReactiveOption<ModelInput>

The model to use for the chat.

system
ReactiveOption<string>

The system prompt to use for the chat.

threadId
ReactiveOption<string | undefined>

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

tools
Tools[]

The tools to use for the chat.

transport
TransportOrFactory

Custom transport to use for this chat resource.