Options for the UI chat resource.
API
interface UiChatResourceOptions<Tools extends Chat.AnyTool, State = unknown> {apiUrl?: ReactiveOption<string>;components: UiKitInput <
ExposedComponent <
any >> [];debounce?: number;debugName?: string;examples?: SystemPrompt;messages?: Chat.Message<s.Infer<UiChatMessageOutput>, Tools>[];state?: State;system: ReactiveOption <
string | SystemPrompt
>;threadId?: ReactiveOption<string | undefined>;tools?: Tools[];transport?: TransportOrFactory;}UiChatResourceOptions
@typeToolsChat.AnyTool@typeStateapiUrl
ReactiveOption<string>The API URL to use for the UI chat resource.
components
UiKitInput<ExposedComponent<any>>[]The components to use for the UI chat resource.
debounce
numberThe debounce time for the UI chat resource.
debugName
stringThe debug name for the UI chat resource.
examples
SystemPromptOptional prompt-based UI examples to include in the wrapper schema description.
messages
Chat.Message<s.Infer<UiChatMessageOutput>, Tools>[]The initial messages for the UI chat resource.
state
StateThe initial shared agent state.
system
ReactiveOption<string | SystemPrompt>The system prompt to use for the UI chat resource.
threadId
ReactiveOption<string | undefined>Optional opaque AG-UI thread identity.
tools
Tools[]The tools to use for the UI chat resource.
transport
TransportOrFactoryCustom transport override for the UI chat resource.