@hashbrownai/react.UseStructuredChatResult: Hashbrown API

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

API

error:  Error  | undefined;

exhaustedRetries: boolean;

generatingError:  Error  | undefined;

isGenerating: boolean;

isLoading: boolean;

isLoadingThread: boolean;

isReceiving: boolean;

isRunningToolCalls: boolean;

isSavingThread: boolean;

isSending: boolean;

lastAssistantMessage:  Chat.AssistantMessage <
  Output,
  Tools
> | undefined;

messages:  (Chat.Message  < Output, Tools > []);

reload: () => void;

resendMessages: () => void;

sendingError:  Error  | undefined;

sendMessage: (message: Chat.Message<Output, Tools>) => void;

setMessages: (messages: Chat.Message<Output, Tools>[]) => void;

stop: (clearStreamingMessage?: boolean) => void;

threadLoadError: {
        error: string;
        stacktrace?: string;
    } | undefined;

threadSaveError: {
        error: string;
        stacktrace?: string;
    } | undefined;

UseStructuredChatResult
@typeOutput
@typeToolsChat.AnyTool

The error encountered during chat operations, if any.

Whether the current request has exhausted retries.

Error emitted during generation frames.

Whether the chat is currently generating.

Aggregate loading flag across transport, generation, tool-calls, and thread load/save.

Whether a thread load request is in flight.

Whether the chat is receiving a response.

Whether the chat is running tool calls.

Whether a thread save request is in flight.

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 cause current messages to be resent. Can be used after an error in chat.

Transport/request failure before generation frames arrive.

Function to send a new chat message.

Function to update the chat messages.

Function to stop the chat.

Error encountered while loading a thread.

Error encountered while saving a thread.