Adds sprite-based filtering for expressions - Functionality only available for LLM/webLLM - New toggle to filter expressions on availalbe sprites - `getExpressionsList` filters cached expressions when checked (using sprite folder name/override) - `/expression-list` slash command has "filter" arg to filter list - `/expression-classify` slash command has "filter" arg now, to use filtered list for classification - `getExpressionLabel` uses filtered expressions when LLM/webLLM

5a6058d319196c5e8326678ea177f17ec2bf4ade

Wolfsblvt <wolfsblvt@gmail.com>

Parents: 8366b7de60883b139f78260ba4b63423a22541d8
2 files changed, +58 -16Ignore whitespace
public/scripts/extensions/expressions/index.js+53 -15
@@ -4,7 +4,7 @@ import { characters, eventSource, event_types, generateRaw, getRequestHeaders, m
44import { dragElement, isMobile } from '../../RossAscends-mods.js';
55import { getContext, getApiUrl, modules, extension_settings, ModuleWorkerWrapper, doExtrasFetch, renderExtensionTemplateAsync } from '../../extensions.js';
66import { loadMovingUIState, performFuzzySearch, power_user } from '../../power-user.js';
77import { onlyUnique, debounce, getCharaFilename, trimToEndSentence, trimToStartSentence, waitUntilCondition, findChar, isTrueBoolean } from '../../utils.js';
88import { hideMutedSprites, selected_group } from '../../group-chats.js';
99import { isJsonSchemaSupported } from '../../textgen-settings.js';
1010import { debounce_timeout } from '../../constants.js';
@@ -678,7 +678,7 @@ async function setSpriteFolderCommand(_, folder) {
678678 return '';
679679}
680680
681681async function classifyCallback(/** @type {{api: string?, filter: string?, prompt: string?}} */ { api = null, filter = null, prompt = null }, text) {
682682 if (!text) {
683683 toastr.error('No text provided');
684684 return '';
@@ -689,13 +689,14 @@ async function classifyCallback(/** @type {{api: string?, prompt: string?}} */ {
689689 }
690690
691691 const expressionApi = EXPRESSION_API[api] || extension_settings.expressions.api;
692+ const filterAvailable = isTrueBoolean(filter);
692693
693694 if (!modules.includes('classify') && expressionApi == EXPRESSION_API.extras) {
694695 toastr.warning('Text classification is disabled or not available');
695696 return '';
696697 }
697698
698699 const label = await getExpressionLabel(text, expressionApi, { filterAvailable: filterAvailable, customPrompt: prompt });
699700 console.debug(`Classification result for "${text}": ${label}`);
700701 return label;
701702}
@@ -988,10 +989,11 @@ function onTextGenSettingsReady(args) {
988989 * @param {string} text - The text to classify and retrieve the expression label for.
989990 * @param {EXPRESSION_API} [expressionsApi=extension_settings.expressions.api] - The expressions API to use for classification.
990991 * @param {object} [options={}] - Optional arguments.
992+ * @param {boolean?} [options.filterAvailable=null] - Whether to filter available expressions. If not specified, uses the extension setting.
991993 * @param {string?} [options.customPrompt=null] - The custom prompt to use for classification.
992994 * @returns {Promise<string?>} - The label of the expression.
993995 */
994996export async function getExpressionLabel(text, expressionsApi = extension_settings.expressions.api, { filterAvailable = null, customPrompt = null } = {}) {
995997 // Return if text is undefined, saving a costly fetch request
996998 if ((!modules.includes('classify') && expressionsApi == EXPRESSION_API.extras) || !text) {
997999 return extension_settings.expressions.fallback_expression;
@@ -1003,6 +1005,11 @@ export async function getExpressionLabel(text, expressionsApi = extension_settin
10031005
10041006 text = sampleClassifyText(text);
10051007
1008+ filterAvailable ??= extension_settings.expressions.filterAvailable;
1009+ if (filterAvailable && ![EXPRESSION_API.llm, EXPRESSION_API.webllm].includes(expressionsApi)) {
1010+ console.warn('Filter available is only supported for LLM and WebLLM expressions');
1011+ }
1012+
10061013 try {
10071014 switch (expressionsApi) {
10081015 // Local BERT pipeline
@@ -1027,7 +1034,7 @@ export async function getExpressionLabel(text, expressionsApi = extension_settin
10271034 return extension_settings.expressions.fallback_expression;
10281035 }
10291036
10301037 const expressionsList = await getExpressionsList({ filterAvailable: filterAvailable });
10311038 const prompt = substituteParamsExtended(customPrompt, { labels: expressionsList }) || await getLlmPrompt(expressionsList);
10321039 eventSource.once(event_types.TEXT_COMPLETION_SETTINGS_READY, onTextGenSettingsReady);
10331040 const emotionResponse = await generateRaw(text, main_api, false, false, prompt);
@@ -1040,7 +1047,7 @@ export async function getExpressionLabel(text, expressionsApi = extension_settin
10401047 return extension_settings.expressions.fallback_expression;
10411048 }
10421049
10431050 const expressionsList = await getExpressionsList({ filterAvailable: filterAvailable });
10441051 const prompt = substituteParamsExtended(customPrompt, { labels: expressionsList }) || await getLlmPrompt(expressionsList);
10451052 const messages = [
10461053 { role: 'user', content: text + '\n\n' + prompt },
@@ -1320,12 +1327,28 @@ function getCachedExpressions() {
13201327 return [...expressionsList, ...extension_settings.expressions.custom].filter(onlyUnique);
13211328}
13221329
13231330export async function getExpressionsList({ filterAvailable = false } = {}) {
13241331 // ReturnIf there is no cached list, ifload availableand cache it
13251332 if (!Array.isArray(expressionsList)) {
13261333 returnexpressionsList getCachedExpressions= await resolveExpressionsList();
13271334 }
13281335
1336+ const expressions = getCachedExpressions();
1337+
1338+ // Filtering is only available for llm and webllm APIs
1339+ if (!filterAvailable || ![EXPRESSION_API.llm, EXPRESSION_API.webllm].includes(extension_settings.expressions.api)) {
1340+ return expressions;
1341+ }
1342+
1343+ // Get expressions with available sprites
1344+ const currentLastMessage = selected_group ? getLastCharacterMessage() : null;
1345+ const spriteFolderName = getSpriteFolderName(currentLastMessage, currentLastMessage?.name);
1346+
1347+ return expressions.filter(label => {
1348+ const expression = spriteCache[spriteFolderName]?.find(x => x.label === label);
1349+ return (expression?.files.length ?? 0) > 0;
1350+ });
1351+
13291352 /**
13301353 * Returns the list of expressions from the API or fallback in offline mode.
13311354 * @returns {Promise<string[]>}
@@ -1372,9 +1395,6 @@ export async function getExpressionsList() {
13721395 expressionsList = DEFAULT_EXPRESSIONS.slice();
13731396 return expressionsList;
13741397 }
1375-
1376- const result = await resolveExpressionsList();
1377- return [...result, ...extension_settings.expressions.custom].filter(onlyUnique);
13781398}
13791399
13801400/**
@@ -2102,6 +2122,10 @@ function migrateSettings() {
21022122 extension_settings.expressions.rerollIfSame = !!$(this).prop('checked');
21032123 saveSettingsDebounced();
21042124 });
2125+ $('#expressions_filter_available').prop('checked', extension_settings.expressions.filterAvailable).on('input', function () {
2126+ extension_settings.expressions.filterAvailable = !!$(this).prop('checked');
2127+ saveSettingsDebounced();
2128+ });
21052129 $('#expression_override_cleanup_button').on('click', onClickExpressionOverrideRemoveAllButton);
21062130 $(document).on('dragstart', '.expression', (e) => {
21072131 e.preventDefault();
@@ -2279,13 +2303,13 @@ function migrateSettings() {
22792303 SlashCommandParser.addCommandObject(SlashCommand.fromProps({
22802304 name: 'expression-list',
22812305 aliases: ['expressions'],
22822306 /** @type {(args: {return: string, filterAvailable: string}) => Promise<string>} */
22832307 callback: async (args) => {
22842308 let returnType =
22852309 /** @type {import('../../slash-commands/SlashCommandReturnHelper.js').SlashCommandReturnType} */
22862310 (args.return);
22872311
22882312 const list = await getExpressionsList({ filterAvailable: isTrueBoolean(args.filterAvailable) });
22892313
22902314 return await slashCommandReturnHelper.doReturn(returnType ?? 'pipe', list, { objectToStringFunc: list => list.join(', ') });
22912315 },
@@ -2298,6 +2322,13 @@ function migrateSettings() {
22982322 enumList: slashCommandReturnHelper.enumList({ allowObject: true }),
22992323 forceEnum: true,
23002324 }),
2325+ SlashCommandNamedArgument.fromProps({
2326+ name: 'filter',
2327+ description: 'Filter the list to only include expressions that have available sprites for the current character.',
2328+ typeList: [ARGUMENT_TYPE.BOOLEAN],
2329+ enumList: commonEnumProviders.boolean('trueFalse')(),
2330+ defaultValue: 'true',
2331+ }),
23012332 ],
23022333 returns: 'The comma-separated list of available expressions, including custom expressions.',
23032334 helpString: 'Returns a list of available expressions, including custom expressions.',
@@ -2314,6 +2345,13 @@ function migrateSettings() {
23142345 enumList: Object.keys(EXPRESSION_API).map(api => new SlashCommandEnumValue(api, null, enumTypes.enum)),
23152346 }),
23162347 SlashCommandNamedArgument.fromProps({
2348+ name: 'filter',
2349+ description: 'Filter the list to only include expressions that have available sprites for the current character.',
2350+ typeList: [ARGUMENT_TYPE.BOOLEAN],
2351+ enumList: commonEnumProviders.boolean('trueFalse')(),
2352+ defaultValue: 'true',
2353+ }),
2354+ SlashCommandNamedArgument.fromProps({
23172355 name: 'prompt',
23182356 description: 'Custom prompt for classification. Only relevant if Classifier API is set to LLM.',
23192357 typeList: [ARGUMENT_TYPE.STRING],
public/scripts/extensions/expressions/settings.html+5 -1
@@ -29,7 +29,11 @@
2929 </select>
3030 </div>
3131 <div class="expression_llm_prompt_block m-b-1 m-t-1">
32- <label for="expression_llm_prompt" class="title_restorable">
32+ <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.">
33+ <input id="expressions_filter_available" type="checkbox">
34+ <span data-i18n="Filter expressions for available sprites">Filter expressions for available sprites</span>
35+ </label>
36+ <label for="expression_llm_prompt" class="title_restorable m-t-1">
3337 <span data-i18n="LLM Prompt">LLM Prompt</span>
3438 <div id="expression_llm_prompt_restore" title="Restore default value" class="right_menu_button">
3539 <i class="fa-solid fa-clock-rotate-left fa-sm"></i>