hashbrown

StructuredCompletionResourceRef

A reference to the structured completion resource.

API

interface StructuredCompletionResourceRef<Output> extends Resource<Output | null>  {
generatingError:  Signal <
   Error  | undefined
>;
isGenerating:  Signal <boolean>;
isLoading:  Signal <boolean>;
isReceiving:  Signal <boolean>;
isRunningToolCalls:  Signal <boolean>;
isSending:  Signal <boolean>;
reload: () => boolean;
sendingError:  Signal <
   Error  | undefined
>;
stop: (clearStreamingMessage?: boolean) => void;
}
StructuredCompletionResourceRef
@typeOutput
generatingError
Signal<Error | undefined>

Error emitted during generation frames.

isGenerating
Signal<boolean>

Indicates whether the completion is generating assistant output.

isLoading
Signal<boolean>

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

isReceiving
Signal<boolean>

Indicates whether the underlying completion call is currently receiving tokens.

isRunningToolCalls
Signal<boolean>

Indicates whether tool calls are running.

isSending
Signal<boolean>

Indicates whether the underlying completion call is currently sending a message.

reload
() => boolean

Reloads the resource.

sendingError
Signal<Error | undefined>

Transport/request error before generation frames arrive.

stop
(clearStreamingMessage?: boolean) => void

Stops any currently-streaming message.