AIAssistantSettingsModel

16 Dec 20251 minute to read

Interface for a class AIAssistantSettings

Properties

bannerTemplate string|Function

Specifies the template for the banner in the AI Assistant component.
Represents the content or layout used to render the banner. Can be a string or a function.

commands AICommands[]

Defines the predefined AI command options displayed in the command dropdown menu.
Each command contains text, prompts, icons, and optional nested items.

headerToolbarSettings []

Configures the toolbar in the header section of the AI Assistant interface.
Allows customization of toolbar items, appearance, and behavior.

maxPromptHistory number

Defines the maximum number of prompts that can be stored in the editor’s
history stack.
Once the limit is reached, the oldest entries are removed as new ones
are added to maintain the maximum size.

placeholder string

Specifies the placeholder text shown in the AI prompt textarea.

popupMaxHeight string|number

Sets the max height of the AI Assistant popup.
Accepts CSS height values (e.g., ‘350px’, ‘500’) or numbers (treated as pixels).

popupWidth string|number

Sets the width of the AI Assistant popup.
Accepts CSS width values (e.g., ‘400px’, ‘500’) or numbers (treated as pixels).

promptToolbarSettings []

Configures the toolbar in the prompt editor (user input) section.
Allows customization of toolbar items, appearance, and behavior for the input area.

prompts PromptModel[]

Defines the collection of predefined prompts and their corresponding responses.
These prompts can be presented to the user as quick-access options.

responseToolbarSettings []

Configures the toolbar in the AI response viewer section.
Allows customization of toolbar items, appearance, and behavior for the response area.

suggestions string[]

Defines suggestion prompts displayed to the user as guidance.
These suggestions help users understand what kinds of queries they can make.