@hashbrownai/react.UseStructuredCompletionResult: Hashbrown API

The result object-type returned by the useStructuredCompletion hook that provides the structured output and state for the completion.

API

interface UseStructuredCompletionResult<Output, State = unknown>  {

error:  Error  | undefined;

exhaustedRetries: boolean;

generatingError:  Error  | undefined;

isGenerating: boolean;

isLoading: boolean;

isReceiving: boolean;

readonly isResuming: boolean;

isRunningToolCalls: boolean;

isSending: boolean;

output: Output | null;

readonly pendingInterrupts: PendingInterruptBatch | undefined;

reload: () => void;

resume(options: ResumeOptions): void;

sendingError:  Error  | undefined;

setState(state: State): void;

readonly state: State | undefined;

stop(clearStreamingMessage?: boolean): void;

@typeOutput

@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 whole resumed interaction is executing.

Whether the chat is running tool calls.

Whether the chat is sending a response.

The output of the chat.

The current interrupt batch, retained until resume is acknowledged.

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

Transport/request failure before generation events arrive.

The currently visible shared agent state.