@hashbrownai/react.UiCompletionOptions: Hashbrown API

Options for the useUiCompletion hook.

API

interface UiCompletionOptions<Input, Tools extends Chat.AnyTool = Chat.AnyTool, State = unknown>  {

components:  UiKitInput  <
   ExposedComponent  <
  any >> [];

debounceTime?: number;

debugName?: string;

examples?: SystemPrompt;

input: Input | null | undefined;

retries?: number;

state?: State;

system: string |  SystemPrompt;

threadId?: string | undefined;

tools?: Tools[];

transport?: TransportOrFactory;

@typeInput

@typeTools

Chat.AnyTool

@typeState

The components that can be rendered by the completion.

The debounce time between requests.

The name of the hook, useful for debugging.

Optional prompt-based UI examples to include in the wrapper schema description.

The input for the completion.

Number of retries if an error is received.

The initial shared agent state.

The system prompt to use for the completion.

Optional opaque AG-UI thread identity.

The tools to make available to the completion.

Optional transport override for this hook.