Merge pull request #2465 from SillyTavern/stop-gen-slash-command /stop slash command to stop generation

7820ec66b92cea4c72e017ba705bdb12a30766da

Cohee <18619528+Cohee1207@users.noreply.github.com>

Signed

public/script.js+29 -11 Viewed

 import { initPresetManager } from './scripts/preset-manager.js';
 import { MacrosParser, evaluateMacros } from './scripts/macros.js';
 import { currentUser, setUserControls } from './scripts/user.js';
 import { POPUP_RESULT, POPUP_TYPE, Popup, callGenericPopup, fixToastrForDialogs } from './scripts/popup.js';
 import { renderTemplate, renderTemplateAsync } from './scripts/templates.js';
 import { ScraperManager } from './scripts/scrapers.js';
 import { SlashCommandParser } from './scripts/slash-commands/SlashCommandParser.js';

 let dialogueResolve = null;
 let dialogueCloseStop = false;
 export let chat_metadata = {};
 +/** @type {StreamingProcessor} */
 export let streamingProcessor = null;
 let crop_data = undefined;
 let is_delete_mode = false;

 //novel settings
 export let novelai_settings;
 export let novelai_setting_names;
 +/** @type {AbortController} */
 let abortController;
 //css

+}
 /**
 + * Stops the generation and any streaming if it is currently running.
 + */
 +export function stopGeneration() {
 +    let stopped = false;
 +    if (streamingProcessor) {
 +        streamingProcessor.onStopStreaming();
 +        streamingProcessor = null;
 +        stopped = true;
 +    }
 +    if (abortController) {
 +        abortController.abort('Clicked stop button');
 +        hideStopButton();
 +        stopped = true;
 +    }
 +    eventSource.emit(event_types.GENERATION_STOPPED);
 +    return stopped;
 +}
++
 +/**
  * Injects extension prompts into chat messages.
  * @param {object[]} messages Array of chat messages
  * @param {boolean} isContinue Whether the generation is a continuation. If true, the extension prompts of depth 0 are injected at position 1.

  * @param {string} inputValue - Value to set the input to.
  * @param {PopupOptions} options - Options for the popup.
  * @typedef {{okButton?: string, rows?: number, wide?: boolean, wider?: boolean, large?: boolean, allowHorizontalScrolling?: boolean, allowVerticalScrolling?: boolean, cropAspect?: number }} PopupOptions - Options for the popup.
 - * @returns
 + * @returns {Promise<any>} A promise that resolves when the popup is closed.
 + * @deprecated Use `callGenericPopup` instead.
  */
 export function callPopup(text, type, inputValue = '', { okButton, rows, wide, wider, large, allowHorizontalScrolling, allowVerticalScrolling, cropAspect } = {}) {
     function getOkButtonText() {

         eventTypes: event_types,
         addOneMessage: addOneMessage,
         generate: Generate,
 +        stopGeneration: stopGeneration,
         getTokenCount: getTokenCount,
         extensionPrompts: extension_prompts,
         setExtensionPrompt: setExtensionPrompt,

          * @deprecated Legacy snake-case naming, compatibility with old extensions
          */
         event_types: event_types,
 +        POPUP_TYPE: POPUP_TYPE,
 +        POPUP_RESULT: POPUP_RESULT,
     };
 };

     });
     $(document).on('click', '.mes_stop', function () {
 -        if (streamingProcessor) {
 +        stopGeneration();
 -            streamingProcessor.onStopStreaming();
 -            streamingProcessor = null;
 -        }
 -        if (abortController) {
 -            abortController.abort('Clicked stop button');
 -            hideStopButton();
 -        }
 -        eventSource.emit(event_types.GENERATION_STOPPED);
     });
     $(document).on('click', '#form_sheld .stscript_continue', function () {

     initCustomSelectedSamplers();
 });
++

public/scripts/slash-commands.js+19 -0 Viewed

     setCharacterName,
     setExtensionPrompt,
     setUserName,
 +    stopGeneration,
     substituteParams,
     system_avatar,
     system_message_types,

         helpString: 'Adds a swipe to the last chat message.',
     }));
     SlashCommandParser.addCommandObject(SlashCommand.fromProps({
 +        name: 'stop',
 +        callback: () => {
 +            const stopped = stopGeneration();
 +            return String(stopped);
 +        },
 +        returns: 'true/false, whether the generation was running and got stopped',
 +        helpString: `
 +            <div>
 +                Stops the generation and any streaming if it is currently running.
 +            </div>
 +            <div>
 +                Note: This command cannot be executed from the chat input, as sending any message or script from there is blocked during generation.
 +                But it can be executed via automations or QR scripts/buttons.
 +            </div>
 +        `,
 +        aliases: ['generate-stop'],
 +    }));
 +    SlashCommandParser.addCommandObject(SlashCommand.fromProps({
         name: 'abort',
         callback: abortCallback,
         namedArgumentList: [