hashbrown

UseCompletionOptions

Options for the useCompletion hook.

API

interface UseCompletionOptions<Input, State = unknown>  {
debounceTime?: number;
debugName?: string;
input: Input | null | undefined;
retries?: number;
state?: State;
system: string;
threadId?: string | undefined;
tools?: Chat.AnyTool[];
transport?: TransportOrFactory;
}
UseCompletionOptions
@typeInput
@typeState
debounceTime
number

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

debugName
string

The name of the hook, useful for debugging.

input
Input | null | undefined

The input string to predict from.

retries
number

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

state
State

The initial shared agent state.

system
string

The system message to use for the completion.

threadId
string | undefined

Optional opaque AG-UI thread identity.

tools
Chat.AnyTool[]

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

transport
TransportOrFactory

Optional transport override for this hook.