hashbrown

UseCompletionOptions

Options for the useCompletion hook.

API

interface UseCompletionOptions<Input>  {
debounceTime?: number;
debugName?: string;
input: Input | null | undefined;
model:  ModelInput; 
retries?: number;
system: string;
threadId?: string;
tools?: Chat.AnyTool[];
transport?: TransportOrFactory;
}
UseCompletionOptions
@typeInput
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.

model
ModelInput

The LLM model to use for the chat.

retries
number

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

system
string

The system message to use for the completion.

threadId
string

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

tools
Chat.AnyTool[]

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

transport
TransportOrFactory

Optional transport override for this hook.