@hashbrownai/react.UseChatResult: Hashbrown API

The result object-type returned by the useChat hook that provides functions and state for interacting with the chat.

API

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
@typeToolsChat.AnyTool

The error encountered during chat operations, if any.

Whether the current request has exhausted retries.

Whether the chat is receiving a response.

Whether the chat is running tool calls.

Whether the chat is sending a response.

The last assistant message.

An array of chat messages.

Reload the chat, useful for retrying when an error occurs.

Function to send a new chat message.

Function to update the chat messages.

Function to stop the chat.