File size: 45,795 Bytes
c120a1c |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 |
import { Fuse, lodash } from '../lib.js';
import {
amount_gen,
characters,
eventSource,
event_types,
getRequestHeaders,
koboldai_setting_names,
koboldai_settings,
main_api,
max_context,
nai_settings,
novelai_setting_names,
novelai_settings,
online_status,
saveSettings,
saveSettingsDebounced,
this_chid,
} from '../script.js';
import { groups, selected_group } from './group-chats.js';
import { t } from './i18n.js';
import { instruct_presets } from './instruct-mode.js';
import { kai_settings } from './kai-settings.js';
import { convertNovelPreset } from './nai-settings.js';
import { oai_settings, openai_setting_names, openai_settings } from './openai.js';
import { POPUP_RESULT, POPUP_TYPE, Popup } from './popup.js';
import { context_presets, getContextSettings, power_user } from './power-user.js';
import { reasoning_templates } from './reasoning.js';
import { SlashCommand } from './slash-commands/SlashCommand.js';
import { ARGUMENT_TYPE, SlashCommandArgument } from './slash-commands/SlashCommandArgument.js';
import { enumIcons } from './slash-commands/SlashCommandCommonEnumsProvider.js';
import { SlashCommandEnumValue, enumTypes } from './slash-commands/SlashCommandEnumValue.js';
import { SlashCommandParser } from './slash-commands/SlashCommandParser.js';
import { checkForSystemPromptInInstructTemplate, system_prompts } from './sysprompt.js';
import { renderTemplateAsync } from './templates.js';
import {
textgenerationwebui_settings as textgen_settings,
textgenerationwebui_preset_names,
textgenerationwebui_presets,
} from './textgen-settings.js';
import { download, ensurePlainObject, equalsIgnoreCaseAndAccents, getSanitizedFilename, parseJsonFile, waitUntilCondition } from './utils.js';
const presetManagers = {};
/**
* Automatically select a preset for current API based on character or group name.
*/
function autoSelectPreset() {
const presetManager = getPresetManager();
if (!presetManager) {
console.debug(`Preset Manager not found for API: ${main_api}`);
return;
}
const name = selected_group ? groups.find(x => x.id == selected_group)?.name : characters[this_chid]?.name;
if (!name) {
console.debug(`Preset candidate not found for API: ${main_api}`);
return;
}
const preset = presetManager.findPreset(name);
const selectedPreset = presetManager.getSelectedPreset();
if (preset === selectedPreset) {
console.debug(`Preset already selected for API: ${main_api}, name: ${name}`);
return;
}
if (preset !== undefined && preset !== null) {
console.log(`Preset found for API: ${main_api}, name: ${name}`);
presetManager.selectPreset(preset);
}
}
/**
* Gets a preset manager by API id.
* @param {string} apiId API id
* @returns {PresetManager} Preset manager
*/
export function getPresetManager(apiId = '') {
if (apiId === 'koboldhorde') {
apiId = 'kobold';
}
if (!apiId) {
apiId = main_api == 'koboldhorde' ? 'kobold' : main_api;
}
if (!Object.keys(presetManagers).includes(apiId)) {
return null;
}
return presetManagers[apiId];
}
/**
* Registers preset managers for all select elements with data-preset-manager-for attribute.
*/
function registerPresetManagers() {
$('select[data-preset-manager-for]').each((_, e) => {
const forData = $(e).data('preset-manager-for');
for (const apiId of forData.split(',')) {
console.debug(`Registering preset manager for API: ${apiId}`);
presetManagers[apiId] = new PresetManager($(e), apiId);
}
});
}
class PresetManager {
constructor(select, apiId) {
this.select = select;
this.apiId = apiId;
}
static masterSections = {
'instruct': {
name: 'Instruct Template',
getData: () => {
const manager = getPresetManager('instruct');
const name = manager.getSelectedPresetName();
return manager.getPresetSettings(name);
},
setData: (data) => {
const manager = getPresetManager('instruct');
const name = data.name;
return manager.savePreset(name, data);
},
isValid: (data) => PresetManager.isPossiblyInstructData(data),
},
'context': {
name: 'Context Template',
getData: () => {
const manager = getPresetManager('context');
const name = manager.getSelectedPresetName();
return manager.getPresetSettings(name);
},
setData: (data) => {
const manager = getPresetManager('context');
const name = data.name;
return manager.savePreset(name, data);
},
isValid: (data) => PresetManager.isPossiblyContextData(data),
},
'sysprompt': {
name: 'System Prompt',
getData: () => {
const manager = getPresetManager('sysprompt');
const name = manager.getSelectedPresetName();
return manager.getPresetSettings(name);
},
setData: (data) => {
const manager = getPresetManager('sysprompt');
const name = data.name;
return manager.savePreset(name, data);
},
isValid: (data) => PresetManager.isPossiblySystemPromptData(data),
},
'preset': {
name: 'Text Completion Preset',
getData: () => {
const manager = getPresetManager('textgenerationwebui');
const name = manager.getSelectedPresetName();
const data = manager.getPresetSettings(name);
data['name'] = name;
return data;
},
setData: (data) => {
const manager = getPresetManager('textgenerationwebui');
const name = data.name;
return manager.savePreset(name, data);
},
isValid: (data) => PresetManager.isPossiblyTextCompletionData(data),
},
'reasoning': {
name: 'Reasoning Formatting',
getData: () => {
const manager = getPresetManager('reasoning');
const name = manager.getSelectedPresetName();
return manager.getPresetSettings(name);
},
setData: (data) => {
const manager = getPresetManager('reasoning');
const name = data.name;
return manager.savePreset(name, data);
},
isValid: (data) => PresetManager.isPossiblyReasoningData(data),
},
'srw': {
name: 'Start Reply With',
getData: () => {
return {
value: power_user.user_prompt_bias ?? '',
show: power_user.show_user_prompt_bias ?? false,
};
},
setData: (data) => {
power_user.user_prompt_bias = data.value ?? '';
power_user.show_user_prompt_bias = data.show ?? false;
$('#start_reply_with').val(power_user.user_prompt_bias);
$('#chat-show-reply-prefix-checkbox').prop('checked', power_user.show_user_prompt_bias);
return saveSettingsDebounced();
},
isValid: (data) => PresetManager.isPossiblyStartReplyWithData(data),
},
};
static isPossiblyInstructData(data) {
const instructProps = ['name', 'input_sequence', 'output_sequence'];
return data && instructProps.every(prop => Object.keys(data).includes(prop));
}
static isPossiblyContextData(data) {
const contextProps = ['name', 'story_string'];
return data && contextProps.every(prop => Object.keys(data).includes(prop));
}
static isPossiblySystemPromptData(data) {
const sysPromptProps = ['name', 'content'];
return data && sysPromptProps.every(prop => Object.keys(data).includes(prop));
}
static isPossiblyTextCompletionData(data) {
const textCompletionProps = ['temp', 'top_k', 'top_p', 'rep_pen'];
return data && textCompletionProps.every(prop => Object.keys(data).includes(prop));
}
static isPossiblyReasoningData(data) {
const reasoningProps = ['name', 'prefix', 'suffix', 'separator'];
return data && reasoningProps.every(prop => Object.keys(data).includes(prop));
}
static isPossiblyStartReplyWithData(data) {
return data && 'value' in data && 'show' in data;
}
/**
* Imports master settings from JSON data.
* @param {object} data Data to import
* @param {string} fileName File name
* @returns {Promise<void>}
*/
static async performMasterImport(data, fileName) {
if (!data || typeof data !== 'object') {
toastr.error(t`Invalid data provided for master import`);
return;
}
// Check for legacy file imports
// 1. Instruct Template
if (this.isPossiblyInstructData(data)) {
toastr.info(t`Importing instruct template...`, t`Instruct template detected`);
return await getPresetManager('instruct').savePreset(data.name, data);
}
// 2. Context Template
if (this.isPossiblyContextData(data)) {
toastr.info(t`Importing as context template...`, t`Context template detected`);
return await getPresetManager('context').savePreset(data.name, data);
}
// 3. System Prompt
if (this.isPossiblySystemPromptData(data)) {
toastr.info(t`Importing as system prompt...`, t`System prompt detected`);
return await getPresetManager('sysprompt').savePreset(data.name, data);
}
// 4. Text Completion settings
if (this.isPossiblyTextCompletionData(data)) {
toastr.info(t`Importing as settings preset...`, t`Text Completion settings detected`);
return await getPresetManager('textgenerationwebui').savePreset(fileName, data);
}
// 5. Reasoning Template
if (this.isPossiblyReasoningData(data)) {
toastr.info(t`Importing as reasoning template...`, t`Reasoning template detected`);
return await getPresetManager('reasoning').savePreset(data.name, data);
}
const validSections = [];
for (const [key, section] of Object.entries(this.masterSections)) {
if (key in data && section.isValid(data[key])) {
validSections.push(key);
}
}
if (validSections.length === 0) {
toastr.error(t`No valid sections found in imported data`);
return;
}
const sectionNames = validSections.reduce((acc, key) => {
acc[key] = { key: key, name: this.masterSections[key].name, preset: data[key]?.name || '' };
return acc;
}, {});
const html = $(await renderTemplateAsync('masterImport', { sections: sectionNames }));
const popup = new Popup(html, POPUP_TYPE.CONFIRM, '', {
okButton: t`Import`,
cancelButton: t`Cancel`,
});
const result = await popup.show();
// Import cancelled
if (result !== POPUP_RESULT.AFFIRMATIVE) {
return;
}
const importedSections = [];
const confirmedSections = html.find('input:checked').map((_, el) => el instanceof HTMLInputElement && el.value).get();
if (confirmedSections.length === 0) {
toastr.info(t`No sections selected for import`);
return;
}
for (const section of confirmedSections) {
const sectionData = data[section];
const masterSection = this.masterSections[section];
if (sectionData && masterSection) {
await masterSection.setData(sectionData);
importedSections.push(masterSection.name);
}
}
toastr.success(t`Imported ${importedSections.length} settings: ${importedSections.join(', ')}`);
}
/**
* Exports master settings to JSON data.
* @returns {Promise<string>} JSON data
*/
static async performMasterExport() {
const sectionNames = Object.entries(this.masterSections).reduce((acc, [key, section]) => {
acc[key] = { key: key, name: section.name, checked: !['preset', 'srw'].includes(key) };
return acc;
}, {});
const html = $(await renderTemplateAsync('masterExport', { sections: sectionNames }));
const popup = new Popup(html, POPUP_TYPE.CONFIRM, '', {
okButton: t`Export`,
cancelButton: t`Cancel`,
});
const result = await popup.show();
// Export cancelled
if (result !== POPUP_RESULT.AFFIRMATIVE) {
return;
}
const confirmedSections = html.find('input:checked').map((_, el) => el instanceof HTMLInputElement && el.value).get();
const data = {};
if (confirmedSections.length === 0) {
toastr.info(t`No sections selected for export`);
return;
}
for (const section of confirmedSections) {
const masterSection = this.masterSections[section];
if (masterSection) {
data[section] = masterSection.getData();
}
}
return JSON.stringify(data, null, 4);
}
/**
* Gets all preset names.
* @returns {string[]} List of preset names
*/
getAllPresets() {
return $(this.select).find('option').map((_, el) => el.text).toArray();
}
/**
* Finds a preset by name.
* @param {string} name Preset name
* @returns {any} Preset value
*/
findPreset(name) {
return $(this.select).find('option').filter(function () {
return $(this).text() === name;
}).val();
}
/**
* Gets the selected preset value.
* @returns {any} Selected preset value
*/
getSelectedPreset() {
return $(this.select).find('option:selected').val();
}
/**
* Gets the selected preset name.
* @returns {string} Selected preset name
*/
getSelectedPresetName() {
return $(this.select).find('option:selected').text();
}
/**
* Selects a preset by option value.
* @param {string} value Preset option value
*/
selectPreset(value) {
const option = $(this.select).filter(function () {
return $(this).val() === value;
});
option.prop('selected', true);
$(this.select).val(value).trigger('change');
}
/**
* Updates the preset select element with the current API presets.
* @param {object} [options] Options for saving the preset
* @param {boolean} [options.skipUpdate=false] If true, skips updating the preset list after saving.
*/
async updatePreset(option = { skipUpdate: false }) {
const selected = $(this.select).find('option:selected');
console.log(selected);
if (selected.val() == 'gui') {
toastr.info(t`Cannot update GUI preset`);
return;
}
const name = selected.text();
await this.savePreset(name, null, option);
const successToast = !this.isAdvancedFormatting() ? t`Preset updated` : t`Template updated`;
toastr.success(successToast);
}
/**
* Saves the currently selected preset with a new name.
*/
async savePresetAs() {
const inputValue = this.getSelectedPresetName();
const popupText = !this.isAdvancedFormatting() ? '<h4>' + t`Hint: Use a character/group name to bind preset to a specific chat.` + '</h4>' : '';
const headerText = !this.isAdvancedFormatting() ? t`Preset name:` : t`Template name:`;
const name = await Popup.show.input(headerText, popupText, inputValue);
if (!name) {
console.log('Preset name not provided');
return;
}
await this.savePreset(name);
const successToast = !this.isAdvancedFormatting() ? t`Preset saved` : t`Template saved`;
toastr.success(successToast);
}
/**
* Saves a preset with the given name and settings.
* @param {string} name Name of the preset to save
* @param {object} [settings] Settings to save as the preset. If not provided, uses the current preset settings.
* @param {object} [options] Options for saving the preset
* @param {boolean} [options.skipUpdate=false] If true, skips updating the preset list after saving.
*/
async savePreset(name, settings, { skipUpdate = false } = {}) {
if (this.apiId === 'instruct' && settings) {
await checkForSystemPromptInInstructTemplate(name, settings);
}
if (this.apiId === 'novel' && settings) {
settings = convertNovelPreset(settings);
}
const preset = settings ?? this.getPresetSettings(name);
const response = await fetch('/api/presets/save', {
method: 'POST',
headers: getRequestHeaders(),
body: JSON.stringify({ preset, name, apiId: this.apiId }),
});
if (!response.ok) {
toastr.error(t`Check the server connection and reload the page to prevent data loss.`, t`Preset could not be saved`);
console.error('Preset could not be saved', response);
throw new Error('Preset could not be saved');
}
const data = await response.json();
name = data.name;
if (skipUpdate) {
console.debug(`Preset ${name} saved, but not updating the list`);
return;
}
this.updateList(name, preset);
}
/**
* Renames the currently selected preset.
* @param {string} newName New name for the preset
*/
async renamePreset(newName) {
const oldName = this.getSelectedPresetName();
if (equalsIgnoreCaseAndAccents(oldName, newName)) {
throw new Error('New name must be different from old name');
}
try {
await this.savePreset(newName);
await this.deletePreset(oldName);
} catch (error) {
toastr.error(t`Check the server connection and reload the page to prevent data loss.`, t`Preset could not be renamed`);
console.error('Preset could not be renamed', error);
throw new Error('Preset could not be renamed');
}
}
/**
* Gets a list of presets for the API.
* @param {string} [api] API ID. If not specified, uses the current API ID.
* @returns {{presets: any[], preset_names: object, settings: object}}
*/
getPresetList(api) {
let presets = [];
let preset_names = {};
let settings = {};
// If no API specified, use the current API
if (api === undefined) {
api = this.apiId;
}
switch (api) {
case 'koboldhorde':
case 'kobold':
presets = koboldai_settings;
preset_names = koboldai_setting_names;
settings = kai_settings;
break;
case 'novel':
presets = novelai_settings;
preset_names = novelai_setting_names;
settings = nai_settings;
break;
case 'textgenerationwebui':
presets = textgenerationwebui_presets;
preset_names = textgenerationwebui_preset_names;
settings = textgen_settings;
break;
case 'openai':
presets = openai_settings;
preset_names = openai_setting_names;
settings = oai_settings;
break;
case 'context':
presets = context_presets;
preset_names = context_presets.map(x => x.name);
settings = power_user.context;
break;
case 'instruct':
presets = instruct_presets;
preset_names = instruct_presets.map(x => x.name);
settings = power_user.instruct;
break;
case 'sysprompt':
presets = system_prompts;
preset_names = system_prompts.map(x => x.name);
settings = power_user.sysprompt;
break;
case 'reasoning':
presets = reasoning_templates;
preset_names = reasoning_templates.map(x => x.name);
settings = power_user.reasoning;
break;
default:
console.warn(`Unknown API ID ${api}`);
}
return { presets, preset_names, settings };
}
/**
* Returns true if the API is keyed, meaning it uses a name to identify presets.
*/
isKeyedApi() {
return this.apiId == 'textgenerationwebui' || this.isAdvancedFormatting();
}
/**
* Returns true if the API is from Advanced Formatting group.
*/
isAdvancedFormatting() {
return ['context', 'instruct', 'sysprompt', 'reasoning'].includes(this.apiId);
}
/**
* Updates the preset list with a new or existing preset.
* @param {string} name Name of the preset
* @param {object} preset Preset object
*/
updateList(name, preset) {
const { presets, preset_names } = this.getPresetList();
const presetExists = this.isKeyedApi() ? preset_names.includes(name) : Object.keys(preset_names).includes(name);
if (presetExists) {
if (this.isKeyedApi()) {
presets[preset_names.indexOf(name)] = preset;
$(this.select).find(`option[value="${name}"]`).prop('selected', true);
$(this.select).val(name).trigger('change');
}
else {
const value = preset_names[name];
presets[value] = preset;
$(this.select).find(`option[value="${value}"]`).prop('selected', true);
$(this.select).val(value).trigger('change');
}
}
else {
presets.push(preset);
const value = presets.length - 1;
if (this.isKeyedApi()) {
preset_names[value] = name;
const option = $('<option></option>', { value: name, text: name, selected: true });
$(this.select).append(option);
$(this.select).val(name).trigger('change');
} else {
preset_names[name] = value;
const option = $('<option></option>', { value: value, text: name, selected: true });
$(this.select).append(option);
$(this.select).val(value).trigger('change');
}
}
}
/**
* Gets the preset settings for the given name.
* @param {string} name Name of the preset
* @returns {object} Preset settings object for the given name
*/
getPresetSettings(name) {
function getSettingsByApiId(apiId) {
switch (apiId) {
case 'koboldhorde':
case 'kobold':
return kai_settings;
case 'novel':
return nai_settings;
case 'textgenerationwebui':
return textgen_settings;
case 'context': {
const context_preset = getContextSettings();
context_preset['name'] = name || power_user.context.preset;
return context_preset;
}
case 'instruct': {
const instruct_preset = structuredClone(power_user.instruct);
instruct_preset['name'] = name || power_user.instruct.preset;
return instruct_preset;
}
case 'sysprompt': {
const sysprompt_preset = structuredClone(power_user.sysprompt);
sysprompt_preset['name'] = name || power_user.sysprompt.preset;
return sysprompt_preset;
}
case 'reasoning': {
const reasoning_preset = structuredClone(power_user.reasoning);
reasoning_preset['name'] = name || power_user.reasoning.preset;
return reasoning_preset;
}
default:
console.warn(`Unknown API ID ${apiId}`);
return {};
}
}
const filteredKeys = [
'api_server',
'preset',
'streaming',
'truncation_length',
'n',
'streaming_url',
'stopping_strings',
'can_use_tokenization',
'can_use_streaming',
'preset_settings_novel',
'preset_settings',
'streaming_novel',
'nai_preamble',
'model_novel',
'streaming_kobold',
'enabled',
'bind_to_context',
'seed',
'legacy_api',
'mancer_model',
'togetherai_model',
'ollama_model',
'vllm_model',
'aphrodite_model',
'server_urls',
'type',
'custom_model',
'bypass_status_check',
'infermaticai_model',
'dreamgen_model',
'openrouter_model',
'featherless_model',
'max_tokens_second',
'openrouter_providers',
'openrouter_allow_fallbacks',
'tabby_model',
'derived',
'generic_model',
'include_reasoning',
'global_banned_tokens',
'send_banned_tokens',
// Reasoning exclusions
'auto_parse',
'add_to_prompts',
'auto_expand',
'show_hidden',
'max_additions',
];
const settings = Object.assign({}, getSettingsByApiId(this.apiId));
for (const key of filteredKeys) {
if (Object.hasOwn(settings, key)) {
delete settings[key];
}
}
if (!this.isAdvancedFormatting() && this.apiId !== 'openai') {
settings['genamt'] = amount_gen;
settings['max_length'] = max_context;
}
return settings;
}
/**
* Retrieves a completion preset by name.
* @param {string} name Name of the preset to retrieve
* @returns {any} Preset object if found, otherwise undefined
*/
getCompletionPresetByName(name) {
// Retrieve a completion preset by name. Return undefined if not found.
let { presets, preset_names } = this.getPresetList();
let preset;
// Some APIs use an array of names, others use an object of {name: index}
if (Array.isArray(preset_names)) { // array of names
if (preset_names.includes(name)) {
preset = presets[preset_names.indexOf(name)];
}
} else { // object of {names: index}
if (preset_names[name] !== undefined) {
preset = presets[preset_names[name]];
}
}
if (preset === undefined) {
console.error(`Preset ${name} not found`);
}
// if the preset isn't found, returns undefined
return preset;
}
/**
* Deletes a preset by name. If not provided, deletes the currently selected preset.
* @param {string} [name] Name of the preset to delete.
*/
async deletePreset(name) {
const { preset_names, presets } = this.getPresetList();
const value = name ? (this.isKeyedApi() ? this.findPreset(name) : name) : this.getSelectedPreset();
const nameToDelete = name || this.getSelectedPresetName();
if (value == 'gui') {
toastr.info(t`Cannot delete GUI preset`);
return;
}
if (this.isKeyedApi()) {
$(this.select).find(`option[value="${value}"]`).remove();
const index = preset_names.indexOf(nameToDelete);
preset_names.splice(index, 1);
presets.splice(index, 1);
} else {
const index = preset_names[nameToDelete];
$(this.select).find(`option[value="${index}"]`).remove();
delete preset_names[nameToDelete];
}
// switch in UI only when deleting currently selected preset
const switchPresets = !name || this.getSelectedPresetName() == name;
if (Object.keys(preset_names).length && switchPresets) {
const nextPresetName = Object.keys(preset_names)[0];
const newValue = preset_names[nextPresetName];
$(this.select).find(`option[value="${newValue}"]`).attr('selected', 'true');
$(this.select).trigger('change');
}
const response = await fetch('/api/presets/delete', {
method: 'POST',
headers: getRequestHeaders(),
body: JSON.stringify({ name: nameToDelete, apiId: this.apiId }),
});
return response.ok;
}
/**
* Retrieves the default preset for the API from the server.
* @param {string} name Name of the preset to restore
* @returns {Promise<any>} Default preset object, or undefined if the request fails
*/
async getDefaultPreset(name) {
const response = await fetch('/api/presets/restore', {
method: 'POST',
headers: getRequestHeaders(),
body: JSON.stringify({ name, apiId: this.apiId }),
});
if (!response.ok) {
const errorToast = !this.isAdvancedFormatting() ? t`Failed to restore default preset` : t`Failed to restore default template`;
toastr.error(errorToast);
return;
}
return await response.json();
}
/**
* Reads a preset extension field from the preset.
* @param {object} options
* @param {string} [options.name] Name of the preset. If not provided, uses the currently selected preset name.
* @param {string} options.path Path to the preset extension field, e.g. 'myextension.data'. If empty, reads the entire extensions object.
* @return {any} The value of the preset extension field, or null if not found.
*/
readPresetExtensionField({ name, path }) {
const { settings } = this.getPresetList();
const selectedName = this.getSelectedPresetName();
const presetName = name || selectedName;
// Read from settings if the selected preset is the same as the provided name
if (settings && selectedName === presetName) {
const settingsExtensions = ensurePlainObject(settings.extensions || {});
return path ? lodash.get(settingsExtensions, path, null) : settingsExtensions;
}
// Otherwise, read from the preset by name
const preset = this.getCompletionPresetByName(presetName);
if (!preset) {
return null;
}
const presetExtensions = ensurePlainObject(preset.extensions || {});
const value = path ? lodash.get(presetExtensions, path, null) : presetExtensions;
return value;
}
/**
* Writes a value to a preset extension field.
* @param {object} options
* @param {string} [options.name] Name of the preset. If not provided, uses the currently selected preset name.
* @param {string} options.path Path to the preset extension field, e.g. 'myextension.data'. If empty, writes to the root of the extensions object.
* @param {any} options.value Value to write to the preset extension field.
* @return {Promise<void>} Resolves when the preset is saved.
*/
async writePresetExtensionField({ name, path, value }) {
const { settings } = this.getPresetList();
const selectedName = this.getSelectedPresetName();
const presetName = name || selectedName;
// Write to settings if the selected preset is the same as the provided name
if (settings && selectedName === presetName) {
// Set the value at the specified path
settings.extensions = ensurePlainObject(settings.extensions || {});
path ? lodash.set(settings.extensions, path, value) : (settings.extensions = value);
await saveSettings();
}
// Also update the preset by name
const preset = this.getCompletionPresetByName(presetName);
if (!preset) {
return;
}
// Set the value at the specified path
preset.extensions = ensurePlainObject(preset.extensions || {});
path ? lodash.set(preset.extensions, path, value) : (preset.extensions = value);
// Save the updated preset
await this.savePreset(presetName, preset, { skipUpdate: true });
}
}
/**
* Selects a preset by name for current API.
* @param {any} _ Named arguments
* @param {string} name Unnamed arguments
* @returns {Promise<string>} Selected or current preset name
*/
async function presetCommandCallback(_, name) {
const shouldReconnect = online_status !== 'no_connection';
const presetManager = getPresetManager();
const allPresets = presetManager.getAllPresets();
const currentPreset = presetManager.getSelectedPresetName();
if (!presetManager) {
console.debug(`Preset Manager not found for API: ${main_api}`);
return '';
}
if (!name) {
console.log('No name provided for /preset command, using current preset');
return currentPreset;
}
if (!Array.isArray(allPresets) || allPresets.length === 0) {
console.log(`No presets found for API: ${main_api}`);
return currentPreset;
}
// Find exact match
const exactMatch = allPresets.find(p => p.toLowerCase().trim() === name.toLowerCase().trim());
if (exactMatch) {
console.log('Found exact preset match', exactMatch);
if (currentPreset !== exactMatch) {
const presetValue = presetManager.findPreset(exactMatch);
if (presetValue) {
presetManager.selectPreset(presetValue);
shouldReconnect && await waitForConnection();
}
}
return exactMatch;
} else {
// Find fuzzy match
const fuse = new Fuse(allPresets);
const fuzzyMatch = fuse.search(name);
if (!fuzzyMatch.length) {
console.warn(`WARN: Preset found with name ${name}`);
return currentPreset;
}
const fuzzyPresetName = fuzzyMatch[0].item;
const fuzzyPresetValue = presetManager.findPreset(fuzzyPresetName);
if (fuzzyPresetValue) {
console.log('Found fuzzy preset match', fuzzyPresetName);
if (currentPreset !== fuzzyPresetName) {
presetManager.selectPreset(fuzzyPresetValue);
shouldReconnect && await waitForConnection();
}
}
return fuzzyPresetName;
}
}
/**
* Waits for API connection to be established.
*/
async function waitForConnection() {
try {
await waitUntilCondition(() => online_status !== 'no_connection', 10000, 100);
} catch {
console.log('Timeout waiting for API to connect');
}
}
export async function initPresetManager() {
eventSource.on(event_types.CHAT_CHANGED, autoSelectPreset);
registerPresetManagers();
SlashCommandParser.addCommandObject(SlashCommand.fromProps({
name: 'preset',
callback: presetCommandCallback,
returns: 'current preset',
unnamedArgumentList: [
SlashCommandArgument.fromProps({
description: 'name',
typeList: [ARGUMENT_TYPE.STRING],
enumProvider: () => getPresetManager().getAllPresets().map(preset => new SlashCommandEnumValue(preset, null, enumTypes.enum, enumIcons.preset)),
}),
],
helpString: `
<div>
Sets a preset by name for the current API. Gets the current preset if no name is provided.
</div>
<div>
<strong>Example:</strong>
<ul>
<li>
<pre><code>/preset myPreset</code></pre>
</li>
<li>
<pre><code>/preset</code></pre>
</li>
</ul>
</div>
`,
}));
$(document).on('click', '[data-preset-manager-update]', async function () {
const apiId = $(this).data('preset-manager-update');
const presetManager = getPresetManager(apiId);
if (!presetManager) {
console.warn(`Preset Manager not found for API: ${apiId}`);
return;
}
await presetManager.updatePreset();
});
$(document).on('click', '[data-preset-manager-new]', async function () {
const apiId = $(this).data('preset-manager-new');
const presetManager = getPresetManager(apiId);
if (!presetManager) {
console.warn(`Preset Manager not found for API: ${apiId}`);
return;
}
await presetManager.savePresetAs();
});
$(document).on('click', '[data-preset-manager-rename]', async function () {
const apiId = $(this).data('preset-manager-rename');
const presetManager = getPresetManager(apiId);
if (!presetManager) {
console.warn(`Preset Manager not found for API: ${apiId}`);
return;
}
const popupHeader = !presetManager.isAdvancedFormatting() ? t`Rename preset` : t`Rename template`;
const oldName = presetManager.getSelectedPresetName();
const newName = await getSanitizedFilename(await Popup.show.input(popupHeader, t`Enter a new name:`, oldName) || '');
if (!newName || oldName === newName) {
console.debug(!presetManager.isAdvancedFormatting() ? 'Preset rename cancelled' : 'Template rename cancelled');
return;
}
if (equalsIgnoreCaseAndAccents(oldName, newName)) {
toastr.warning(t`Name not accepted, as it is the same as before (ignoring case and accents).`, t`Rename Preset`);
return;
}
await eventSource.emit(event_types.PRESET_RENAMED_BEFORE, { apiId: apiId, oldName: oldName, newName: newName });
const extensions = presetManager.readPresetExtensionField({ name: oldName, path: '' });
await presetManager.renamePreset(newName);
await presetManager.writePresetExtensionField({ name: newName, path: '', value: extensions });
await eventSource.emit(event_types.PRESET_RENAMED, { apiId: apiId, oldName: oldName, newName: newName });
if (apiId === 'openai') {
// This is a horrible mess, but prevents the renamed preset from being corrupted.
$('#update_oai_preset').trigger('click');
return;
}
const successToast = !presetManager.isAdvancedFormatting() ? t`Preset renamed` : t`Template renamed`;
toastr.success(successToast);
});
$(document).on('click', '[data-preset-manager-export]', async function () {
const apiId = $(this).data('preset-manager-export');
const presetManager = getPresetManager(apiId);
if (!presetManager) {
console.warn(`Preset Manager not found for API: ${apiId}`);
return;
}
const selected = $(presetManager.select).find('option:selected');
const name = selected.text();
const preset = presetManager.getPresetSettings(name);
const data = JSON.stringify(preset, null, 4);
download(data, `${name}.json`, 'application/json');
});
$(document).on('click', '[data-preset-manager-import]', async function () {
const apiId = $(this).data('preset-manager-import');
$(`[data-preset-manager-file="${apiId}"]`).trigger('click');
});
$(document).on('change', '[data-preset-manager-file]', async function (e) {
const apiId = $(this).data('preset-manager-file');
const presetManager = getPresetManager(apiId);
if (!presetManager) {
console.warn(`Preset Manager not found for API: ${apiId}`);
return;
}
const file = e.target.files[0];
if (!file) {
return;
}
const fileName = file.name.replace('.json', '').replace('.settings', '');
const data = await parseJsonFile(file);
const name = data?.name ?? fileName;
data['name'] = name;
await presetManager.savePreset(name, data);
const successToast = !presetManager.isAdvancedFormatting() ? t`Preset imported` : t`Template imported`;
toastr.success(successToast);
e.target.value = null;
});
$(document).on('click', '[data-preset-manager-delete]', async function () {
const apiId = $(this).data('preset-manager-delete');
const presetManager = getPresetManager(apiId);
if (!presetManager) {
console.warn(`Preset Manager not found for API: ${apiId}`);
return;
}
const headerText = !presetManager.isAdvancedFormatting() ? t`Delete this preset?` : t`Delete this template?`;
const confirm = await Popup.show.confirm(headerText, t`This action is irreversible and your current settings will be overwritten.`);
if (!confirm) {
return;
}
const name = presetManager.getSelectedPresetName();
const result = await presetManager.deletePreset();
if (result) {
const successToast = !presetManager.isAdvancedFormatting() ? t`Preset deleted` : t`Template deleted`;
toastr.success(successToast);
await eventSource.emit(event_types.PRESET_DELETED, { apiId, name });
} else {
const warningToast = !presetManager.isAdvancedFormatting() ? t`Preset was not deleted from server` : t`Template was not deleted from server`;
toastr.warning(warningToast);
}
saveSettingsDebounced();
});
$(document).on('click', '[data-preset-manager-restore]', async function () {
const apiId = $(this).data('preset-manager-restore');
const presetManager = getPresetManager(apiId);
if (!presetManager) {
console.warn(`Preset Manager not found for API: ${apiId}`);
return;
}
const name = presetManager.getSelectedPresetName();
const data = await presetManager.getDefaultPreset(name);
if (name == 'gui') {
toastr.info(t`Cannot restore GUI preset`);
return;
}
if (!data) {
return;
}
if (data.isDefault) {
if (Object.keys(data.preset).length === 0) {
const errorToast = !presetManager.isAdvancedFormatting() ? t`Default preset cannot be restored` : t`Default template cannot be restored`;
toastr.error(errorToast);
return;
}
const confirmText = !presetManager.isAdvancedFormatting()
? t`Resetting a <b>default preset</b> will restore the default settings.`
: t`Resetting a <b>default template</b> will restore the default settings.`;
const confirm = await Popup.show.confirm(t`Are you sure?`, confirmText);
if (!confirm) {
return;
}
await presetManager.deletePreset();
await presetManager.savePreset(name, data.preset);
const option = presetManager.findPreset(name);
presetManager.selectPreset(option);
const successToast = !presetManager.isAdvancedFormatting() ? t`Default preset restored` : t`Default template restored`;
toastr.success(successToast);
} else {
const confirmText = !presetManager.isAdvancedFormatting()
? t`Resetting a <b>custom preset</b> will restore to the last saved state.`
: t`Resetting a <b>custom template</b> will restore to the last saved state.`;
const confirm = await Popup.show.confirm(t`Are you sure?`, confirmText);
if (!confirm) {
return;
}
const option = presetManager.findPreset(name);
presetManager.selectPreset(option);
const successToast = !presetManager.isAdvancedFormatting() ? t`Preset restored` : t`Template restored`;
toastr.success(successToast);
}
});
$('#af_master_import').on('click', () => {
$('#af_master_import_file').trigger('click');
});
$('#af_master_import_file').on('change', async function (e) {
if (!(e.target instanceof HTMLInputElement)) {
return;
}
const file = e.target.files[0];
if (!file) {
return;
}
const data = await parseJsonFile(file);
const fileName = file.name.replace('.json', '');
await PresetManager.performMasterImport(data, fileName);
e.target.value = null;
});
$('#af_master_export').on('click', async () => {
const data = await PresetManager.performMasterExport();
if (!data) {
return;
}
const shortDate = new Date().toISOString().split('T')[0];
download(data, `ST-formatting-${shortDate}.json`, 'application/json');
});
}
|