onlyoffice.github.io/sdkjs-plugins/content/ai/scripts/custom-annotations/assistant-replace-hint.js

/*
 * (c) Copyright Ascensio System SIA 2010-2025
 *
 * This program is a free software product. You can redistribute it and/or
 * modify it under the terms of the GNU Affero General Public License (AGPL)
 * version 3 as published by the Free Software Foundation. In accordance with
 * Section 7(a) of the GNU AGPL its Section 15 shall be amended to the effect
 * that Ascensio System SIA expressly excludes the warranty of non-infringement
 * of any third-party rights.
 *
 * This program is distributed WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE. For
 * details, see the GNU AGPL at: http://www.gnu.org/licenses/agpl-3.0.html
 *
 * You can contact Ascensio System SIA at 20A-6 Ernesta Birznieka-Upish
 * street, Riga, Latvia, EU, LV-1050.
 *
 * The  interactive user interfaces in modified source and object code versions
 * of the Program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU AGPL version 3.
 *
 * Pursuant to Section 7(b) of the License you must retain the original Product
 * logo when distributing the program. Pursuant to Section 7(e) we decline to
 * grant you any rights under trademark law for use of our trademarks.
 *
 * All the Product's GUI elements, including illustrations and icon sets, as
 * well as technical writing content are licensed under the terms of the
 * Creative Commons Attribution-ShareAlike 4.0 International. See the License
 * terms at http://creativecommons.org/licenses/by-sa/4.0/legalcode
 *
 */

/// <reference path="./custom-annotator.js" />
/// <reference path="./types.js" />

/** @param {localStorageCustomAssistantItem} assistantData */
function AssistantReplaceHint(assistantData)
{
	CustomAnnotator.call(this);
	this.type = assistantData.type; // 1
    this.assistantData = assistantData;
}
AssistantReplaceHint.prototype = Object.create(CustomAnnotator.prototype);
AssistantReplaceHint.prototype.constructor = AssistantReplaceHint;

/**
 * @param {string} paraId 
 * @param {string} recalcId 
 * @param {string} text
 */
AssistantReplaceHint.prototype.annotateParagraph = async function(paraId, recalcId, text)
{
	this.paragraphs[paraId] = {};

	let requestEngine = AI.Request.create(AI.ActionType.Chat);
	if (!requestEngine || text.length === 0)
		return false;

	let isSendedEndLongAction = false;
	async function checkEndAction()
	{
		if (!isSendedEndLongAction)
			isSendedEndLongAction = true;
	}

	const argPrompt = this._createPrompt(text);

	let response = "";
	await requestEngine.chatRequest(argPrompt, false, async function (/** @type {string} */data)
	{
		if (!data)
			return;
		await checkEndAction();
		response += data;
	});
	await checkEndAction();

	let rangeId = 1;
	let ranges = [];

	let _t = this;

	/**
	 * @param {string} text 
	 * @param {ReplaceHintAiResponse[]} corrections 
	 */
	function convertToRanges(text, corrections) 
	{
		for (const { origin, suggestion, difference, reason, paragraph, occurrence, confidence } of corrections) 
		{
			if (origin === suggestion || confidence <= 0.7)
				continue;
			
			let count = 0;
			let searchStart = 0;

			while (searchStart < text.length)
			{
				const index = _t.simpleGraphemeIndexOf(text, origin, searchStart);
				if (index === -1) break;

				count++;
				if (count === occurrence)
				{
					ranges.push({
						"start": index,
						"length": [...origin].length,
						"id": rangeId
					});
					_t.paragraphs[paraId][rangeId] = {
						"original" : origin,
						"suggestion" : suggestion,
						"difference" : difference,
						"reason" : reason
					};
					++rangeId;
					break;
				}
				searchStart = index + 1;
			}
		}
	}

	try 
	{
		convertToRanges(text, JSON.parse(response));
		let obj = {
			"type": "highlightText",
			"paragraphId": paraId,
			"name" : "customAssistant_" + this.assistantData.id,
			"recalcId": recalcId,
			"ranges": ranges
		};
		await Asc.Editor.callMethod("AnnotateParagraph", [obj]);
	}
	catch (e)
	{ }
}

/**
 * @param {string} text 
 * @returns {string}
 */
