Sign up (with export icon)

AIConfig

Api-interface icon interface

The configuration for all AI-related functionalities.

Provides configuration properties for both AI features and AI adapters (which connect to the external AI services),

ClassicEditor
	.create( editorElement, {
		ai: {
			...
		}
	} )
	.then( ... )
	.catch( ... );
Copy code

See all editor configuration options.

Properties

  • Chevron-right icon

    The configuration of the AI Assistant feature.

    Read more in AIAssistantConfig.

  • Chevron-right icon

    availableReplyActions : Array<'showChangeInText' | 'insertSuggestion' | 'applySuggestion'> | undefined

    The configuration of the advanced reply dropdown in the AI chat feed. It also affects the buttons in quick actions balloon.

    It defines which actions and in which order will be displayed in the dropdown in the AI chat feed. The first action is used as the default action for the dropdown button. By default, it contains the following actions:

    Note, that the quick actions balloon does not display 'showChangeInText' button.

    Note, that the 'applySuggestion' button is hidden when track changes feature is turned on.

    [ 'applySuggestion', 'insertSuggestion', 'showChangeInText' ]
    
    Copy code
  • Chevron-right icon

    chat : AIChatConfig | undefined

    The configuration of the AI Chat feature.

    Read more in AIChatConfig.

  • Chevron-right icon

    The configuration of the AI user interface provided by the AITabs plugin.

  • Chevron-right icon

    The configuration of the AI Quick Actions feature.

    Read more in AIQuickActionsConfig.

  • Chevron-right icon

    The configuration of the AI Review Mode feature.

  • Chevron-right icon

    serviceUrl : string | undefined

    The URL of the AI service endpoint.

    This endpoint is used by AI features: AI Chat, AI Quick Actions, and AI Review Mode. It does not affect the AI Assistant feature, which uses its own adapter configuration.

    NOTE: By default, the plugin uses the default AI service endpoint delivered by CKEditor Cloud Services.

    Defaults to 'https://ai.cke-cs.com/v1'