1a921576 · permissionBRICK/SillyTavern

public/script.js+45 -32 Viewed

 /**
  * Background generation based on the provided prompt.
- * @param {string} quietPrompt Instruction prompt for the AI
+ * @typedef {object} GenerateQuietPromptParams
- * @param {boolean} [quietToLoud] Whether the message should be sent in a foreground (loud) or background (quiet) mode
+ * @prop {string} [quietPrompt] Instruction prompt for the AI
- * @param {boolean} [skipWIAN] Whether to skip addition of World Info and Author's Note into the prompt
+ * @prop {boolean} [quietToLoud] Whether the message should be sent in a foreground (loud) or background (quiet) mode
- * @param {string} [quietImage] Image to use for the quiet prompt
+ * @prop {boolean} [skipWIAN] Whether to skip addition of World Info and Author's Note into the prompt
- * @param {string} [quietName] Name to use for the quiet prompt (defaults to "System:")
+ * @prop {string} [quietImage] Image to use for the quiet prompt
- * @param {number} [responseLength] Maximum response length. If unset, the global default value is used.
+ * @prop {string} [quietName] Name to use for the quiet prompt (defaults to "System:")
- * @param {number} [forceChId] Character ID to use for this generation run. Works in groups only.
+ * @prop {number} [responseLength] Maximum response length. If unset, the global default value is used.
- * @param {AdditionalRequestOptions} [options={}] Additional generation request options.
+ * @prop {number} [forceChId] Character ID to use for this generation run. Works in groups only.
+ * @prop {object} [jsonSchema] JSON schema to use for the structured generation. Usually requires a special instruction.
+ * @param {GenerateQuietPromptParams} params Parameters for the quiet prompt generation
  * @returns {Promise<string>} Generated text. If using structured output, will contain a serialized JSON object.
  */
