hashbrown

UiCompletionResourceOptions

Options for the UI completion resource.

API

interface UiCompletionResourceOptions<Input, Tools extends Chat.AnyTool = Chat.AnyTool>  {
apiUrl?: ReactiveOption<string>;
components:  UiKitInput  <
   ExposedComponent  <
  any >> [];
debounce?: number;
debugName?: string;
examples?: SystemPrompt;
input:  Signal <Input | null | undefined>;
model:  ReactiveOption < ModelInput >;
retries?: number;
structuredOutput?: Chat.Api.StructuredOutputOptions;
system:  ReactiveOption <
  string |  SystemPrompt 
>;
threadId?: ReactiveOption<string | undefined>;
tools?: Tools[];
transport?: TransportOrFactory;
}
UiCompletionResourceOptions
@typeInput
@typeTools
Chat.AnyTool
apiUrl
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
number

The debounce time for the UI completion resource.

debugName
string

The debug name for the UI completion resource.

examples
SystemPrompt

Optional 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.

model
ReactiveOption<ModelInput>

The model to use for the UI completion resource.

retries
number

The number of retries for the UI completion resource.

structuredOutput
Chat.Api.StructuredOutputOptions

Controls how the provider is asked to produce structured output.

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
TransportOrFactory

Custom transport override for the UI completion resource.