The result object-type returned by the useStructuredChat hook that provides functions and state for interacting with the chat.
API
interface UseStructuredChatResult<Output, Tools extends Chat.AnyTool> {error: Error | undefined;exhaustedRetries: boolean;isReceiving: boolean;isRunningToolCalls: boolean;isSending: boolean;lastAssistantMessage: Chat.AssistantMessage <
Output,
Tools
> | undefined;messages: (Chat.Message < Output, Tools > []);reload: () => void;resendMessages: () => void;sendMessage: (message: Chat.Message<Output, Tools>) => void;setMessages: (messages: Chat.Message<Output, Tools>[]) => void;stop: (clearStreamingMessage?: boolean) => void;}UseStructuredChatResult
@typeOutput@typeToolsChat.AnyTool