Merge branch 'staging' into or-prompt-post-processing

This commit is contained in:
Cohee
2025-03-19 19:32:55 +02:00
6 changed files with 97 additions and 34 deletions

View File

@@ -4,7 +4,7 @@ import { characters, eventSource, event_types, generateRaw, getRequestHeaders, m
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';
import { onlyUnique, debounce, getCharaFilename, trimToEndSentence, trimToStartSentence, waitUntilCondition, findChar } from '../../utils.js';
import { onlyUnique, debounce, getCharaFilename, trimToEndSentence, trimToStartSentence, waitUntilCondition, findChar, isFalseBoolean } from '../../utils.js';
import { hideMutedSprites, selected_group } from '../../group-chats.js';
import { isJsonSchemaSupported } from '../../textgen-settings.js';
import { debounce_timeout } from '../../constants.js';
@@ -17,6 +17,7 @@ import { slashCommandReturnHelper } from '../../slash-commands/SlashCommandRetur
import { generateWebLlmChatPrompt, isWebLlmSupported } from '../shared.js';
import { Popup, POPUP_RESULT } from '../../popup.js';
import { t } from '../../i18n.js';
import { removeReasoningFromString } from '../../reasoning.js';
export { MODULE_NAME };
/**
@@ -678,7 +679,7 @@ async function setSpriteFolderCommand(_, folder) {
return '';
}
async function classifyCallback(/** @type {{api: string?, prompt: string?}} */ { api = null, prompt = null }, text) {
async function classifyCallback(/** @type {{api: string?, filter: string?, prompt: string?}} */ { api = null, filter = null, prompt = null }, text) {
if (!text) {
toastr.error('No text provided');
return '';
@@ -689,13 +690,14 @@ async function classifyCallback(/** @type {{api: string?, prompt: string?}} */ {
}
const expressionApi = EXPRESSION_API[api] || extension_settings.expressions.api;
const filterAvailable = !isFalseBoolean(filter);
if (!modules.includes('classify') && expressionApi == EXPRESSION_API.extras) {
toastr.warning('Text classification is disabled or not available');
return '';
}
const label = await getExpressionLabel(text, expressionApi, { customPrompt: prompt });
const label = await getExpressionLabel(text, expressionApi, { filterAvailable: filterAvailable, customPrompt: prompt });
console.debug(`Classification result for "${text}": ${label}`);
return label;
}
@@ -928,6 +930,9 @@ function parseLlmResponse(emotionResponse, labels) {
return response;
} catch {
// Clean possible reasoning from response
emotionResponse = removeReasoningFromString(emotionResponse);
const fuse = new Fuse(labels, { includeScore: true });
console.debug('Using fuzzy search in labels:', labels);
const result = fuse.search(emotionResponse);
@@ -988,10 +993,11 @@ function onTextGenSettingsReady(args) {
* @param {string} text - The text to classify and retrieve the expression label for.
* @param {EXPRESSION_API} [expressionsApi=extension_settings.expressions.api] - The expressions API to use for classification.
* @param {object} [options={}] - Optional arguments.
* @param {boolean?} [options.filterAvailable=null] - Whether to filter available expressions. If not specified, uses the extension setting.
* @param {string?} [options.customPrompt=null] - The custom prompt to use for classification.
* @returns {Promise<string?>} - The label of the expression.
*/
export async function getExpressionLabel(text, expressionsApi = extension_settings.expressions.api, { customPrompt = null } = {}) {
export async function getExpressionLabel(text, expressionsApi = extension_settings.expressions.api, { filterAvailable = null, customPrompt = null } = {}) {
// Return if text is undefined, saving a costly fetch request
if ((!modules.includes('classify') && expressionsApi == EXPRESSION_API.extras) || !text) {
return extension_settings.expressions.fallback_expression;
@@ -1003,6 +1009,11 @@ export async function getExpressionLabel(text, expressionsApi = extension_settin
text = sampleClassifyText(text);
filterAvailable ??= extension_settings.expressions.filterAvailable;
if (filterAvailable && ![EXPRESSION_API.llm, EXPRESSION_API.webllm].includes(expressionsApi)) {
console.debug('Filter available is only supported for LLM and WebLLM expressions');
}
try {
switch (expressionsApi) {
// Local BERT pipeline
@@ -1027,7 +1038,7 @@ export async function getExpressionLabel(text, expressionsApi = extension_settin
return extension_settings.expressions.fallback_expression;
}
const expressionsList = await getExpressionsList();
const expressionsList = await getExpressionsList({ filterAvailable: filterAvailable });
const prompt = substituteParamsExtended(customPrompt, { labels: expressionsList }) || await getLlmPrompt(expressionsList);
eventSource.once(event_types.TEXT_COMPLETION_SETTINGS_READY, onTextGenSettingsReady);
const emotionResponse = await generateRaw(text, main_api, false, false, prompt);
@@ -1040,7 +1051,7 @@ export async function getExpressionLabel(text, expressionsApi = extension_settin
return extension_settings.expressions.fallback_expression;
}
const expressionsList = await getExpressionsList();
const expressionsList = await getExpressionsList({ filterAvailable: filterAvailable });
const prompt = substituteParamsExtended(customPrompt, { labels: expressionsList }) || await getLlmPrompt(expressionsList);
const messages = [
{ role: 'user', content: text + '\n\n' + prompt },
@@ -1320,12 +1331,28 @@ function getCachedExpressions() {
return [...expressionsList, ...extension_settings.expressions.custom].filter(onlyUnique);
}
export async function getExpressionsList() {
// Return cached list if available
if (Array.isArray(expressionsList)) {
return getCachedExpressions();
export async function getExpressionsList({ filterAvailable = false } = {}) {
// If there is no cached list, load and cache it
if (!Array.isArray(expressionsList)) {
expressionsList = await resolveExpressionsList();
}
const expressions = getCachedExpressions();
// Filtering is only available for llm and webllm APIs
if (!filterAvailable || ![EXPRESSION_API.llm, EXPRESSION_API.webllm].includes(extension_settings.expressions.api)) {
return expressions;
}
// Get expressions with available sprites
const currentLastMessage = selected_group ? getLastCharacterMessage() : null;
const spriteFolderName = getSpriteFolderName(currentLastMessage, currentLastMessage?.name);
return expressions.filter(label => {
const expression = spriteCache[spriteFolderName]?.find(x => x.label === label);
return (expression?.files.length ?? 0) > 0;
});
/**
* Returns the list of expressions from the API or fallback in offline mode.
* @returns {Promise<string[]>}
@@ -1372,9 +1399,6 @@ export async function getExpressionsList() {
expressionsList = DEFAULT_EXPRESSIONS.slice();
return expressionsList;
}
const result = await resolveExpressionsList();
return [...result, ...extension_settings.expressions.custom].filter(onlyUnique);
}
/**
@@ -1810,7 +1834,7 @@ async function onClickExpressionUpload(event) {
}
}
} else {
spriteName = withoutExtension(clickedFileName);
spriteName = withoutExtension(expression);
}
if (!spriteName) {
@@ -2102,6 +2126,10 @@ function migrateSettings() {
extension_settings.expressions.rerollIfSame = !!$(this).prop('checked');
saveSettingsDebounced();
});
$('#expressions_filter_available').prop('checked', extension_settings.expressions.filterAvailable).on('input', function () {
extension_settings.expressions.filterAvailable = !!$(this).prop('checked');
saveSettingsDebounced();
});
$('#expression_override_cleanup_button').on('click', onClickExpressionOverrideRemoveAllButton);
$(document).on('dragstart', '.expression', (e) => {
e.preventDefault();
@@ -2279,13 +2307,13 @@ function migrateSettings() {
SlashCommandParser.addCommandObject(SlashCommand.fromProps({
name: 'expression-list',
aliases: ['expressions'],
/** @type {(args: {return: string}) => Promise<string>} */
/** @type {(args: {return: string, filter: string}) => Promise<string>} */
callback: async (args) => {
let returnType =
/** @type {import('../../slash-commands/SlashCommandReturnHelper.js').SlashCommandReturnType} */
(args.return);
const list = await getExpressionsList();
const list = await getExpressionsList({ filterAvailable: !isFalseBoolean(args.filter) });
return await slashCommandReturnHelper.doReturn(returnType ?? 'pipe', list, { objectToStringFunc: list => list.join(', ') });
},
@@ -2298,6 +2326,13 @@ function migrateSettings() {
enumList: slashCommandReturnHelper.enumList({ allowObject: true }),
forceEnum: true,
}),
SlashCommandNamedArgument.fromProps({
name: 'filter',
description: 'Filter the list to only include expressions that have available sprites for the current character.',
typeList: [ARGUMENT_TYPE.BOOLEAN],
enumList: commonEnumProviders.boolean('trueFalse')(),
defaultValue: 'true',
}),
],
returns: 'The comma-separated list of available expressions, including custom expressions.',
helpString: 'Returns a list of available expressions, including custom expressions.',
@@ -2313,6 +2348,13 @@ function migrateSettings() {
typeList: [ARGUMENT_TYPE.STRING],
enumList: Object.keys(EXPRESSION_API).map(api => new SlashCommandEnumValue(api, null, enumTypes.enum)),
}),
SlashCommandNamedArgument.fromProps({
name: 'filter',
description: 'Filter the list to only include expressions that have available sprites for the current character.',
typeList: [ARGUMENT_TYPE.BOOLEAN],
enumList: commonEnumProviders.boolean('trueFalse')(),
defaultValue: 'true',
}),
SlashCommandNamedArgument.fromProps({
name: 'prompt',
description: 'Custom prompt for classification. Only relevant if Classifier API is set to LLM.',

View File

@@ -29,7 +29,11 @@
</select>
</div>
<div class="expression_llm_prompt_block m-b-1 m-t-1">
<label for="expression_llm_prompt" class="title_restorable">
<label class="checkbox_label" for="expressions_filter_available" title="When using LLM or WebLLM classifier, only show and use expressions that have sprites assigned to them." data-i18n="[title]When using LLM or WebLLM classifier, only show and use expressions that have sprites assigned to them.">
<input id="expressions_filter_available" type="checkbox">
<span data-i18n="Filter expressions for available sprites">Filter expressions for available sprites</span>
</label>
<label for="expression_llm_prompt" class="title_restorable m-t-1">
<span data-i18n="LLM Prompt">LLM Prompt</span>
<div id="expression_llm_prompt_restore" title="Restore default value" class="right_menu_button">
<i class="fa-solid fa-clock-rotate-left fa-sm"></i>

View File

@@ -435,16 +435,18 @@ export function getGroupCharacterCards(groupId, characterId) {
* @param {string} value Value to replace
* @param {string} fieldName Name of the field
* @param {string} characterName Name of the character
* @param {boolean} trim Whether to trim the value
* @returns {string} Replaced text
* */
function customBaseChatReplace(value, fieldName, characterName) {
function customBaseChatReplace(value, fieldName, characterName, trim) {
if (!value) {
return '';
}
// We should do the custom field name replacement first, and then run it through the normal macro engine with provided names
value = value.replace(/<FIELDNAME>/gi, fieldName);
return baseChatReplace(value.trim(), name1, characterName);
value = trim ? value.trim() : value;
return baseChatReplace(value, name1, characterName);
}
/**
@@ -467,13 +469,12 @@ export function getGroupCharacterCards(groupId, characterId) {
}
// Prepare and replace prefixes
const prefix = customBaseChatReplace(group.generation_mode_join_prefix, fieldName, characterName);
const suffix = customBaseChatReplace(group.generation_mode_join_suffix, fieldName, characterName);
const separator = power_user.instruct.wrap ? '\n' : '';
const prefix = customBaseChatReplace(group.generation_mode_join_prefix, fieldName, characterName, false);
const suffix = customBaseChatReplace(group.generation_mode_join_suffix, fieldName, characterName, false);
// Also run the macro replacement on the actual content
value = customBaseChatReplace(value, fieldName, characterName);
value = customBaseChatReplace(value, fieldName, characterName, true);
return `${prefix ? prefix + separator : ''}${value}${suffix ? separator + suffix : ''}`;
return `${prefix}${value}${suffix}`;
}
const scenarioOverride = chat_metadata['scenario'];
@@ -904,6 +905,7 @@ async function generateGroupWrapper(by_auto_mode, type = null, params = {}) {
groupChatQueueOrder.set(characters[activatedMembers[i]].avatar, i + 1);
}
}
await eventSource.emit(event_types.GROUP_WRAPPER_STARTED, { selected_group, type });
// now the real generation begins: cycle through every activated character
for (const chId of activatedMembers) {
throwIfAborted();
@@ -942,6 +944,7 @@ async function generateGroupWrapper(by_auto_mode, type = null, params = {}) {
setCharacterName('');
activateSendButtons();
showSwipeButtons();
await eventSource.emit(event_types.GROUP_WRAPPER_FINISHED, { selected_group, type });
}
return Promise.resolve(textResult);