Merge pull request #3191 from SillyTavern/group-join-examples Fixes to group join examples parsing

71d253032929d211036284c32899ca161cafd0c6

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

Signed

Parents: 2c0895bd7dee83c78852199176cf0616ba934107 107e2e0ed079b20fae9c21134e1b6e2bd26537df

public/scripts/group-chats.js+22 -2 Viewed

+}
 /**
+ * Retrieves the member names of a group. If the group is not selected, an empty array is returned.
+ * @returns {string[]} An array of character names representing the members of the group.
+ */
+export function getGroupNames() {
+    if (!selected_group) {
+        return [];
+    }
+    const groupMembers = groups.find(x => x.id == selected_group)?.members;
+    return Array.isArray(groupMembers)
+        ? groupMembers.map(x => characters.find(y => y.avatar === x)?.name).filter(x => x)
+        : [];
+}
+/**
  * Finds the character ID for a group member.
  * @param {string} arg 0-based member index or character name
  * @returns {number} 0-based character ID

      * @param {string} value Value to replace
      * @param {string} characterName Name of the character
      * @param {string} fieldName Name of the field
+     * @param {function(string): string} [preprocess] Preprocess function
      * @returns {string} Prepared text
      * */
-    function replaceAndPrepareForJoin(value, characterName, fieldName) {
+    function replaceAndPrepareForJoin(value, characterName, fieldName, preprocess = null) {
         value = value.trim();
         if (!value) {
             return '';
+        }
+        // Run preprocess function
+        if (typeof preprocess === 'function') {
+            value = preprocess(value);
+        }
         // Prepare and replace prefixes
         const prefix = customBaseChatReplace(group.generation_mode_join_prefix, fieldName, characterName);
         const suffix = customBaseChatReplace(group.generation_mode_join_suffix, fieldName, characterName);

         descriptions.push(replaceAndPrepareForJoin(character.description, character.name, 'Description'));
         personalities.push(replaceAndPrepareForJoin(character.personality, character.name, 'Personality'));
         scenarios.push(replaceAndPrepareForJoin(character.scenario, character.name, 'Scenario'));
-        mesExamplesArray.push(replaceAndPrepareForJoin(character.mes_example, character.name, 'Example Messages'));
+        mesExamplesArray.push(replaceAndPrepareForJoin(character.mes_example, character.name, 'Example Messages', (x) => !x.startsWith('<START>') ? `<START>\n${x}` : x));
+    }
     const description = descriptions.filter(x => x.length).join('\n');

public/scripts/openai.js+13 -4 Viewed

     system_message_types,
     this_chid,
 } from '../script.js';
