@hashbrownai/react.UiChatOptions: Hashbrown API

Options for the useUiChat hook.

API

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

debounceTime?: number;

debugName?: string;

examples?: SystemPrompt;

messages?: Chat.Message<UiChatSchema, Tools>[];

model:  ModelInput;

structuredOutput?: Chat.Api.StructuredOutputOptions;

system: string |  SystemPrompt;

threadId?: string;

tools?: Tools[];

transport?: TransportOrFactory;

UiChatOptions
@typeToolsChat.AnyTool

The components that can be rendered by the chat.

The debounce time between sends to the endpoint. default: 150

The name of the hook, useful for debugging.

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

The initial messages for the chat. default: []

The LLM model to use for the chat.

Controls how the provider is asked to produce structured output.

The system message to use for the chat.

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

The tools to make available for the chat. default: []

Optional transport override for this hook.