hashbrown

UseStructuredCompletionOptions

Options for the useStructuredCompletion hook.

API

interface UseStructuredCompletionOptions<Input, Schema extends s.HashbrownType>  {
debounceTime?: number;
debugName?: string;
input: Input | null | undefined;
model:  KnownModelIds ;
retries?: number;
schema: Schema;
system: string;
tools?: Chat.AnyTool[];
}
UseStructuredCompletionOptions
@typeInput
@typeSchema
s.HashbrownType
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
KnownModelIds

The LLM model to use for the chat.

retries
number

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

schema
Schema

The schema to use for the chat.

system
string

The system message to use for the chat.

tools
Chat.AnyTool[]

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