Options for the structured completion resource.
API
interface StructuredCompletionResourceOptions<Input, Schema extends s.SchemaOutput, State = unknown> {apiUrl?: ReactiveOption<string>;debounce?: number;debugName?: string;input: Signal <Input | null | undefined>;retries?: number;schema: Schema;state?: State;system: ReactiveOption <string>;threadId?: ReactiveOption<string | undefined>;tools?: Chat.AnyTool[];transport?: TransportOrFactory;ui?: boolean;}StructuredCompletionResourceOptions
@typeInput@typeSchemas.SchemaOutput@typeStateapiUrl
ReactiveOption<string>The API URL to use for the structured completion resource.
debounce
numberThe debounce time for the structured completion resource.
debugName
stringThe debug name for the structured completion resource.
input
Signal<Input | null | undefined>The input to the structured completion resource.
retries
numberThe number of retries for the structured completion resource.
schema
SchemaThe schema to use for the structured completion resource.
state
StateThe initial shared agent state.
system
ReactiveOption<string>The system prompt to use for the structured completion resource.
threadId
ReactiveOption<string | undefined>Optional opaque AG-UI thread identity.
tools
Chat.AnyTool[]The tools to use for the structured completion resource.
transport
TransportOrFactoryOptional transport override for this structured completion resource.
ui
booleanWhether this completion is UI generating.