hashbrown

StructuredCompletionResourceOptions

Options for the structured completion resource.

API

interface StructuredCompletionResourceOptions<Input, Schema extends s.SchemaOutput>  {
apiUrl?: ReactiveOption<string>;
debounce?: number;
debugName?: string;
input:  Signal <Input | null | undefined>;
model:  ReactiveOption < ModelInput >;
retries?: number;
schema: Schema;
structuredOutput?: Chat.Api.StructuredOutputOptions;
system:  ReactiveOption <string>;
threadId?: ReactiveOption<string | undefined>;
tools?: Chat.AnyTool[];
transport?: TransportOrFactory;
ui?: boolean;
}
StructuredCompletionResourceOptions
@typeInput
@typeSchema
s.SchemaOutput
apiUrl
ReactiveOption<string>

The API URL to use for the structured completion resource.

debounce
number

The debounce time for the structured completion resource.

debugName
string

The debug name for the structured completion resource.

input
Signal<Input | null | undefined>

The input to the structured completion resource.

model
ReactiveOption<ModelInput>

The model to use for the structured completion resource.

retries
number

The number of retries for the structured completion resource.

schema
Schema

The schema to use for the structured completion resource.

structuredOutput
Chat.Api.StructuredOutputOptions

Controls how the provider is asked to produce structured output.

system
ReactiveOption<string>

The system prompt to use for the structured completion resource.

threadId
ReactiveOption<string | undefined>

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

tools
Chat.AnyTool[]

The tools to use for the structured completion resource.

transport
TransportOrFactory

Optional transport override for this structured completion resource.

ui
boolean

Whether this completion is UI generating.