Add message-role command

1f0c0ccff4bf4fcec6a9685546bb86d5df25e87f

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

Parents: 9a1ded52021229e760e90820293b19344a0ce654

public/scripts/slash-commands.js+91 -1 Viewed

         `,
     }));
     SlashCommandParser.addCommandObject(SlashCommand.fromProps({
+        name: 'message-role',
+        callback: messageRoleCallback,
+        returns: 'The role of the message sender',
+        namedArgumentList: [
+            SlashCommandNamedArgument.fromProps({
+                name: 'at',
+                description: 'the ID of the message to modify (index-based, corresponding to message id). If omitted, the last message is chosen.\nNegative values are accepted and will work similarly to how \'depth\' usually works. For example, -1 will modify the message right before the last message in chat. At must be nonzero.',
+                typeList: [ARGUMENT_TYPE.NUMBER],
+                defaultValue: '',
+                enumProvider: commonEnumProviders.messages({ allowIdAfter: true }),
+            }),
+        ],
+        unnamedArgumentList: [
+            SlashCommandArgument.fromProps({
+                description: 'Role to set for the message sender (user, assistant, system)',
+                typeList: [ARGUMENT_TYPE.STRING],
+                isRequired: false,
+                enumProvider: commonEnumProviders.messageRoles,
+            }),
+        ],
+        helpString: `
+        <div>
+            Changes the role of a message sender to one of your choice.
+            If no role is provided, just gets the current role of the message sender.
+            If no index is provided, the last message is chosen.
+        </div>
+        <div>
+            <strong>Example:</strong>
+            <ul>
+                <li>
+                    <pre><code>/message-role | /echo</code></pre>
+                    Will output the role of the sender of the last message.
+                </li>
+                <li>
+                    <pre><code>/message-role at=-2 assistant</code></pre>
+                    Will change the third message from the bottom to be sent by the assistant.
+                </li>
+            </ul>
+        </div>
+    `,
+    }));
+    SlashCommandParser.addCommandObject(SlashCommand.fromProps({
         name: 'message-name',
         callback: messageNameCallback,
         returns: 'The name of the message sender',

+}
 /**
+ * Changes the character role on a message at a given index.
+ * @param {object?} args - Named arguments
+ * @param {string} role - Role to change to.
+ *
+ * @returns {Promise<string>} The updated message role.
+ */
+async function messageRoleCallback(args, role) {
+    let modifyAt = Number(args?.at ?? (chat.length - 1));
+    // Convert possible depth parameter to index
+    if (!isNaN(modifyAt) && (modifyAt < 0 || Object.is(modifyAt, -0))) {
+        // Negative value means going back from current chat length. (E.g.: 8 messages, Depth 1 means insert at index 7)
+        modifyAt = chat.length + modifyAt;
+    }
+    const message = chat[modifyAt];
+    if (!message) {
+        toastr.warning(t`No message found at the specified index.`);
+        return '';
+    }
+    role = String(role ?? '').trim().toLowerCase();
+    if (!role || !['user', 'assistant', 'system'].includes(role)) {
+        return message?.extra?.type === system_message_types.NARRATOR
+            ? 'system'
+            : message.is_user ? 'user' : 'assistant';
+    }
+    message.extra = message.extra || {};
+    if (role === 'system') {
+        message.extra.type = system_message_types.NARRATOR;
+    } else {
+        delete message.extra.type;
+    }
+    message.is_user = role === 'user';
+    await eventSource.emit(event_types.MESSAGE_EDITED, modifyAt);
+    const existingMessage = chatElement.find(`.mes[mesid="${modifyAt}"]`);
+    if (existingMessage.length) {
+        addOneMessage(message, { forceId: modifyAt, insertAfter: modifyAt, scroll: false });
+        existingMessage.remove();
+    }
+    await eventSource.emit(event_types.MESSAGE_UPDATED, modifyAt);
+    await saveChatConditional();
+    return role;
+}
+/**
  * Changes the character name on a message at a given index.
  * @param {object?} args - Named arguments
  * @param {string} name - Name to change to.
+ *
  * @returns {Promise<string>} The updated message name.
  */
-export async function messageNameCallback(args, name) {
+async function messageNameCallback(args, name) {
     let modifyAt = Number(args?.at ?? (chat.length - 1));
     // Convert possible depth parameter to index
     if (!isNaN(modifyAt) && (modifyAt < 0 || Object.is(modifyAt, -0))) {

public/scripts/slash-commands/SlashCommandCommonEnumsProvider.js+6 -0 Viewed

         new SlashCommandEnumValue('null', null, enumTypes.type, enumIcons.null),
         new SlashCommandEnumValue('undefined', null, enumTypes.type, enumIcons.undefined),
     ],
+    messageRoles: () => [
+        new SlashCommandEnumValue('user', null, enumTypes.enum, enumIcons.user),
+        new SlashCommandEnumValue('assistant', null, enumTypes.enum, enumIcons.assistant),
+        new SlashCommandEnumValue('system', null, enumTypes.enum, enumIcons.system),
+    ],
 };