TC: Allow setting null JSON schema (#4746) * TC: Allow setting empty JSON schema * Fix check for llamacpp schema * Handle grammar/schema for Aphrodite * Conditional include for guided_json * Update default presets with null value * Conditional include into payload for grammar/schema

5837f2859977fcdf544f6ed69f67e6c13dc02b99

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

Signed

default/content/presets/textgen/Default.json+1 -1 Viewed

     "guidance_scale": 1,
     "negative_prompt": "",
     "grammar_string": "",
-    "json_schema": {},
+    "json_schema": null,
     "banned_tokens": "",
     "sampler_priority": [
         "repetition_penalty",

default/content/presets/textgen/Deterministic.json+1 -1 Viewed

     "guidance_scale": 1,
     "negative_prompt": "",
     "grammar_string": "",
-    "json_schema": {},
+    "json_schema": null,
     "banned_tokens": "",
     "sampler_priority": [
         "repetition_penalty",

default/content/presets/textgen/Neutral.json+1 -1 Viewed

     "guidance_scale": 1,
     "negative_prompt": "",
     "grammar_string": "",
-    "json_schema": {},
+    "json_schema": null,
     "banned_tokens": "",
     "sampler_priority": [
         "repetition_penalty",

default/content/presets/textgen/Universal-Creative.json+1 -1 Viewed

     "guidance_scale": 1,
     "negative_prompt": "",
     "grammar_string": "",
-    "json_schema": {},
+    "json_schema": null,
     "banned_tokens": "",
     "sampler_priority": [
         "repetition_penalty",

default/content/presets/textgen/Universal-Light.json+1 -1 Viewed

     "guidance_scale": 1,
     "negative_prompt": "",
     "grammar_string": "",
-    "json_schema": {},
+    "json_schema": null,
     "banned_tokens": "",
     "sampler_priority": [
         "repetition_penalty",

default/content/presets/textgen/Universal-Super-Creative.json+1 -1 Viewed

     "guidance_scale": 1,
     "negative_prompt": "",
     "grammar_string": "",
-    "json_schema": {},
+    "json_schema": null,
     "banned_tokens": "",
     "sampler_priority": [
         "repetition_penalty",

public/scripts/textgen-settings.js+24 -17 Viewed

 import { getCurrentDreamGenModelTokenizer, getCurrentOpenRouterModelTokenizer, loadAphroditeModels, loadDreamGenModels, loadFeatherlessModels, loadGenericModels, loadInfermaticAIModels, loadMancerModels, loadOllamaModels, loadOpenRouterModels, loadTabbyModels, loadTogetherAIModels, loadVllmModels } from './textgen-models.js';
 import { ENCODE_TOKENIZERS, TEXTGEN_TOKENIZERS, TOKENIZER_SUPPORTED_KEY, getTextTokens, tokenizers } from './tokenizers.js';
 import { AbortReason } from './util/AbortReason.js';
-import { getSortableDelay, onlyUnique, arraysEqual } from './utils.js';
+import { getSortableDelay, onlyUnique, arraysEqual, isObject } from './utils.js';
 export const textgen_types = {
     OOBA: 'ooba',

     guidance_scale: 1,
     negative_prompt: '',
     grammar_string: '',
-    json_schema: {},
+    json_schema: null,
     banned_tokens: '',
     global_banned_tokens: '',
     send_banned_tokens: true,

     $('#tabby_json_schema').on('input', function () {
         const json_schema_string = String($(this).val());
-        try {
+        if (json_schema_string) {
-            settings.json_schema = JSON.parse(json_schema_string || '{}');
+            try {
-        } catch {
+                settings.json_schema = JSON.parse(json_schema_string);
-            // Ignore errors from here
+            } catch {
+                settings.json_schema = null;
+            }
+        } else {
+            settings.json_schema = null;
+        }
         saveSettingsDebounced();
     });

@@ -1152,8 +1157,8 @@ function setSettingByName(setting, value, trigger) {
1152	}	1157	}
1153		1158
1154	if ('json_schema' === setting) {	1159	if ('json_schema' === setting) {
1155	settings.json_schema = value ?? {};	1160	settings.json_schema = value ?? null;
1156	$('#tabby_json_schema').val(JSON.stringify(settings.json_schema, null, 2));	1161	$('#tabby_json_schema').val(value ? JSON.stringify(settings.json_schema, null, 2) : '');
1157	return;	1162	return;
1158	}	1163	}
1159		1164

         'seed': settings.seed >= 0 ? settings.seed : undefined,
         'guidance_scale': cfgValues?.guidanceScale?.value ?? settings.guidance_scale ?? 1,
         'negative_prompt': cfgValues?.negativePrompt ?? substituteParams(settings.negative_prompt) ?? '',
-        'grammar_string': settings.grammar_string,
+        'grammar_string': settings.grammar_string || undefined,
-        'json_schema': [TABBY, LLAMACPP].includes(settings.type) ? settings.json_schema : undefined,
+        'json_schema': [TABBY, LLAMACPP].includes(settings.type) && settings.json_schema ? settings.json_schema : undefined,
         // llama.cpp aliases. In case someone wants to use LM Studio as Text Completion API
         'repeat_penalty': settings.rep_pen,
         'repeat_last_n': settings.rep_pen_range,

         'min_tokens': settings.min_length,
         'skip_special_tokens': settings.skip_special_tokens,
         'spaces_between_special_tokens': settings.spaces_between_special_tokens,
-        'guided_grammar': settings.grammar_string,
+        'guided_grammar': settings.grammar_string || undefined,
-        'guided_json': settings.json_schema,
+        'guided_json': settings.json_schema || undefined,
         'early_stopping': false, // hacks
         'include_stop_str_in_output': false,
         'dynatemp_min': dynatemp ? settings.min_temp : undefined,

@@ -1622,7 +1627,7 @@ export async function getTextGenGenerationData(finalPrompt, maxTokens, isImperso
1622	}	1627	}
1623		1628
1624	if (settings.type === KOBOLDCPP) {	1629	if (settings.type === KOBOLDCPP) {
1625	params.grammar = settings.grammar_string;	1630	params.grammar = settings.grammar_string \|\| undefined;
1626	params.trim_stop = true;	1631	params.trim_stop = true;
1627	}	1632	}
1628		1633

@@ -1691,17 +1696,19 @@ export async function getTextGenGenerationData(finalPrompt, maxTokens, isImperso
1691	}	1696	}
1692	}	1697	}
1693		1698
1694	await eventSource.emit(event_types.TEXT_COMPLETION_SETTINGS_READY, params);
1695
1696	// Grammar conflicts with with json_schema	1699	// Grammar conflicts with with json_schema
1697	if (settings.type === LLAMACPP) {	1700	if ([LLAMACPP, APHRODITE].includes(settings.type)) {
1698	if (params.json_schema && Object.keys(params.json_schema).length > 0) {	1701	if (settings.json_schema && isObject(settings.json_schema)) {
1699	delete params.grammar_string;	1702	delete params.grammar_string;
1700	delete params.grammar;	1703	delete params.grammar;
		1704	delete params.guided_grammar;
1701	} else {	1705	} else {
1702	delete params.json_schema;	1706	delete params.json_schema;
		1707	delete params.guided_json;
1703	}	1708	}
1704	}	1709	}
1705		1710
		1711	await eventSource.emit(event_types.TEXT_COMPLETION_SETTINGS_READY, params);
		1712
1706	return params;	1713	return params;
1707	}	1714	}

public/scripts/utils.js+1 -1 Viewed

  * @param {any} item The item to check.
  * @returns {boolean} True if the item is an object, false otherwise.
  */
-function isObject(item) {
+export function isObject(item) {
     return (item && typeof item === 'object' && !Array.isArray(item));
+}