AssistantReplaceHint.prototype._createPrompt = function(text) {
	let prompt = `You are a multi-disciplinary text analysis and transformation assistant.
	  Your task is to analyze text based on user's specific criteria and provide intelligent corrections.
	
	  MANDATORY RULES:
		1. UNDERSTAND the user's intent from their criteria.
		2. Find words, phrases, or sentences that match the user's criteria.
		3. For EACH match you find:
		  - Provide the exact quote.
		  - SUGGEST appropriate replacements.
		  - Explain WHY it matches the criteria.
		  - Provide position information (paragraph number).
		4. If no matches are found, return an empty array: [].
		5. Format your response STRICTLY in JSON format.
		6. Support multiple languages (English, Russian, etc.)

	  Response format - return ONLY this JSON array with no additional text:
		[
		  {
			"origin": "exact text fragment that matches the query",
      		"suggestion": "suggested replacement",
			"reason": "detailed explanation why it matches the criteria",
   			"difference":"difference between origin and suggestion"
			"paragraph": paragraph_number,
			"occurrence": 1,
			"confidence": 0.95
		  }
		]

	  Guidelines for each field:
		- "origin": EXACT UNCHANGED original text fragment. Do not fix anything in this field.
		- "suggestion": Your suggested replacement for the fragment.
			* Ensure it aligns with the user's criteria.
			* Maintain coherence with surrounding text.
		- "reason": Clear explanation of why this fragment matches the criteria.
		- "difference":  The difference between origin and suggestion in html format: that is, you need to take the suggestion field and highlight the differences in it by wrapping them in the <strong> tag.
		- "paragraph": Paragraph number where the fragment is found (0-based index)
		- "occurrence": Which occurrence of this sentence if it appears multiple times (1 for first, 2 for second, etc.)
		- "confidence": Value between 0 and 1 indicating certainty (1.0 = completely certain, 0.5 = uncertain)
	  
	  CRITICAL:
		- Output should be in the exact this format
		- No any comments are allowed

	  CRITICAL - Output Format:
		- Return ONLY the raw JSON array, nothing else
		- DO NOT wrap the response in markdown code blocks (no \`\`\`json or \`\`\`)
		- DO NOT include any explanatory text before or after the JSON
		- DO NOT use escaped newlines (\\n) - return the JSON on a single line if possible
		- The response should start with [ and end with ]
	  `;
	  prompt += "\n\nUSER REQUEST:\n```" + this.assistantData.query + "\n```\n\n";
	  
	  prompt += "TEXT TO ANALYZE:\n```\n" + text + "\n```\n\n";

	  prompt += `Please analyze this text and find all fragments that match the user's request. Be thorough but precise.`;

	  return prompt;
}

/**
 * @param {string} paraId 
 * @param {string} rangeId 
 * @returns {ReplaceHintInfoForPopup}
 */
AssistantReplaceHint.prototype.getInfoForPopup = function(paraId, rangeId)
{
	let _s = this.getAnnotation(paraId, rangeId);
	return {
		original : _s["original"],
		suggested : _s["difference"],
		explanation : _s["reason"],
		type : this.type
	};
};

/**
 * @param {string} paraId 
 * @param {string} rangeId 
 */
AssistantReplaceHint.prototype.onAccept = async function(paraId, rangeId)
{
	let text = this.getAnnotation(paraId, rangeId)["suggestion"];
	
	await Asc.Editor.callMethod("StartAction", ["GroupActions"]);

	let range = this.getAnnotationRangeObj(paraId, rangeId);
	await Asc.Editor.callMethod("SelectAnnotationRange", [range]);
	
	Asc.scope.text = text;
	await Asc.Editor.callCommand(function(){
		Api.ReplaceTextSmart([Asc.scope.text]);
		Api.GetDocument().RemoveSelection();
	});
	
	await Asc.Editor.callMethod("RemoveAnnotationRange", [range]);
	await Asc.Editor.callMethod("EndAction", ["GroupActions"]);
	await Asc.Editor.callMethod("FocusEditor");
};

/**
 * @param {string} paraId 
 * @param {string} rangeId 
 */
AssistantReplaceHint.prototype.getAnnotationRangeObj = function(paraId, rangeId)
{
	return {
		"paragraphId" : paraId,
		"rangeId" : rangeId,
		"name" : "customAssistant_" + this.assistantData.id
	};
};
AssistantReplaceHint.prototype._handleNewRangePositions = async function(range, paraId, text)
{
	if (!range || range["name"] !== "customAssistant_" + this.assistantData.id || !this.paragraphs[paraId])
		return;

	let rangeId = range["id"];
	let annot = this.getAnnotation(paraId, rangeId);
	
	if (!annot)
		return;
	
	let start = range["start"];
	let len = range["length"];

	if (annot["original"] !== text.substring(start, start + len))
	{
		let annotRange = this.getAnnotationRangeObj(paraId, rangeId);
		Asc.Editor.callMethod("RemoveAnnotationRange", [annotRange]);
	}
};