Skip to main content

ChatCustomizations

Properties​

autocompletePosition?​

optional autocompletePosition?: "above" | "below";

Controls where the autocomplete dropdown appears relative to the chat input box. Only applies when features.autocomplete is enabled.

  • 'above' - Autocomplete results appear above the input box.
  • 'below' - Autocomplete results appear below the input box.

Default is 'above'.

container?​

optional container?: BoxCustomizations;

Customizations for the widget box.

features?​

optional features?: object;

Options to control which chat features or UI elements are displayed in the widget.

agentLibrary?​

optional agentLibrary?: boolean;

The entry point to the agents library. Default is true.

agentMetadata?​

optional agentMetadata?: boolean;

The element that shows metadata about an embedded agent. Default is true.

applicationLibrary?​

optional applicationLibrary?: boolean;

The entry point to the AI apps library. Default is true.

autocomplete?​

optional autocomplete?: boolean;

Autocomplete suggestions shown in the chat input. Default is false.

chatMenu?​

optional chatMenu?: boolean;

The menu which displays chat history and other advanced features. Default is true.

chatSettings?​

optional chatSettings?: boolean;

The button that leads to the chat settings menu. Default is true.

clearChat?​

optional clearChat?: boolean;

The button that clears the current chat session. Default is true when chat menu is disabled.

createPrompt?​

optional createPrompt?: boolean;

The button that opens prompt creation drawer. Default is true.

feedback?​

optional feedback?: boolean;

The button that opens the feedback form. Default is true.

newChatButton?​

optional newChatButton?: boolean;

The ability to start a new chat from the chat menu. Disabling this will remove the new chat button in the chat menu. Default is true.

promptLibrary?​

optional promptLibrary?: boolean;

The entry point to the prompts library. Default is true.