Sign up (with export icon)

Marking AI-generated suggestions

Show the table of contents

When CKEditor AI features create track changes suggestions, you can mark those suggestions as AI-generated so reviewers can tell them apart from manual edits. The same origin can also be surfaced later in revision history, so a reviewer can see which saved revisions involved AI. Both are opt-in display options that are turned off by default.

Unlock this feature with selected CKEditor Plans

Try all premium features – no credit card needed.

Sign up for a free trial Select a Plan

How it works

Copy link

When CKEditor AI works together with Track Changes, its edits can be recorded as suggestions rather than applied directly to the content. Whenever a suggestion originates from AI, it is tagged so the editor can tell it apart from manual edits.

By default, an AI-generated suggestion looks exactly like a manual one. The display options below let you surface its origin in the suggestion annotation.

Note

This feature affects suggestions only and requires the Track Changes plugin. It applies whenever an AI feature creates a suggestion, however that suggestion was produced.

Displaying the AI source

Copy link

Use config.trackChanges.showAISource to control whether and how an AI-generated suggestion advertises its origin.

Value Result
'pill' Shows an “AI-generated” pill in the suggestion balloon while keeping the original author’s name and avatar.
'author' Swaps the author shown in the suggestion view for a view-only AI identity. The stored author is unchanged.
null Hides the AI source. AI-generated suggestions are displayed like manual ones. This is the default.

Pill

Copy link

The 'pill' mode adds an “AI-generated” pill to the suggestion balloon and keeps the original author’s identity:

ClassicEditor
    .create( {
        /* ... */
        trackChanges: {
            showAISource: 'pill'
        }
    } )
    .then( /* ... */ )
    .catch( /* ... */ );
Copy code

In the demo below, run a proofreading pass over the text. The AI corrections appear in the sidebar, each marked with an “AI-generated” pill while keeping the original author:

Remote Work Policy Update

Our remote work policy have been updated to give teams more flexibility. Each employee can now choose which days they work from home, as long as they coordinates with their manager ahead of time. We believe this approach will improve both productivity and moral across the company.

Its important to remember that core hours still apply, and that fewer meetings does not mean less communication. If you have any questions, please reach out to you're team lead, who can explain how these changes effect your role.

Author

Copy link

The 'author' mode replaces the author shown in the suggestion view (name and avatar) with a view-only AI identity. The original author is still stored in the suggestion data, so only the display changes:

ClassicEditor
    .create( {
        /* ... */
        trackChanges: {
            showAISource: 'author'
        }
    } )
    .then( /* ... */ )
    .catch( /* ... */ );
Copy code

In the demo below, run a proofreading pass over the text. The AI corrections appear in the sidebar under a view-only “AI Assistant” identity instead of the document author:

Remote Work Policy Update

Our remote work policy have been updated to give teams more flexibility. Each employee can now choose which days they work from home, as long as they coordinates with their manager ahead of time. We believe this approach will improve both productivity and moral across the company.

Its important to remember that core hours still apply, and that fewer meetings does not mean less communication. If you have any questions, please reach out to you're team lead, who can explain how these changes effect your role.

Customizing the AI author

Copy link

When showAISource is set to 'author', the suggestion view uses a built-in “AI Assistant” identity. Customize it with config.trackChanges.aiAuthor:

ClassicEditor
    .create( {
        /* ... */
        trackChanges: {
            showAISource: 'author',
            aiAuthor: {
                name: 'Acme Assistant',
                avatar: 'https://example.com/ai-avatar.png'
            }
        }
    } )
    .then( /* ... */ )
    .catch( /* ... */ );
Copy code

Both fields are optional: name defaults to AI Assistant, and when no avatar is provided, a default AI icon is shown.

Marking AI changes in revision history

Copy link

Suggestion annotations only show the origin while a suggestion is still open. Once a suggestion is accepted, or when an AI feature writes to the document directly, the annotation is gone. Revision history keeps that information, so a reviewer can still tell which saved revisions involved AI.

Use config.revisionHistory.showAISource to turn the markers on.

Value Result
'pill' Marks revisions and individual changes that involved AI, while keeping the original author.
null Hides the AI origin. Revisions are displayed like any other. This is the default.
ClassicEditor
    .create( {
        /* ... */
        revisionHistory: {
            showAISource: 'pill'
        }
    } )
    .then( /* ... */ )
    .catch( /* ... */ );
Copy code

With 'pill', revision history marks the origin in two places:

  • An “Includes AI suggestions” pill appears in the revisions list next to every revision that contains at least one change or suggestion created with the help of AI features.
  • When comparing revisions, an individual AI-assisted change is described with a “using AI” note and a sparkle icon, for example “Suggested by Joe using AI”.

In the demo below, run a proofreading pass over the text. The AI corrections are applied as suggestions and saved as a revision. Open the revision history with the toolbar button Revision history to see the saved revision marked with the pill, and select it to see each change described as made using AI:

Remote Work Policy Update

Our remote work policy have been updated to give teams more flexibility. Each employee can now choose which days they work from home, as long as they coordinates with their manager ahead of time. We believe this approach will improve both productivity and moral across the company.

Its important to remember that core hours still apply, and that fewer meetings does not mean less communication. If you have any questions, please reach out to you're team lead, who can explain how these changes effect your role.

The accepted values are a subset of config.trackChanges.showAISource, so you can configure both features consistently:

ClassicEditor
    .create( {
        /* ... */
        trackChanges: {
            showAISource: 'pill'
        },
        revisionHistory: {
            showAISource: 'pill'
        }
    } )
    .then( /* ... */ )
    .catch( /* ... */ );
Copy code
Note

The AI origin is recorded when a revision is saved, regardless of this option, which only controls whether it is displayed. Turning the option on therefore also reveals the origin in revisions saved earlier, as long as they were saved by a version of the editor that records it.

Copy link