@hashbrownai/angular.UiCompletionResourceRef: Hashbrown API

A reference to the UI completion resource.

API

interface UiCompletionResourceRef<Tools extends Chat.AnyTool, State = unknown> extends Resource<UiAssistantMessage<Tools> | null>  {

isReceiving:  Signal <boolean>;

readonly isResuming: Signal<boolean>;

isSending:  Signal <boolean>;

readonly pendingInterrupts: Signal<PendingInterruptBatch | undefined>;

reload: () => boolean;

resume(options: ResumeOptions): void;

setState(state: State): void;

readonly state: Signal<State | undefined>;

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

@typeTools

Chat.AnyTool

@typeState

Indicates whether the underlying completion call is currently receiving data.

Whether the whole resumed interaction is executing.

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

The current interrupt batch, retained until resume is acknowledged.

Reloads the completion.

The currently visible shared agent state.

Stops any currently streaming response.