vv-ai-prompt-format 3.0.0

package/dist/src/toPromtOptions.js

@@ -0,0 +1,252 @@
+import { CheckJsonSchema } from './checkJsonSchema.js';
+import { ConvertJsonSchemaToGbnf } from './convertJsonSchemaToGbnf.js';
+/**
+ * Converts universal prompt options to OpenAI API format.
+ *
+ * @param options - Universal TPromtOptions object
+ * @param jsonresponse - Optional JSON Schema grammar string for structured output via OpenAI response_format
+ * @returns Options object formatted for OpenAI API with snake_case parameter names
+ *
+ * @remarks
+ * Performs the following conversions:
+ * - `topP` → `top_p`
+ * - `maxTokens` → `max_tokens`
+ * - `frequencyPenalty` → `frequency_penalty`
+ * - `presencePenalty` → `presence_penalty`
+ * - `stopSequences` → `stop` (only if non-empty)
+ * - `tokenBias` → `logit_bias` (only if non-empty)
+ * - If `jsonresponse` parameter is provided and valid JSON Schema, creates OpenAI `response_format` object
+ * - Invalid or empty `jsonresponse` is ignored
+ * - Other parameters: `temperature`, `seed` (unchanged)
+ *
+ * @example
+ * ```typescript
+ * const options: TPromtOptions = {
+ *   temperature: 0.7,
+ *   topP: 0.9,
+ *   maxTokens: 2048,
+ *   frequencyPenalty: 0.5
+ * }
+ * const jsonresponse = '{"type": "object", "properties": {"name": {"type": "string"}}}'
+ * const openaiOptions = ToPromtOptionsOpenAi(options, jsonresponse)
+ * // Returns: {
+ * //   temperature: 0.7,
+ * //   top_p: 0.9,
+ * //   max_tokens: 2048,
+ * //   frequency_penalty: 0.5,
+ * //   response_format: {
+ * //     type: "json_schema",
+ * //     json_schema: {
+ * //       name: "response",
+ * //       strict: true,
+ * //       schema: { type: "object", properties: { name: { type: "string" } } }
+ * //     }
+ * //   }
+ * // }
+ * ```
+ */
+export function ToPromtOptionsOpenAi(options, jsonresponse) {
+    const result = {};
+    if (options.temperature !== undefined)
+        result.temperature = options.temperature;
+    if (options.topP !== undefined)
+        result.top_p = options.topP;
+    if (options.maxTokens !== undefined)
+        result.max_tokens = options.maxTokens;
+    if (options.frequencyPenalty !== undefined)
+        result.frequency_penalty = options.frequencyPenalty;
+    if (options.presencePenalty !== undefined)
+        result.presence_penalty = options.presencePenalty;
+    if (options.seed !== undefined)
+        result.seed = options.seed;
+    if (options.stopSequences !== undefined && options.stopSequences.length > 0) {
+        result.stop = options.stopSequences;
+    }
+    if (options.tokenBias !== undefined && Object.keys(options.tokenBias).length > 0) {
+        result.logit_bias = options.tokenBias;
+    }
+    if (jsonresponse) {
+        const validationError = CheckJsonSchema(jsonresponse);
+        if (!validationError) {
+            try {
+                const schema = JSON.parse(jsonresponse);
+                result.response_format = {
+                    type: 'json_schema',
+                    json_schema: {
+                        name: 'response',
+                        strict: true,
+                        schema: schema
+                    }
+                };
+            }
+            catch (_a) {
+                // Ignore jsonresponse if parsing fails
+            }
+        }
+    }
+    return result;
+}
+/**
+ * Converts universal prompt options to Ollama API format.
+ *
+ * @param options - Universal TPromtOptions object
+ * @returns Options object formatted for Ollama API with snake_case parameter names
+ *
+ * @remarks
+ * Performs the following conversions:
+ * - `topP` → `top_p`
+ * - `topK` → `top_k`
+ * - `minP` → `min_p`
+ * - `maxTokens` → `num_predict`
+ * - `repeatPenalty` → `repeat_penalty`
+ * - `repeatPenaltyNum` → `repeat_last_n`
+ * - `mirostatTau` → `mirostat_tau`
+ * - `mirostatEta` → `mirostat_eta`
+ * - `stopSequences` → `stop` (only if non-empty)
+ * - `penalizeNewline` → `penalize_newline`
+ * - Other parameters: `temperature`, `mirostat`, `seed` (unchanged)
+ *
+ * @example
+ * ```typescript
+ * const options: TPromtOptions = {
+ *   temperature: 0.8,
+ *   topK: 40,
+ *   maxTokens: 512,
+ *   mirostat: 2,
+ *   mirostatTau: 5.0
+ * }
+ * const ollamaOptions = ToPromtOptionsOllama(options)
+ * // Returns: { temperature: 0.8, top_k: 40, num_predict: 512, mirostat: 2, mirostat_tau: 5.0 }
+ * ```
+ */
+export function ToPromtOptionsOllama(options) {
+    const result = {};
+    if (options.temperature !== undefined)
+        result.temperature = options.temperature;
+    if (options.topP !== undefined)
+        result.top_p = options.topP;
+    if (options.topK !== undefined)
+        result.top_k = options.topK;
+    if (options.minP !== undefined)
+        result.min_p = options.minP;
+    if (options.maxTokens !== undefined)
+        result.num_predict = options.maxTokens;
+    if (options.repeatPenalty !== undefined)
+        result.repeat_penalty = options.repeatPenalty;
+    if (options.repeatPenaltyNum !== undefined)
+        result.repeat_last_n = options.repeatPenaltyNum;
+    if (options.mirostat !== undefined)
+        result.mirostat = options.mirostat;
+    if (options.mirostatTau !== undefined)
+        result.mirostat_tau = options.mirostatTau;
+    if (options.mirostatEta !== undefined)
+        result.mirostat_eta = options.mirostatEta;
+    if (options.seed !== undefined)
+        result.seed = options.seed;
+    if (options.stopSequences !== undefined && options.stopSequences.length > 0) {
+        result.stop = options.stopSequences;
+    }
+    if (options.penalizeNewline !== undefined)
+        result.penalize_newline = options.penalizeNewline;
+    return result;
+}
+/**
+ * Converts universal prompt options to node-llama-cpp API format.
+ *
+ * @param options - Universal TPromtOptions object
+ * @param jsonresponse - Optional JSON Schema string to convert to GBNF format
+ * @returns Options object formatted for node-llama-cpp API with camelCase parameter names
+ *
+ * @remarks
+ * Performs the following conversions:
+ * - `trimWhitespace` → `trimWhitespaceSuffix`
+ * - `stopSequences` → `customStopTriggers` (only if non-empty)
+ * - `tokenBias` → `tokenBias` (only if non-empty)
+ * - Combines multiple penalty parameters into `repeatPenalty` object:
+ *   - `repeatPenalty` → `repeatPenalty.penalty`
+ *   - `repeatPenaltyNum` → `repeatPenalty.lastTokens`
+ *   - `frequencyPenalty` → `repeatPenalty.frequencyPenalty`
+ *   - `presencePenalty` → `repeatPenalty.presencePenalty`
+ *   - `penalizeNewline` → `repeatPenalty.penalizeNewLine`
+ * - If `jsonresponse` parameter is provided, converts JSON Schema to GBNF format
+ * - Other parameters remain in camelCase: `temperature`, `topP`, `topK`, `minP`, `maxTokens`, `seed`, `evaluationPriority`, `contextShiftSize`, `disableContextShift`
+ *
+ * @example
+ * ```typescript
+ * const options: TPromtOptions = {
+ *   temperature: 0.7,
+ *   topP: 0.9,
+ *   maxTokens: 1024,
+ *   repeatPenalty: 1.1,
+ *   repeatPenaltyNum: 64,
+ *   frequencyPenalty: 0.5
+ * }
+ * const jsonresponse = '{"type": "object", "properties": {"name": {"type": "string"}}}'
+ * const llamaCppOptions = ToPromtOptionsLlamaCpp(options, jsonresponse)
+ * // Returns: {
+ * //   temperature: 0.7,
+ * //   topP: 0.9,
+ * //   maxTokens: 1024,
+ * //   repeatPenalty: {
+ * //     penalty: 1.1,
+ * //     lastTokens: 64,
+ * //     frequencyPenalty: 0.5
+ * //   },
+ * //   grammar: <grammar by jsonresponse>
+ * // }
+ * ```
+ */
+export function ToPromtOptionsLlamaCpp(options, jsonresponse) {
+    const result = {};
+    if (options.temperature !== undefined)
+        result.temperature = options.temperature;
+    if (options.topP !== undefined)
+        result.topP = options.topP;
+    if (options.topK !== undefined)
+        result.topK = options.topK;
+    if (options.minP !== undefined)
+        result.minP = options.minP;
+    if (options.maxTokens !== undefined)
+        result.maxTokens = options.maxTokens;
+    if (options.seed !== undefined)
+        result.seed = options.seed;
+    if (options.trimWhitespace !== undefined)
+        result.trimWhitespaceSuffix = options.trimWhitespace;
+    if (options.stopSequences !== undefined && options.stopSequences.length > 0) {
+        result.customStopTriggers = options.stopSequences;
+    }
+    if (options.tokenBias !== undefined && Object.keys(options.tokenBias).length > 0) {
+        result.tokenBias = options.tokenBias;
+    }
+    if (options.evaluationPriority !== undefined)
+        result.evaluationPriority = options.evaluationPriority;
+    if (options.contextShiftSize !== undefined)
+        result.contextShiftSize = options.contextShiftSize;
+    if (options.disableContextShift !== undefined)
+        result.disableContextShift = options.disableContextShift;
+    const hasRepeatPenalty = options.repeatPenalty !== undefined ||
+        options.repeatPenaltyNum !== undefined ||
+        options.frequencyPenalty !== undefined ||
+        options.presencePenalty !== undefined ||
+        options.penalizeNewline !== undefined;
+    if (hasRepeatPenalty) {
+        result.repeatPenalty = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, (options.repeatPenalty !== undefined && { penalty: options.repeatPenalty })), (options.repeatPenaltyNum !== undefined && { lastTokens: options.repeatPenaltyNum })), (options.frequencyPenalty !== undefined && { frequencyPenalty: options.frequencyPenalty })), (options.presencePenalty !== undefined && { presencePenalty: options.presencePenalty })), (options.penalizeNewline !== undefined && { penalizeNewLine: options.penalizeNewline }));
+    }
+    if (jsonresponse) {
+        const validationError = CheckJsonSchema(jsonresponse);
+        if (!validationError) {
+            try {
+                const schema = JSON.parse(jsonresponse);
+                const converted = ConvertJsonSchemaToGbnf(schema);
+                if ('result' in converted) {
+                    result.grammar = converted.result;
+                }
+            }
+            catch (_a) {
+                // Ignore jsonresponse if parsing fails
+            }
+        }
+    }
+    return result;
+}
+//# sourceMappingURL=toPromtOptions.js.map

