AIChatConfig

interface

The configuration of the AI Chat feature.

The properties defined in this config are set in the config.ai.chat namespace.

ClassicEditor
	.create( editorElement, {
		ai: {
			chat: {
				// AI Chat configuration.
			}
		}
	} )
	.then( ... )
	.catch( ... );

Properties

context : AIChatContextConfig

The configuration of the AI Chat context.
Read more in AIChatContextConfig.
initialConversation : string | undefined
module:ai/aichat/aichat~AIChatConfig#initialConversation
Decides which conversation will be loaded after the feature has initialized.
Possible values are:
- 'new' - a new conversation is started (default),
- 'lastCreated' - the most recently created conversation will be loaded,
- conversation ID - the conversation with given ID will be loaded.
If 'lastCreated' is set while the conversation history is empty, a new conversation will be started instead.
If the conversation with the specified ID is not found, an error will be thrown.
Defaults to 'new'
shortcuts : readonly Array<AIChatShortcutDefinition> | undefined
module:ai/aichat/aichat~AIChatConfig#shortcuts
A list of shortcuts to be displayed in the AI Chat Shortcuts feed.
```
ClassicEditor
	.create( editorElement, {
		ai: {
			chat: {
				shortcuts: [
					// ...
				]
			}
		}
	} )
	.then( ... )
	.catch( ... );
```
Copy code
welcomeMessage : string | undefined

The welcome message to be displayed when the AI chat is initialized. When not set, the default welcome message will be used.