hashbrown

UseStructuredCompletionResult

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

API

interface UseStructuredCompletionResult<Output>  {
error:  Error  | undefined;
exhaustedRetries: boolean;
isReceiving: boolean;
isRunningToolCalls: boolean;
isSending: boolean;
output: Output | null;
reload: () => void;
}
UseStructuredCompletionResult
@typeOutput
error
Error | undefined

The error encountered during chat operations, if any.

exhaustedRetries
boolean

Whether the current request has exhausted retries.

isReceiving
boolean

Whether the chat is receiving a response.

isRunningToolCalls
boolean

Whether the chat is running tool calls.

isSending
boolean

Whether the chat is sending a response.

output
Output | null

The output of the chat.

reload
() => void

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