package/dist/src/toPromtOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"toPromtOptions.js","sourceRoot":"","sources":["../../src/toPromtOptions.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAA;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAM,UAAU,oBAAoB,CAAC,OAAsB,EAAE,YAAqB;IACjF,MAAM,MAAM,GAAwB,EAAE,CAAA;IAEtC,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS;QAAE,MAAM,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAA;IAC/E,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;QAAE,MAAM,CAAC,KAAK,GAAG,OAAO,CAAC,IAAI,CAAA;IAC3D,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS;QAAE,MAAM,CAAC,UAAU,GAAG,OAAO,CAAC,SAAS,CAAA;IAC1E,IAAI,OAAO,CAAC,gBAAgB,KAAK,SAAS;QAAE,MAAM,CAAC,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAA;IAC/F,IAAI,OAAO,CAAC,eAAe,KAAK,SAAS;QAAE,MAAM,CAAC,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAA;IAC5F,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;QAAE,MAAM,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA;IAC1D,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,IAAI,OAAO,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7E,MAAM,CAAC,IAAI,GAAG,OAAO,CAAC,aAAa,CAAA;IACpC,CAAC;IACD,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAClF,MAAM,CAAC,UAAU,GAAG,OAAO,CAAC,SAAS,CAAA;IACtC,CAAC;IAED,IAAI,YAAY,EAAE,CAAC;QAClB,MAAM,eAAe,GAAG,eAAe,CAAC,YAAY,CAAC,CAAA;QACrD,IAAI,CAAC,eAAe,EAAE,CAAC;YACtB,IAAI,CAAC;gBACJ,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAA;gBACvC,MAAM,CAAC,eAAe,GAAG;oBACxB,IAAI,EAAE,aAAa;oBACnB,WAAW,EAAE;wBACZ,IAAI,EAAE,UAAU;wBAChB,MAAM,EAAE,IAAI;wBACZ,MAAM,EAAE,MAAM;qBACd;iBACD,CAAA;YACF,CAAC;YAAC,WAAM,CAAC;gBACR,uCAAuC;YACxC,CAAC;QACF,CAAC;IACF,CAAC;IAED,OAAO,MAAM,CAAA;AACd,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,UAAU,oBAAoB,CAAC,OAAsB;IAC1D,MAAM,MAAM,GAAwB,EAAE,CAAA;IAEtC,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS;QAAE,MAAM,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAA;IAC/E,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;QAAE,MAAM,CAAC,KAAK,GAAG,OAAO,CAAC,IAAI,CAAA;IAC3D,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;QAAE,MAAM,CAAC,KAAK,GAAG,OAAO,CAAC,IAAI,CAAA;IAC3D,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;QAAE,MAAM,CAAC,KAAK,GAAG,OAAO,CAAC,IAAI,CAAA;IAC3D,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS;QAAE,MAAM,CAAC,WAAW,GAAG,OAAO,CAAC,SAAS,CAAA;IAC3E,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS;QAAE,MAAM,CAAC,cAAc,GAAG,OAAO,CAAC,aAAa,CAAA;IACtF,IAAI,OAAO,CAAC,gBAAgB,KAAK,SAAS;QAAE,MAAM,CAAC,aAAa,GAAG,OAAO,CAAC,gBAAgB,CAAA;IAC3F,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS;QAAE,MAAM,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;IACtE,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS;QAAE,MAAM,CAAC,YAAY,GAAG,OAAO,CAAC,WAAW,CAAA;IAChF,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS;QAAE,MAAM,CAAC,YAAY,GAAG,OAAO,CAAC,WAAW,CAAA;IAChF,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;QAAE,MAAM,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA;IAC1D,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,IAAI,OAAO,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7E,MAAM,CAAC,IAAI,GAAG,OAAO,CAAC,aAAa,CAAA;IACpC,CAAC;IACD,IAAI,OAAO,CAAC,eAAe,KAAK,SAAS;QAAE,MAAM,CAAC,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAA;IAE5F,OAAO,MAAM,CAAA;AACd,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAM,UAAU,sBAAsB,CAAC,OAAsB,EAAE,YAAqB;IACnF,MAAM,MAAM,GAA0B,EAAE,CAAA;IAExC,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS;QAAE,MAAM,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAA;IAC/E,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;QAAE,MAAM,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA;IAC1D,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;QAAE,MAAM,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA;IAC1D,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;QAAE,MAAM,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA;IAC1D,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS;QAAE,MAAM,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAA;IACzE,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;QAAE,MAAM,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA;IAC1D,IAAI,OAAO,CAAC,cAAc,KAAK,SAAS;QAAE,MAAM,CAAC,oBAAoB,GAAG,OAAO,CAAC,cAAc,CAAA;IAC9F,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,IAAI,OAAO,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7E,MAAM,CAAC,kBAAkB,GAAG,OAAO,CAAC,aAAa,CAAA;IAClD,CAAC;IACD,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAClF,MAAM,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAA;IACrC,CAAC;IACD,IAAI,OAAO,CAAC,kBAAkB,KAAK,SAAS;QAAE,MAAM,CAAC,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAA;IACpG,IAAI,OAAO,CAAC,gBAAgB,KAAK,SAAS;QAAE,MAAM,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAA;IAC9F,IAAI,OAAO,CAAC,mBAAmB,KAAK,SAAS;QAAE,MAAM,CAAC,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAA;IAEvG,MAAM,gBAAgB,GAAG,OAAO,CAAC,aAAa,KAAK,SAAS;QAC3D,OAAO,CAAC,gBAAgB,KAAK,SAAS;QACtC,OAAO,CAAC,gBAAgB,KAAK,SAAS;QACtC,OAAO,CAAC,eAAe,KAAK,SAAS;QACrC,OAAO,CAAC,eAAe,KAAK,SAAS,CAAA;IAEtC,IAAI,gBAAgB,EAAE,CAAC;QACtB,MAAM,CAAC,aAAa,6EAChB,CAAC,OAAO,CAAC,aAAa,KAAK,SAAS,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,aAAa,EAAE,CAAC,GAC3E,CAAC,OAAO,CAAC,gBAAgB,KAAK,SAAS,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,gBAAgB,EAAE,CAAC,GACpF,CAAC,OAAO,CAAC,gBAAgB,KAAK,SAAS,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,gBAAgB,EAAE,CAAC,GAC1F,CAAC,OAAO,CAAC,eAAe,KAAK,SAAS,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,eAAe,EAAE,CAAC,GACvF,CAAC,OAAO,CAAC,eAAe,KAAK,SAAS,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,eAAe,EAAE,CAAC,CAC1F,CAAA;IACF,CAAC;IAED,IAAI,YAAY,EAAE,CAAC;QAClB,MAAM,eAAe,GAAG,eAAe,CAAC,YAAY,CAAC,CAAA;QACrD,IAAI,CAAC,eAAe,EAAE,CAAC;YACtB,IAAI,CAAC;gBACJ,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAA;gBACvC,MAAM,SAAS,GAAG,uBAAuB,CAAC,MAAM,CAAC,CAAA;gBACjD,IAAI,QAAQ,IAAI,SAAS,EAAE,CAAC;oBAC3B,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC,MAAM,CAAA;gBAClC,CAAC;YACF,CAAC;YAAC,WAAM,CAAC;gBACR,uCAAuC;YACxC,CAAC;QACF,CAAC;IACF,CAAC;IAED,OAAO,MAAM,CAAA;AACd,CAAC"}

package/dist/test/index.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.test.d.ts.map

package/dist/test/index.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../../test/index.test.ts"],"names":[],"mappings":""}