@hashbrownai/angular.StructuredCompletionResourceRef: Hashbrown API

A reference to the structured completion resource.

API

interface StructuredCompletionResourceRef<Output, State = unknown> extends Resource<Output | null>  {

generatingError:  Signal <
   Error  | undefined
>;

isGenerating:  Signal <boolean>;

isLoading:  Signal <boolean>;

isReceiving:  Signal <boolean>;

readonly isResuming: Signal<boolean>;

isRunningToolCalls:  Signal <boolean>;

isSending:  Signal <boolean>;

readonly pendingInterrupts: Signal<PendingInterruptBatch | undefined>;

reload: () => boolean;

resume(options: ResumeOptions): void;

sendingError:  Signal <
   Error  | undefined
>;

setState(state: State): void;

readonly state: Signal<State | undefined>;

stop: (clearStreamingMessage?: boolean) => void;

@typeOutput

@typeState

Error emitted during generation events.

Indicates whether the completion is generating assistant output.

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

Indicates whether the underlying completion call is currently receiving tokens.

Whether the whole resumed interaction is executing.

Indicates whether tool calls are running.

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

The current interrupt batch, retained until resume is acknowledged.

Reloads the resource.

Transport/request error before generation events arrive.

The currently visible shared agent state.

Stops any currently-streaming message.