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