Options for the structured chat resource.
API
interface StructuredChatResourceOptions<Schema extends s.HashbrownType, Tools extends Chat.AnyTool, Output extends s.Infer<Schema> = s.Infer<Schema>> {apiUrl?: string;debounce?: number;debugName?: string;messages?: Chat.Message<Output, Tools>[];model: KnownModelIds |
Signal < KnownModelIds >;retries?: number;schema: Schema;system: string | Signal <string>;tools?: Tools[];}StructuredChatResourceOptions
@typeSchemas.HashbrownType@typeToolsChat.AnyTool@typeOutputs.Infer<Schema>apiUrl
stringThe API URL to use for the structured chat resource.
debounce
numberThe debounce time for the structured chat resource.
debugName
stringThe debug name for the structured chat resource.
messages
Chat.Message<Output, Tools>[]The initial messages for the structured chat resource.
model
KnownModelIds | Signal<KnownModelIds>The model to use for the structured chat resource.
retries
numberThe number of retries for the structured chat resource.
schema
SchemaThe schema to use for the structured chat resource.
system
string | Signal<string>The system prompt to use for the structured chat resource.
tools
Tools[]The tools to use for the structured chat resource.