hashbrown

StructuredChatResourceOptions

Options for the structured chat resource.

API

interface StructuredChatResourceOptions<Schema extends s.SchemaOutput, Tools extends Chat.AnyTool, Output extends s.InferSchemaOutput<Schema> = s.InferSchemaOutput<Schema>>  {
apiUrl?: ReactiveOption<string>;
debounce?: number;
debugName?: string;
messages?: Chat.Message<Output, Tools>[];
model:  ReactiveOption < ModelInput >;
retries?: number;
schema: Schema;
structuredOutput?: Chat.Api.StructuredOutputOptions;
system:  ReactiveOption <string>;
threadId?: ReactiveOption<string | undefined>;
tools?: Tools[];
transport?: TransportOrFactory;
ui?: boolean;
}
StructuredChatResourceOptions
@typeSchema
s.SchemaOutput
@typeTools
Chat.AnyTool
@typeOutput
s.InferSchemaOutput<Schema>
apiUrl
ReactiveOption<string>

The API URL to use for the structured chat resource.

debounce
number

The debounce time for the structured chat resource.

debugName
string

The debug name for the structured chat resource.

messages
Chat.Message<Output, Tools>[]

The initial messages for the structured chat resource.

model
ReactiveOption<ModelInput>

The model to use for the structured chat resource.

retries
number

The number of retries for the structured chat resource.

schema
Schema

The schema to use for the structured chat 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 chat resource.

threadId
ReactiveOption<string | undefined>

Optional opaque AG-UI thread identity.

tools
Tools[]

The tools to use for the structured chat resource.

transport
TransportOrFactory

Custom transport override for the structured chat resource.

ui
boolean

Whether this structured chat is generating UI content.