-export async function generateQuietPrompt(quietPrompt, quietToLoud = false, skipWIAN = false, quietImage = null, quietName = null, responseLength = null, forceChId = null, { jsonSchema } = {}) {
+export async function generateQuietPrompt({ quietPrompt = '', quietToLoud = false, skipWIAN = false, quietImage = null, quietName = null, responseLength = null, forceChId = null, jsonSchema = null } = {}) {
-    console.log('got into genQuietPrompt');
+    if (arguments.length > 0 && typeof arguments[0] !== 'object') {
+        console.trace('generateQuietPrompt called with positional arguments. Please use an object instead.');
+        [quietPrompt, quietToLoud, skipWIAN, quietImage, quietName, responseLength, forceChId, jsonSchema] = arguments;
+    }
     const responseLengthCustomized = typeof responseLength === 'number' && responseLength > 0;
     let eventHook = () => { };
     try {
         /** @type {GenerateOptions} */
-        const options = {
+        const generateOptions = {
-            quiet_prompt: quietPrompt,
+            quiet_prompt: quietPrompt ?? '',
-            quietToLoud,
+            quietToLoud: quietToLoud ?? false,
-            skipWIAN: skipWIAN,
+            skipWIAN: skipWIAN ?? false,
             force_name2: true,
-            quietImage: quietImage,
+            quietImage: quietImage ?? null,
-            quietName: quietName,
+            quietName: quietName ?? null,
-            force_chid: forceChId,
+            force_chid: forceChId ?? null,
-            jsonSchema: jsonSchema,
+            jsonSchema: jsonSchema ?? null,
         };
         if (responseLengthCustomized) {
             TempResponseLength.save(main_api, responseLength);
             eventHook = TempResponseLength.setupEventHook(main_api);
+        }
-        const result = await Generate('quiet', options);
+        const result = await Generate('quiet', generateOptions);
         return removeReasoningFromString(result);
     } finally {
         if (responseLengthCustomized && TempResponseLength.isCustomized()) {

 /**
  * Generates a message using the provided prompt.
  * If the prompt is an array of chat-style messages and not using chat completion, it will be converted to a text prompt.
- * @param {string | object[]} prompt Prompt to generate a message from. Can be a string or an array of chat-style messages, i.e. [{role: '', content: ''}, ...]
+ * @typedef {object} GenerateRawParams
- * @param {string} api API to use. Main API is used if not specified.
+ * @prop {string | object[]} [prompt] Prompt to generate a message from. Can be a string or an array of chat-style messages, i.e. [{role: '', content: ''}, ...]
- * @param {boolean} instructOverride true to override instruct mode, false to use the default value
+ * @prop {string} [api] API to use. Main API is used if not specified.
- * @param {boolean} quietToLoud true to generate a message in system mode, false to generate a message in character mode
+ * @prop {boolean} [instructOverride] true to override instruct mode, false to use the default value
- * @param {string} [systemPrompt] System prompt to use.
+ * @prop {boolean} [quietToLoud] true to generate a message in system mode, false to generate a message in character mode
- * @param {number} [responseLength] Maximum response length. If unset, the global default value is used.
+ * @prop {string} [systemPrompt] System prompt to use.
- * @param {boolean} [trimNames] Whether to allow trimming "{{user}}:" and "{{char}}:" from the response.
+ * @prop {number} [responseLength] Maximum response length. If unset, the global default value is used.
- * @param {string} [prefill] An optional prefill for the prompt.
+ * @prop {boolean} [trimNames] Whether to allow trimming "{{user}}:" and "{{char}}:" from the response.
- * @param {AdditionalRequestOptions} [options] Additional options for generation
+ * @prop {string} [prefill] An optional prefill for the prompt.
+ * @prop {object} [jsonSchema] JSON schema to use for the structured generation. Usually requires a special instruction.
+ * @param {GenerateRawParams} params Parameters for generating a message
  * @returns {Promise<string>} Generated message
  */
-export async function generateRaw(prompt, api, instructOverride, quietToLoud, systemPrompt, responseLength, trimNames = true, prefill = '', options = {}) {
+export async function generateRaw({ prompt = '', api = null, instructOverride = false, quietToLoud = false, systemPrompt = '', responseLength = null, trimNames = true, prefill = '', jsonSchema = null } = {}) {
+    if (arguments.length > 0 && typeof arguments[0] !== 'object') {
+        console.trace('generateRaw called with positional arguments. Please use an object instead.');
+        [prompt, api, instructOverride, quietToLoud, systemPrompt, responseLength, trimNames, prefill, jsonSchema] = arguments;
+    }
     if (!api) {
         api = main_api;
+    }

         if (api === 'koboldhorde') {
             data = await generateHorde(prompt.toString(), generateData, abortController.signal, false);
         } else if (api === 'openai') {
-            data = await sendOpenAIRequest('quiet', generateData, abortController.signal, options);
+            data = await sendOpenAIRequest('quiet', generateData, abortController.signal, { jsonSchema });
         } else {
             const generateUrl = getGenerateUrl(api);
             const response = await fetch(generateUrl, {

@@ -3209,7 +3222,7 @@ export async function generateRaw(prompt, api, instructOverride, quietToLoud, sy
3209	throw new Error(data.response);	3222	throw new Error(data.response);
3210	}	3223	}
3211		3224
3212	if (options?.jsonSchema) {	3225	if (jsonSchema) {
3213	return extractJsonFromData(data, { mainApi: api });	3226	return extractJsonFromData(data, { mainApi: api });
3214	}	3227	}
3215		3228

     registerDebugFunction('generationTest', 'Send a generation request', 'Generates text using the currently selected API.', async () => {
         const text = prompt('Input text:', 'Hello');
         toastr.info('Working on it...');
-        const message = await generateRaw(text, null, false, false);
+        const message = await generateRaw({ prompt: text });
         alert(message);
     });
     registerDebugFunction('toggleEventTracing', 'Toggle event tracing', 'Useful to see what triggered a certain event.', () => {

public/scripts/backgrounds.js+1 -1 Viewed

     const list = options.map(option => `- ${option.text}`).join('\n');
     const prompt = stringFormat(autoBgPrompt, list);
-    const reply = await generateQuietPrompt(prompt, false, false);
+    const reply = await generateQuietPrompt({ quietPrompt: prompt });
     const fuse = new Fuse(options, { keys: ['text'] });
     const bestMatch = fuse.search(reply, { limit: 1 });

public/scripts/extensions/expressions/index.js+3 -3 Viewed

 import { Fuse } from '../../../lib.js';
-import { characters, eventSource, event_types, generateQuietPrompt, generateRaw, getRequestHeaders, main_api, online_status, saveSettingsDebounced, substituteParams, substituteParamsExtended, system_message_types, this_chid } from '../../../script.js';
+import { characters, eventSource, event_types, generateQuietPrompt, generateRaw, getRequestHeaders, online_status, saveSettingsDebounced, substituteParams, substituteParamsExtended, system_message_types, this_chid } from '../../../script.js';
 import { dragElement, isMobile } from '../../RossAscends-mods.js';
 import { getContext, getApiUrl, modules, extension_settings, ModuleWorkerWrapper, doExtrasFetch, renderExtensionTemplateAsync } from '../../extensions.js';
 import { loadMovingUIState, performFuzzySearch, power_user } from '../../power-user.js';

                     inApiCall = true;
                     switch (extension_settings.expressions.promptType) {
                         case PROMPT_TYPE.raw:
-                            emotionResponse = await generateRaw(text, main_api, false, false, prompt);
+                            emotionResponse = await generateRaw({ prompt: text, systemPrompt: prompt });
                             break;
                         case PROMPT_TYPE.full:
-                            emotionResponse = await generateQuietPrompt(prompt, false, false);
+                            emotionResponse = await generateQuietPrompt({ quietPrompt: prompt });
                             break;
+                    }
                 } finally {

public/scripts/extensions/memory/index.js+15 -3 Viewed

             case summary_sources.extras:
                 return await callExtrasSummarizeAPI(text);
             case summary_sources.main:
-                return removeReasoningFromString(await generateRaw(text, '', false, false, prompt, extension_settings.memory.overrideResponseLength));
+                return removeReasoningFromString(await generateRaw({ prompt: text, systemPrompt: prompt, responseLength: extension_settings.memory.overrideResponseLength }));
             case summary_sources.webllm: {
                 const messages = [{ role: 'system', content: prompt }, { role: 'user', content: text }].filter(m => m.content);
                 const params = extension_settings.memory.overrideResponseLength > 0 ? { max_tokens: extension_settings.memory.overrideResponseLength } : {};

     if (prompt_builders.DEFAULT === extension_settings.memory.prompt_builder) {
         try {
             inApiCall = true;
-            summary = await generateQuietPrompt(prompt, false, skipWIAN, '', '', extension_settings.memory.overrideResponseLength);
+            /** @type {import('../../../script.js').GenerateQuietPromptParams} */
+            const params = {
+                quietPrompt: prompt,
+                skipWIAN: skipWIAN,
+                responseLength: extension_settings.memory.overrideResponseLength,
+            };
+            summary = await generateQuietPrompt(params);
         } finally {
             inApiCall = false;
+        }

                 return null;
+            }
-            const rawSummary = await generateRaw(rawPrompt, '', false, false, prompt, extension_settings.memory.overrideResponseLength);
+            /** @type {import('../../../script.js').GenerateRawParams} */
+            const params = {
+                prompt: rawPrompt,
+                systemPrompt: prompt,
+                responseLength: extension_settings.memory.overrideResponseLength,
+            };
+            const rawSummary = await generateRaw(params);
             summary = removeReasoningFromString(rawSummary);
             index = lastUsedIndex;
         } finally {

public/scripts/extensions/stable-diffusion/index.js+1 -1 Viewed

  * @returns {Promise<string>} - A promise that resolves when the prompt generation completes.
  */
 async function generatePrompt(quietPrompt) {
-    const reply = await generateQuietPrompt(quietPrompt, false, false);
+    const reply = await generateQuietPrompt({ quietPrompt });
     const processedReply = processReply(reply);
     if (!processedReply) {

public/scripts/extensions/vectors/index.js+3 -3 Viewed

 /**
  * Summarizes messages using the main API method.
  * @param {HashedMessage} element hashed message
- * @returns {Promise<boolean>} Sucess
+ * @returns {Promise<boolean>} Success
  */
 async function summarizeMain(element) {
-    element.text = removeReasoningFromString(await generateRaw(element.text, '', false, false, settings.summary_prompt));
+    element.text = removeReasoningFromString(await generateRaw({ prompt: element.text, systemPrompt: settings.summary_prompt }));
     return true;
+}
 /**
  * Summarizes messages using WebLLM.
  * @param {HashedMessage} element hashed message
- * @returns {Promise<boolean>} Sucess
+ * @returns {Promise<boolean>} Success
  */
 async function summarizeWebLLM(element) {
     if (!isWebLlmSupported()) {

public/scripts/slash-commands.js+21 -4 Viewed

+        }
         setEphemeralStopStrings(resolveVariable(args?.stop));
-        const result = await generateRaw(value, '', isFalseBoolean(args?.instruct), quietToLoud, systemPrompt, length, trimNames, prefillPrompt);
+        /** @type {import('../script.js').GenerateRawParams} */
+        const params = {
+            prompt: value,
+            instructOverride: isFalseBoolean(args?.instruct),
+            quietToLoud: quietToLoud,
+            systemPrompt: systemPrompt,
+            responseLength: length,
+            trimNames: trimNames,
+            prefill: prefillPrompt,
+        };
+        const result = await generateRaw(params);
         return result;
     } catch (err) {
         console.error('Error on /genraw generation', err);

         setEphemeralStopStrings(resolveVariable(args?.stop));
         const name = args?.name;
         const char = findChar({ name: name });
-        const result = await generateQuietPrompt(value, quietToLoud, false, '', char?.name ?? name, length);
+        /** @type {import('../script.js').GenerateQuietPromptParams} */
+        const params = {
+            quietPrompt: value,
+            quietToLoud: quietToLoud,
+            quietName: char?.name ?? name,
+            responseLength: length,
+        };
+        const result = await generateQuietPrompt(params);
         return result;
     } catch (err) {
         console.error('Error on /gen generation', err);

     // Generate and regex the output if applicable
     toastr.info('Please wait', 'Generating...');
-    let message = await generateQuietPrompt(prompt, false, false);
+    let message = await generateQuietPrompt({ quietPrompt: prompt });
     message = getRegexedString(message, regex_placement.SLASH_COMMAND);
     sendNarratorMessage(_, message);

     //text = `${text}${power_user.instruct.enabled ? '' : '\n'}${(power_user.always_force_name2 && who != 'raw') ? characters[character_id].name + ":" : ""}`
-    let reply = await generateQuietPrompt(text, true, false);
+    let reply = await generateQuietPrompt({ quietPrompt: text, quietToLoud: true });
     text = await getRegexedString(reply, regex_placement.SLASH_COMMAND);
     const message = {

Refactor generateRaw/generateQuietPrompt calls (#4277) * generateQuietPrompt: Update to object arguments * generateRaw: Update to object arguments * Fix jsdoc * Fix lint * Unwrap JSON schema options * Remove default args from gen call