-import { selected_group } from './group-chats.js';
+import { getGroupNames, selected_group } from './group-chats.js';
 import {
     chatCompletionDefaultPrompts,

  * @returns {Message[]} Array of message objects
  */
 export function parseExampleIntoIndividual(messageExampleString, appendNamesForGroup = true) {
+    const groupBotNames = getGroupNames().map(name => `${name}:`);
     let result = []; // array of msgs
     let tmp = messageExampleString.split('\n');
     let cur_msg_lines = [];
     let in_user = false;
     let in_bot = false;
+    let botName = name2;
     // DRY my cock and balls :)
     function add_msg(name, role, system_name) {
         // join different newlines (we split them by \n and join by \n)

             in_user = true;
             // we were in the bot mode previously, add the message
             if (in_bot) {
-                add_msg(name2, 'system', 'example_assistant');
+                add_msg(botName, 'system', 'example_assistant');
+            }
             in_bot = false;
-        } else if (cur_str.startsWith(name2 + ':')) {
+        } else if (cur_str.startsWith(name2 + ':') || groupBotNames.some(n => cur_str.startsWith(n))) {
+            if (!cur_str.startsWith(name2 + ':') && groupBotNames.length) {
+                botName = cur_str.split(':')[0];
+            }
             in_bot = true;
             // we were in the user mode previously, add the message
             if (in_user) {

@@ -589,7 +597,7 @@ export function parseExampleIntoIndividual(messageExampleString, appendNamesForG
589	if (in_user) {	597	if (in_user) {
590	add_msg(name1, 'system', 'example_user');	598	add_msg(name1, 'system', 'example_user');
591	} else if (in_bot) {	599	} else if (in_bot) {
592	add_msg(name2, 'system', 'example_assistant');	600	add_msg(botName, 'system', 'example_assistant');
593	}	601	}
594	return result;	602	return result;
595	}	603	}

         'n': canMultiSwipe ? oai_settings.n : undefined,
         'user_name': name1,
         'char_name': name2,
+        'group_names': getGroupNames(),
     };
     // Empty array will produce a validation error

src/endpoints/backends/chat-completions.js+12 -13 Viewed

     mergeMessages,
     cachingAtDepthForOpenRouterClaude,
     cachingAtDepthForClaude,
+    getPromptNames,
 } from '../../prompt-converters.js';
 import { readSecret, SECRET_KEYS } from '../secrets.js';

  * Applies a post-processing step to the generated messages.
  * @param {object[]} messages Messages to post-process
  * @param {string} type Prompt conversion type
- * @param {string} charName Character name
+ * @param {import('../../prompt-converters.js').PromptNames} names Prompt names
- * @param {string} userName User name
  * @returns
  */
-function postProcessPrompt(messages, type, charName, userName) {
+function postProcessPrompt(messages, type, names) {
     switch (type) {
         case 'merge':
         case 'claude':
-            return mergeMessages(messages, charName, userName, false);
+            return mergeMessages(messages, names, false);
         case 'strict':
-            return mergeMessages(messages, charName, userName, true);
+            return mergeMessages(messages, names, true);
         default:
             return messages;
+    }

         const additionalHeaders = {};
         const useTools = request.body.model.startsWith('claude-3') && Array.isArray(request.body.tools) && request.body.tools.length > 0;
         const useSystemPrompt = (request.body.model.startsWith('claude-2') || request.body.model.startsWith('claude-3')) && request.body.claude_use_sysprompt;
-        const convertedPrompt = convertClaudeMessages(request.body.messages, request.body.assistant_prefill, useSystemPrompt, useTools, request.body.char_name, request.body.user_name);
+        const convertedPrompt = convertClaudeMessages(request.body.messages, request.body.assistant_prefill, useSystemPrompt, useTools, getPromptNames(request));
         // Add custom stop sequences
         const stopSequences = [];
         if (Array.isArray(request.body.stop)) {

             model.startsWith('gemini-exp')
         ) && request.body.use_makersuite_sysprompt;
-        const prompt = convertGooglePrompt(request.body.messages, model, should_use_system_prompt, request.body.char_name, request.body.user_name);
+        const prompt = convertGooglePrompt(request.body.messages, model, should_use_system_prompt, getPromptNames(request));
         let body = {
             contents: prompt.contents,
             safetySettings: GEMINI_SAFETY,

     request.socket.on('close', function () {
         controller.abort();
     });
-    const convertedPrompt = convertAI21Messages(request.body.messages, request.body.char_name, request.body.user_name);
+    const convertedPrompt = convertAI21Messages(request.body.messages, getPromptNames(request));
     const body = {
         messages: convertedPrompt,
         model: request.body.model,

+    }
     try {
-        const messages = convertMistralMessages(request.body.messages, request.body.char_name, request.body.user_name);
+        const messages = convertMistralMessages(request.body.messages, getPromptNames(request));
         const controller = new AbortController();
         request.socket.removeAllListeners('close');
         request.socket.on('close', function () {

+    }
     try {
-        const convertedHistory = convertCohereMessages(request.body.messages, request.body.char_name, request.body.user_name);
+        const convertedHistory = convertCohereMessages(request.body.messages, getPromptNames(request));
         const tools = [];
         if (Array.isArray(request.body.tools) && request.body.tools.length > 0) {

             request.body.messages = postProcessPrompt(
                 request.body.messages,
                 request.body.custom_prompt_post_processing,
-                request.body.char_name,
+                getPromptNames(request));
-                request.body.user_name);
+        }
     } else if (request.body.chat_completion_source === CHAT_COMPLETION_SOURCES.PERPLEXITY) {
         apiUrl = API_PERPLEXITY;
         apiKey = readSecret(request.user.directories, SECRET_KEYS.PERPLEXITY);
         headers = {};
         bodyParams = {};
-        request.body.messages = postProcessPrompt(request.body.messages, 'strict', request.body.char_name, request.body.user_name);
+        request.body.messages = postProcessPrompt(request.body.messages, 'strict', getPromptNames(request));
     } else if (request.body.chat_completion_source === CHAT_COMPLETION_SOURCES.GROQ) {
         apiUrl = API_GROQ;
         apiKey = readSecret(request.user.directories, SECRET_KEYS.GROQ);

src/prompt-converters.js+103 -71 Viewed

 const PROMPT_PLACEHOLDER = getConfigValue('promptPlaceholder', 'Let\'s get started.');
 /**
+ * @typedef {object} PromptNames
+ * @property {string} charName Character name
+ * @property {string} userName User name
+ * @property {string[]} groupNames Group member names
+ * @property {function(string): boolean} startsWithGroupName Check if a message starts with a group name
+ */
+/**
+ * Extracts the character name, user name, and group member names from the request.
+ * @param {import('express').Request} request Express request object
+ * @returns {PromptNames} Prompt names
+ */
+export function getPromptNames(request) {
+    return {
+        charName: String(request.body.char_name || ''),
+        userName: String(request.body.user_name || ''),
+        groupNames: Array.isArray(request.body.group_names) ? request.body.group_names.map(String) : [],
+        startsWithGroupName: function (message) {
+            return this.groupNames.some(name => message.startsWith(`${name}: `));
+        },
+    };
+}
+/**
  * Convert a prompt from the ChatML objects to the format used by Claude.
  * Mainly deprecated. Only used for counting tokens.
  * @param {object[]} messages Array of messages

  * @param {string}   prefillString User determined prefill string
  * @param {boolean}  useSysPrompt See if we want to use a system prompt
  * @param {boolean}  useTools See if we want to use tools
- * @param {string}   charName Character name
+ * @param {PromptNames} names Prompt names
- * @param {string}   userName User name
+ * @returns {{messages: object[], systemPrompt: object[]}} Prompt for Anthropic
  */
-export function convertClaudeMessages(messages, prefillString, useSysPrompt, useTools, charName, userName) {
+export function convertClaudeMessages(messages, prefillString, useSysPrompt, useTools, names) {
     let systemPrompt = [];
     if (useSysPrompt) {
         // Collect all the system messages up until the first instance of a non-system message, and then remove them from the messages array.

@@ -104,14 +128,14 @@ export function convertClaudeMessages(messages, prefillString, useSysPrompt, use
104	break;	128	break;
105	}	129	}
106	// Append example names if not already done by the frontend (e.g. for group chats).	130	// Append example names if not already done by the frontend (e.g. for group chats).
107	if (userName && messages[i].name === 'example_user') {	131	if (names.userName && messages[i].name === 'example_user') {
108	if (!messages[i].content.startsWith(`${userName}: `)) {	132	if (!messages[i].content.startsWith(`${names.userName}: `)) {
109	messages[i].content = `${userName}: ${messages[i].content}`;	133	messages[i].content = `${names.userName}: ${messages[i].content}`;
110	}	134	}
111	}	135	}
112	if (charName && messages[i].name === 'example_assistant') {	136	if (names.charName && messages[i].name === 'example_assistant') {
113	if (!messages[i].content.startsWith(`${charName}: `)) {	137	if (!messages[i].content.startsWith(`${names.charName}: `) && !names.startsWithGroupName(messages[i].content)) {
114	messages[i].content = `${charName}: ${messages[i].content}`;	138	messages[i].content = `${names.charName}: ${messages[i].content}`;
115	}	139	}
116	}	140	}
117	systemPrompt.push({ type: 'text', text: messages[i].content });	141	systemPrompt.push({ type: 'text', text: messages[i].content });

+        }
         if (message.role === 'system') {
-            if (userName && message.name === 'example_user') {
+            if (names.userName && message.name === 'example_user') {
-                message.content = `${userName}: ${message.content}`;
+                if (!message.content.startsWith(`${names.userName}: `)) {
+                    message.content = `${names.userName}: ${message.content}`;
+                }
+            }
+            if (names.charName && message.name === 'example_assistant') {
+                if (!message.content.startsWith(`${names.charName}: `) && !names.startsWithGroupName(message.content)) {
+                    message.content = `${names.charName}: ${message.content}`;
+                }
-            if (charName && message.name === 'example_assistant') {
-                message.content = `${charName}: ${message.content}`;
+            }
             message.role = 'user';

 /**
  * Convert a prompt from the ChatML objects to the format used by Cohere.
  * @param {object[]} messages Array of messages
- * @param {string}   charName Character name
+ * @param {PromptNames} names Prompt names
- * @param {string}   userName User name
  * @returns {{chatHistory: object[]}} Prompt for Cohere
  */
-export function convertCohereMessages(messages, charName = '', userName = '') {
+export function convertCohereMessages(messages, names) {
     if (messages.length === 0) {
         messages.unshift({
             role: 'user',

@@ -299,13 +326,13 @@ export function convertCohereMessages(messages, charName = '', userName = '') {
299	// No names support (who would've thought)	326	// No names support (who would've thought)
300	if (msg.name) {	327	if (msg.name) {
301	if (msg.role == 'system' && msg.name == 'example_assistant') {	328	if (msg.role == 'system' && msg.name == 'example_assistant') {
302	if (charName && !msg.content.startsWith(`${charName}: `)) {	329	if (names.charName && !msg.content.startsWith(`${names.charName}: `) && !names.startsWithGroupName(msg.content)) {
303	msg.content = `${charName}: ${msg.content}`;	330	msg.content = `${names.charName}: ${msg.content}`;
304	}	331	}
305	}	332	}
306	if (msg.role == 'system' && msg.name == 'example_user') {	333	if (msg.role == 'system' && msg.name == 'example_user') {
307	if (userName && !msg.content.startsWith(`${userName}: `)) {	334	if (names.userName && !msg.content.startsWith(`${names.userName}: `)) {
308	msg.content = `${userName}: ${msg.content}`;	335	msg.content = `${names.userName}: ${msg.content}`;
309	}	336	}
310	}	337	}
311	if (msg.role !== 'system' && !msg.content.startsWith(`${msg.name}: `)) {	338	if (msg.role !== 'system' && !msg.content.startsWith(`${msg.name}: `)) {

  * @param {object[]} messages Array of messages
  * @param {string} model Model name
  * @param {boolean} useSysPrompt Use system prompt
- * @param {string} charName Character name
+ * @param {PromptNames} names Prompt names
- * @param {string} userName User name
  * @returns {{contents: *[], system_instruction: {parts: {text: string}}}} Prompt for Google MakerSuite models
  */
-export function convertGooglePrompt(messages, model, useSysPrompt = false, charName = '', userName = '') {
+export function convertGooglePrompt(messages, model, useSysPrompt, names) {
     const visionSupportedModels = [
         'gemini-2.0-flash-exp',
         'gemini-1.5-flash',

@@ -356,20 +381,19 @@ export function convertGooglePrompt(messages, model, useSysPrompt = false, charN
356	];	381	];
357		382
358	const isMultimodal = visionSupportedModels.includes(model);	383	const isMultimodal = visionSupportedModels.includes(model);
359	let hasImage = false;
360		384
361	let sys_prompt = '';	385	let sys_prompt = '';
362	if (useSysPrompt) {	386	if (useSysPrompt) {
363	while (messages.length > 1 && messages[0].role === 'system') {	387	while (messages.length > 1 && messages[0].role === 'system') {
364	// Append example names if not already done by the frontend (e.g. for group chats).	388	// Append example names if not already done by the frontend (e.g. for group chats).
365	if (userName && messages[0].name === 'example_user') {	389	if (names.userName && messages[0].name === 'example_user') {
366	if (!messages[0].content.startsWith(`${userName}: `)) {	390	if (!messages[0].content.startsWith(`${names.userName}: `)) {
367	messages[0].content = `${userName}: ${messages[0].content}`;	391	messages[0].content = `${names.userName}: ${messages[0].content}`;
368	}	392	}
369	}	393	}
370	if (charName && messages[0].name === 'example_assistant') {	394	if (names.charName && messages[0].name === 'example_assistant') {
371	if (!messages[0].content.startsWith(`${charName}: `)) {	395	if (!messages[0].content.startsWith(`${names.charName}: `) && !names.startsWithGroupName(messages[0].content)) {
372	messages[0].content = `${charName}: ${messages[0].content}`;	396	messages[0].content = `${names.charName}: ${messages[0].content}`;
373	}	397	}
374	}	398	}
375	sys_prompt += `${messages[0].content}\n\n`;	399	sys_prompt += `${messages[0].content}\n\n`;

             message.role = 'model';
+        }
+        // Convert the content to an array of parts
+        if (!Array.isArray(message.content)) {
+            message.content = [{ type: 'text', text: String(message.content ?? '') }];
+        }
         // similar story as claude
         if (message.name) {
-            if (userName && message.name === 'example_user') {
+            message.content.forEach((part) => {
-                message.name = userName;
+                if (part.type !== 'text') {
+                    return;
+                }
-            if (charName && message.name === 'example_assistant') {
+                if (message.name === 'example_user') {
-                message.name = charName;
+                    if (names.userName && !part.text.startsWith(`${names.userName}: `)) {
+                        part.text = `${names.userName}: ${part.text}`;
+                    }
+                } else if (message.name === 'example_assistant') {
-            if (Array.isArray(message.content)) {
+                    if (names.charName && !part.text.startsWith(`${names.charName}: `) && !names.startsWithGroupName(part.text)) {
-                if (!message.content[0].text.startsWith(`${message.name}: `)) {
+                        part.text = `${names.charName}: ${part.text}`;
-                    message.content[0].text = `${message.name}: ${message.content[0].text}`;
+                    }
                 } else {
-                if (!message.content.startsWith(`${message.name}: `)) {
+                    if (!part.text.startsWith(`${message.name}: `)) {
-                    message.content = `${message.name}: ${message.content}`;
+                        part.text = `${message.name}: ${part.text}`;
+                    }
+                }
+            });
             delete message.name;
+        }
         //create the prompt parts
         const parts = [];
-        if (typeof message.content === 'string') {
-            parts.push({ text: message.content });
-        } else if (Array.isArray(message.content)) {
         message.content.forEach((part) => {
             if (part.type === 'text') {
                 parts.push({ text: part.text });

                         data: base64Data,
                     },
                 });
-                    hasImage = true;
+            }
         });
-        }
         // merge consecutive messages with the same role
         if (index > 0 && message.role === contents[contents.length - 1].role) {
-            contents[contents.length - 1].parts[0].text += '\n\n' + parts[0].text;
+            parts.forEach((part) => {
+                if (part.text) {
+                    contents[contents.length - 1].parts[0].text += '\n\n' + part.text;
+                }
+                if (part.inlineData) {
+                    contents[contents.length - 1].parts.push(part);
+                }
+            });
         } else {
             contents.push({
                 role: message.role,

 /**
  * Convert AI21 prompt. Classic: system message squash, user/assistant message merge.
  * @param {object[]} messages Array of messages
- * @param {string} charName Character name
+ * @param {PromptNames} names Prompt names
- * @param {string} userName User name
+ * @returns {object[]} Prompt for AI21
  */
-export function convertAI21Messages(messages, charName = '', userName = '') {
+export function convertAI21Messages(messages, names) {
     if (!Array.isArray(messages)) {
         return [];
+    }

@@ -465,14 +498,14 @@ export function convertAI21Messages(messages, charName = '', userName = '') {
465	break;	498	break;
466	}	499	}
467	// Append example names if not already done by the frontend (e.g. for group chats).	500	// Append example names if not already done by the frontend (e.g. for group chats).
468	if (userName && messages[i].name === 'example_user') {	501	if (names.userName && messages[i].name === 'example_user') {
469	if (!messages[i].content.startsWith(`${userName}: `)) {	502	if (!messages[i].content.startsWith(`${names.userName}: `)) {
470	messages[i].content = `${userName}: ${messages[i].content}`;	503	messages[i].content = `${names.userName}: ${messages[i].content}`;
471	}	504	}
472	}	505	}
473	if (charName && messages[i].name === 'example_assistant') {	506	if (names.charName && messages[i].name === 'example_assistant') {
474	if (!messages[i].content.startsWith(`${charName}: `)) {	507	if (!messages[i].content.startsWith(`${names.charName}: `) && !names.startsWithGroupName(messages[i].content)) {
475	messages[i].content = `${charName}: ${messages[i].content}`;	508	messages[i].content = `${names.charName}: ${messages[i].content}`;
476	}	509	}
477	}	510	}
478	systemPrompt += `${messages[i].content}\n\n`;	511	systemPrompt += `${messages[i].content}\n\n`;

 /**
  * Convert a prompt from the ChatML objects to the format used by MistralAI.
  * @param {object[]} messages Array of messages
- * @param {string} charName Character name
+ * @param {PromptNames} names Prompt names
- * @param {string} userName User name
+ * @returns {object[]} Prompt for MistralAI
  */
-export function convertMistralMessages(messages, charName = '', userName = '') {
+export function convertMistralMessages(messages, names) {
     if (!Array.isArray(messages)) {
         return [];
+    }

@@ -549,15 +582,15 @@ export function convertMistralMessages(messages, charName = '', userName = '') {
549	msg.tool_call_id = sanitizeToolId(msg.tool_call_id);	582	msg.tool_call_id = sanitizeToolId(msg.tool_call_id);
550	}	583	}
551	if (msg.role === 'system' && msg.name === 'example_assistant') {	584	if (msg.role === 'system' && msg.name === 'example_assistant') {
552	if (charName && !msg.content.startsWith(`${charName}: `)) {	585	if (names.charName && !msg.content.startsWith(`${names.charName}: `) && !names.startsWithGroupName(msg.content)) {
553	msg.content = `${charName}: ${msg.content}`;	586	msg.content = `${names.charName}: ${msg.content}`;
554	}	587	}
555	delete msg.name;	588	delete msg.name;
556	}	589	}
557		590
558	if (msg.role === 'system' && msg.name === 'example_user') {	591	if (msg.role === 'system' && msg.name === 'example_user') {
559	if (userName && !msg.content.startsWith(`${userName}: `)) {	592	if (names.userName && !msg.content.startsWith(`${names.userName}: `)) {
560	msg.content = `${userName}: ${msg.content}`;	593	msg.content = `${names.userName}: ${msg.content}`;
561	}	594	}
562	delete msg.name;	595	delete msg.name;
563	}	596	}

 /**
  * Merge messages with the same consecutive role, removing names if they exist.
  * @param {any[]} messages Messages to merge
- * @param {string} charName Character name
+ * @param {PromptNames} names Prompt names
- * @param {string} userName User name
  * @param {boolean} strict Enable strict mode: only allow one system message at the start, force user first message
  * @returns {any[]} Merged messages
  */
-export function mergeMessages(messages, charName, userName, strict) {
+export function mergeMessages(messages, names, strict) {
     let mergedMessages = [];
     /** @type {Map<string,object>} */

@@ -636,13 +668,13 @@ export function mergeMessages(messages, charName, userName, strict) {
636	message.content = text;	668	message.content = text;
637	}	669	}
638	if (message.role === 'system' && message.name === 'example_assistant') {	670	if (message.role === 'system' && message.name === 'example_assistant') {
639	if (charName && !message.content.startsWith(`${charName}: `)) {	671	if (names.charName && !message.content.startsWith(`${names.charName}: `) && !names.startsWithGroupName(message.content)) {
640	message.content = `${charName}: ${message.content}`;	672	message.content = `${names.charName}: ${message.content}`;
641	}	673	}
642	}	674	}
643	if (message.role === 'system' && message.name === 'example_user') {	675	if (message.role === 'system' && message.name === 'example_user') {
644	if (userName && !message.content.startsWith(`${userName}: `)) {	676	if (names.userName && !message.content.startsWith(`${names.userName}: `)) {
645	message.content = `${userName}: ${message.content}`;	677	message.content = `${names.userName}: ${message.content}`;
646	}	678	}
647	}	679	}
648	if (message.name && message.role !== 'system') {	680	if (message.name && message.role !== 'system') {

@@ -716,7 +748,7 @@ export function mergeMessages(messages, charName, userName, strict) {
716	mergedMessages.unshift({ role: 'user', content: PROMPT_PLACEHOLDER });	748	mergedMessages.unshift({ role: 'user', content: PROMPT_PLACEHOLDER });
717	}	749	}
718	}	750	}
719	return mergeMessages(mergedMessages, charName, userName, false);	751	return mergeMessages(mergedMessages, names, false);
720	}	752	}
721		753
722	return mergedMessages;	754	return mergedMessages;