@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

error:  Error  | undefined;

exhaustedRetries: boolean;

generatingError:  Error  | undefined;

isGenerating: boolean;

isLoading: boolean;

isLoadingThread: boolean;

isReceiving: boolean;

isRunningToolCalls: boolean;

isSavingThread: boolean;

isSending: boolean;

output: Output | null;

reload: () => void;

sendingError:  Error  | undefined;

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

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

UseStructuredCompletionResult
@typeOutput

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 output of the chat.

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

Transport/request failure before generation frames arrive.

Error encountered while loading a thread.

Error encountered while saving a thread.