hashbrown

UseCompletionResult

The result of the useCompletion hook.

API

error
Error | undefined

The error encountered during chat operations, if any.

exhaustedRetries
boolean

Whether the current request has exhausted retries.

generatingError
Error | undefined

Error emitted during generation frames.

isGenerating
boolean

Whether the chat is currently generating.

isLoading
boolean

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

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
string | null

The output from the model.

reload
() => void

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

sendingError
Error | undefined

Transport/request failure before generation frames arrive.