Skip to main content

SetAssistantTrackRevisions

Enables or disables AI-assisted change tracking in the document.

Syntax

expression.SetAssistantTrackRevisions(isTrack, assistantName);

expression - A variable that represents a ApiDocument class.

Parameters

NameRequired/OptionalData typeDefaultDescription
isTrackRequiredbooleanSpecifies whether the change tracking mode is set or not.
assistantNameRequiredstringThe AI assistant name.

Returns

boolean

Example

Enable AI-assisted revision tracking with an author name in a document.

// How do I track changes made by an AI assistant in a document?

// Assign a named author to AI-generated edits so reviewers can identify them separately.

const doc = Api.GetDocument();

const paragraph = doc.GetElement(0);
paragraph.AddText('Original document text.');

doc.SetAssistantTrackRevisions(true, 'AI Assistant');

const assistantParagraph = Api.CreateParagraph();
assistantParagraph.AddText('Text added by AI assistant.');
doc.Push(assistantParagraph);

doc.SetAssistantTrackRevisions(false);

const resultParagraph = Api.CreateParagraph();
resultParagraph.AddText('AI-assisted tracking has been enabled and then disabled.');
doc.Push(resultParagraph);