@hashbrownai/react.UseStructuredChatOptions: Hashbrown API

Options for the useStructuredChat hook.

API

interface UseStructuredChatOptions<Schema extends s.SchemaOutput, Tools extends Chat.AnyTool, Output extends s.InferSchemaOutput<Schema> = s.InferSchemaOutput<Schema>, State = unknown>  {

debounceTime?: number;

debugName?: string;

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

retries?: number;

schema: Schema;

state?: State;

system: string;

threadId?: string | undefined;

tools?: Tools[];

transport?: TransportOrFactory;

ui?: boolean;

@typeSchema

s.SchemaOutput

@typeTools

Chat.AnyTool

@typeOutput

s.InferSchemaOutput<Schema>

@typeState

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

The name of the hook, useful for debugging.

The initial messages for the chat. default: 1.0

Number of retries if an error is received. default: 0

The schema to use for the chat.

The initial shared agent state.

The system message to use for the chat.

Optional opaque AG-UI thread identity.

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

Optional transport override for this hook.

Whether this structured chat is expected to produce UI elements.