@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

interface UseStructuredChatResult<Output, Tools extends Chat.AnyTool, State = unknown>  {

error:  Error  | undefined;

exhaustedRetries: boolean;

generatingError:  Error  | undefined;

isGenerating: boolean;

isLoading: boolean;

isReceiving: boolean;

readonly isResuming: boolean;

isRunningToolCalls: boolean;

isSending: boolean;

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

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

readonly pendingInterrupts: PendingInterruptBatch | undefined;

reload: () => void;

resendMessages: () => void;

resume(options: ResumeOptions): void;

sendingError:  Error  | undefined;

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

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

setState(state: State): void;

readonly state: State | undefined;

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

@typeOutput

@typeTools

Chat.AnyTool

@typeState

The error encountered during chat operations, if any.

Whether the current request has exhausted retries.

Error emitted during generation events.

Whether the chat is currently generating.

Aggregate loading flag across transport, generation, and tool calls.

Whether the chat is receiving a response.

Whether the resumed interaction is still running.

Whether the chat is running tool calls.

Whether the chat is sending a response.

The last assistant message.

An array of chat messages.

The complete pending interrupt batch, including while claimed.

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 events arrive.

Function to send a new chat message.

Function to update the chat messages.

The currently visible shared agent state.

Function to stop the chat.