NEWCKEditor AI on your premises: Hook your LLM and register MCP tools. Webinar coming soon!
Sign up (with export icon)

AIQuickActionCustomChatDefinition

Api-interface iconinterface

A custom AI quick action definition that interacts with AI Chat.

It will open the AI Chat interface for interactive conversations:

{
	id: 'summarize-in-bullet-points',
	label: 'Summarize',
	displayedPrompt: 'Summarize in 5 bullet points',
	prompt: 'Summarize the selected text in 5 bullet points.',
	type: 'chat'
}
Copy code

Properties

  • Chevron-right icon

    The prompt shown in the AI Chat UI when the action is executed. If not specified, the prompt property value will be used.

  • Chevron-right icon

    id : string
    readonlyinherited

    The unique identifier of the action.

  • Chevron-right icon

    label : string
    readonlyinherited

    The human-readable label of the action.

  • Chevron-right icon

    model : string | undefined
    readonlyinherited

    The model to use for the action. If not specified, the default model will be used.

  • Chevron-right icon

    prompt : string
    readonlyinherited

    The prompt to be sent to the AI model when the action is executed.

  • Chevron-right icon

    type : 'chat'

    The type of the action.