Options for the structured chat resource.
API
interface StructuredChatResourceOptions<Schema extends s.SchemaOutput, Tools extends Chat.AnyTool, Output extends s.InferSchemaOutput<Schema> = s.InferSchemaOutput<Schema>, State = unknown> {apiUrl?: ReactiveOption<string>;debounce?: number;debugName?: string;messages?: Chat.Message<Output, Tools>[];retries?: number;schema: Schema;state?: State;system: ReactiveOption <string>;threadId?: ReactiveOption<string | undefined>;tools?: Tools[];transport?: TransportOrFactory;ui?: boolean;}StructuredChatResourceOptions
@typeSchemas.SchemaOutput@typeToolsChat.AnyTool@typeOutputs.InferSchemaOutput<Schema>@typeStateapiUrl
ReactiveOption<string>The 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.
retries
numberThe number of retries for the structured chat resource.
schema
SchemaThe schema to use for the structured chat resource.
state
StateThe initial shared agent state.
system
ReactiveOption<string>The system prompt to use for the structured chat resource.
threadId
ReactiveOption<string | undefined>Optional opaque AG-UI thread identity.
tools
Tools[]The tools to use for the structured chat resource.
transport
TransportOrFactoryCustom transport override for the structured chat resource.
ui
booleanWhether this structured chat is generating UI content.