@hashbrownai/react.UiCompletionOptions: Hashbrown API

Options for the useUiCompletion hook.

API

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

debounceTime?: number;

debugName?: string;

examples?: SystemPrompt;

input: Input | null | undefined;

model:  ModelInput;

retries?: number;

structuredOutput?: Chat.Api.StructuredOutputOptions;

system: string |  SystemPrompt;

threadId?: string;

tools?: Tools[];

transport?: TransportOrFactory;

UiCompletionOptions
@typeInput
@typeToolsChat.AnyTool

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.

The model to use for the completion.

Number of retries if an error is received.

Controls how the provider is asked to produce structured output.

The system prompt to use for the completion.

Optional thread identifier used to load or continue an existing conversation.

The tools to make available to the completion.

Optional transport override for this hook.