Options for the UI completion resource.
API
interface UiCompletionResourceOptions<Input, Tools extends Chat.AnyTool = Chat.AnyTool, State = unknown> {apiUrl?: ReactiveOption<string>;components: UiKitInput <
ExposedComponent <
any >> [];debounce?: number;debugName?: string;examples?: SystemPrompt;input: Signal <Input | null | undefined>;retries?: number;state?: State;system: ReactiveOption <
string | SystemPrompt
>;threadId?: ReactiveOption<string | undefined>;tools?: Tools[];transport?: TransportOrFactory;}UiCompletionResourceOptions
@typeInput@typeToolsChat.AnyTool@typeStateapiUrl
ReactiveOption<string>The API URL to use for the UI completion resource.
components
UiKitInput<ExposedComponent<any>>[]The components to use for the UI completion resource.
debounce
numberThe debounce time for the UI completion resource.
debugName
stringThe debug name for the UI completion resource.
examples
SystemPromptOptional prompt-based UI examples to include in the wrapper schema description.
input
Signal<Input | null | undefined>The signal that produces the input for the completion.
retries
numberThe number of retries for the UI completion resource.
state
StateThe initial shared agent state.
system
ReactiveOption<string | SystemPrompt>The system prompt to use for the UI completion resource.
threadId
ReactiveOption<string | undefined>Optional opaque AG-UI thread identity.
tools
Tools[]The tools to use for the UI completion resource.
transport
TransportOrFactoryCustom transport override for the UI completion resource.