@promptbook/core 0.54.0 → 0.55.0-0

package/esm/typings/execution/PromptResult.d.ts

@@ -1,5 +1,6 @@
-import type { number_positive_or_zero } from '../types/typeAliases';
-import type { number_tokens } from '../types/typeAliases';
+import type { KebabCase } from 'type-fest';
+import type { ExpectationUnit } from '../types/PromptbookJson/PromptTemplateJson';
+import type { number_positive } from '../types/typeAliases';
 import type { number_usd } from '../types/typeAliases';
 import type { string_date_iso8601 } from '../types/typeAliases';
 import type { string_model_name } from '../types/typeAliases';
@@ -48,27 +49,51 @@ export type PromptCommonResult = {
     /**
      * Usage of the prompt execution
      */
-    readonly usage: {
-        /**
-         * Cost of the execution in USD
-         *
-         * If the cost is unknown, the value is `'UNKNOWN'`
-         */
-        price: (number_positive_or_zero & number_usd) | 'UNKNOWN';
-        /**
-         * Number of tokens used in the input aka. `prompt_tokens`
-         */
-        inputTokens: number_tokens | 'UNKNOWN';
-        /**
-         * Number of tokens used in the output aka. `completion_tokens`
-         */
-        outputTokens: number_tokens | 'UNKNOWN';
-    };
+    readonly usage: PromptResultUsage;
     /**
      * Raw response from the model
      */
     readonly rawResponse: object;
 };
+/**
+ * Usage statistics for one or many prompt results
+ */
+export type PromptResultUsage = {
+    /**
+     * Cost of the execution in USD
+     *
+     * Note: If the cost is unknown, the value 0 and isUncertain is true
+     */
+    price: UncertainNumber;
+    /**
+     * Number of whatever used in the input aka. `prompt_tokens`
+     */
+    input: PromptResultUsageCounts;
+    /**
+     * Number of tokens used in the output aka. `completion_tokens`
+     */
+    output: PromptResultUsageCounts;
+};
+/**
+ * Record of all possible measurable units
+ */
+export type PromptResultUsageCounts = Record<`${KebabCase<'TOKENS' | ExpectationUnit>}Count`, UncertainNumber>;
+/**
+ * Number which can be uncertain
+ *
+ * Note: If the value is completelly unknown, the value 0 and isUncertain is true
+ * Note: Not using NaN or null because it looses the value which is better to be uncertain then not to be at all
+ */
+export type UncertainNumber = {
+    /**
+     * The numeric value
+     */
+    value: number_usd & (number_positive | 0);
+    /**
+     * Is the value uncertain
+     */
+    isUncertain?: true;
+};
 /**
  * TODO: [🧠] Maybe timing more accurate then seconds?
  * TODO: [🧠] Should here be link to the prompt?

package/esm/typings/execution/addPromptResultUsage.d.ts

@@ -0,0 +1,7 @@
+import type { PromptResultUsage } from './PromptResult';
+/**
+ * Function addPromptResultUsage will add multiple usages into one
+ *
+ * Note: If you provide 0 values, it returns void usage
+ */
+export declare function addPromptResultUsage(...usageItems: Array<PromptResultUsage>): PromptResultUsage;

package/esm/typings/execution/addPromptResultUsage.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/execution/computeUsageCounts.d.ts

@@ -0,0 +1,10 @@
+import type { PromptResultUsageCounts } from './PromptResult';
+/**
+ * Helper of usage compute
+ *
+ * @param content the content of prompt or response
+ * @returns part of PromptResultUsageCounts
+ *
+ * @private internal util of LlmExecutionTools
+ */
+export declare function computeUsageCounts(content: string): Omit<PromptResultUsageCounts, 'tokensCount'>;

package/esm/typings/execution/plugins/llm-execution-tools/openai/computeOpenaiUsage.d.ts

@@ -1,8 +1,12 @@
 import type OpenAI from 'openai';
+import type { Prompt } from '../../../../types/Prompt';
 import type { PromptResult } from '../../../PromptResult';
+import type { PromptResultUsage } from '../../../PromptResult';
 /**
  * Computes the usage of the OpenAI API based on the response from OpenAI
  *
  * @throws {PromptbookExecutionError} If the usage is not defined in the response from OpenAI
+ * @private internal util of `OpenAiExecutionTools`
  */
-export declare function computeOpenaiUsage(rawResponse: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion, 'model' | 'usage'>): PromptResult['usage'];
+export declare function computeOpenaiUsage(promptContent: Prompt['content'], // <- Note: Intentionally using [] to access type properties to bring jsdoc from Prompt/PromptResult to consumer
+resultContent: PromptResult['content'], rawResponse: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion, 'model' | 'usage'>): PromptResultUsage;

package/esm/typings/types/PromptbookJson/PromptTemplateJson.d.ts

@@ -3,10 +3,11 @@ import type { ExecutionType } from '../ExecutionTypes';
 import type { ModelRequirements } from '../ModelRequirements';
 import type { ScriptLanguage } from '../ScriptLanguage';
 import type { number_integer } from '../typeAliases';
-import type { number_positive_or_zero } from '../typeAliases';
+import type { number_positive } from '../typeAliases';
 import type { string_javascript } from '../typeAliases';
 import type { string_javascript_name } from '../typeAliases';
 import type { string_markdown } from '../typeAliases';
+import type { string_markdown_text } from '../typeAliases';
 import type { string_name } from '../typeAliases';
 import type { string_prompt } from '../typeAliases';
 import type { string_template } from '../typeAliases';
@@ -47,7 +48,7 @@ export type ExpectationUnit = typeof EXPECTATION_UNITS[number];
 /**
  * Amount of text measurement
  */
-export type ExpectationAmount = number_integer & number_positive_or_zero;
+export type ExpectationAmount = number_integer & (number_positive | 0);
 /**
  * Template for simple concatenation of strings
  */
@@ -92,7 +93,7 @@ interface PromptTemplateJsonCommon {
      * Description of the prompt template
      * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
      */
-    readonly description?: string;
+    readonly description?: string_markdown_text;
     /**
      * List of parameter names that are used in the prompt template and must be defined before the prompt template is executed
      *

package/esm/typings/types/PromptbookJson/PromptTemplateParameterJson.d.ts

@@ -1,3 +1,4 @@
+import type { string_markdown_text } from '../typeAliases';
 import type { string_name } from '../typeAliases';
 /**
  * Describes one parameter of the promptbook
@@ -21,5 +22,5 @@ export type PromptTemplateParameterJson = {
      * Description of the parameter
      * - It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
      */
-    readonly description?: string;
+    readonly description?: string_markdown_text;
 };

package/esm/typings/types/PromptbookJson/PromptbookJson.d.ts

@@ -1,3 +1,4 @@
+import type { string_markdown_text } from '../typeAliases';
 import type { string_promptbook_url } from '../typeAliases';
 import type { string_version } from '../typeAliases';
 import type { PromptTemplateJson } from './PromptTemplateJson';
@@ -23,7 +24,7 @@ export type PromptbookJson = {
      * Title of the promptbook
      * -It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
      */
-    readonly title: string;
+    readonly title: string_markdown_text;
     /**
      * Version of the .ptbk.json file
      */
@@ -32,7 +33,7 @@ export type PromptbookJson = {
      * Description of the promptbook
      * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
      */
-    readonly description?: string;
+    readonly description?: string_markdown_text;
     /**
      * Set of variables that are used across the pipeline
      */

package/esm/typings/types/execution-report/ExecutionReportJson.d.ts

@@ -1,5 +1,6 @@
 import type { PromptResult } from '../../execution/PromptResult';
 import type { Prompt } from '../Prompt';
+import type { string_markdown_text } from '../typeAliases';
 import type { string_promptbook_url } from '../typeAliases';
 import type { string_version } from '../typeAliases';
 /**
@@ -32,7 +33,7 @@ export type ExecutionReportJson = {
     /**
      * Description of the promptbook which was executed
      */
-    readonly description?: string;
+    readonly description?: string_markdown_text;
     /**
      * Sequence of prompt templates in order which were executed
      */

package/esm/typings/types/typeAliases.d.ts

@@ -393,11 +393,9 @@ export type number_usd = number;
 /**
  * Semantic helper for number of tokens
  */
-export type number_tokens = number_integer & number_positive_or_zero;
+export type number_tokens = number_integer & (number_positive | 0);
 export type number_positive = number;
 export type number_negative = number;
-export type number_positive_or_zero = number;
-export type number_negative_or_zero = number;
 export type number_integer = number;
 /**
  * Semantic helper;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/core",
-    "version": "0.54.0",
+    "version": "0.55.0-0",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,

package/umd/index.umd.js

@@ -454,7 +454,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.53.0';
+    var PROMPTBOOK_VERSION = '0.54.1';
 
     /**
      * Parses the template and returns the list of all parameter names
@@ -1777,7 +1777,7 @@
      * @returns Promptbook in string format (.ptbk.md)
      */
     function promptbookJsonToString(promptbookJson) {
-        var e_1, _a, e_2, _b, e_3, _c, e_4, _d, e_5, _e;
+        var e_1, _a, e_2, _b, e_3, _c, e_4, _d, e_5, _e, e_6, _f;
         var title = promptbookJson.title, promptbookUrl = promptbookJson.promptbookUrl, promptbookVersion = promptbookJson.promptbookVersion, description = promptbookJson.description, parameters = promptbookJson.parameters, promptTemplates = promptbookJson.promptTemplates;
         var promptbookString = "# ".concat(title);
         if (description) {
@@ -1792,24 +1792,37 @@
         commands.push("PROMPTBOOK VERSION ".concat(promptbookVersion));
         promptbookString = prettifyMarkdown(promptbookString);
         try {
-            for (var parameters_1 = __values(parameters), parameters_1_1 = parameters_1.next(); !parameters_1_1.done; parameters_1_1 = parameters_1.next()) {
-                var parameter = parameters_1_1.value;
-                var isInput = parameter.isInput, isOutput = parameter.isOutput;
-                if (isInput) {
-                    commands.push("INPUT PARAMETER ".concat(promptTemplateParameterJsonToString(parameter)));
-                }
-                else if (isOutput) {
-                    commands.push("OUTPUT PARAMETER ".concat(promptTemplateParameterJsonToString(parameter)));
-                }
+            for (var _g = __values(parameters.filter(function (_a) {
+                var isInput = _a.isInput;
+                return isInput;
+            })), _h = _g.next(); !_h.done; _h = _g.next()) {
+                var parameter = _h.value;
+                commands.push("INPUT PARAMETER ".concat(promptTemplateParameterJsonToString(parameter)));
             }
         }
         catch (e_1_1) { e_1 = { error: e_1_1 }; }
         finally {
             try {
-                if (parameters_1_1 && !parameters_1_1.done && (_a = parameters_1.return)) _a.call(parameters_1);
+                if (_h && !_h.done && (_a = _g.return)) _a.call(_g);
             }
             finally { if (e_1) throw e_1.error; }
         }
+        try {
+            for (var _j = __values(parameters.filter(function (_a) {
+                var isOutput = _a.isOutput;
+                return isOutput;
+            })), _k = _j.next(); !_k.done; _k = _j.next()) {
+                var parameter = _k.value;
+                commands.push("OUTPUT PARAMETER ".concat(promptTemplateParameterJsonToString(parameter)));
+            }
+        }
+        catch (e_2_1) { e_2 = { error: e_2_1 }; }
+        finally {
+            try {
+                if (_k && !_k.done && (_b = _j.return)) _b.call(_j);
+            }
+            finally { if (e_2) throw e_2.error; }
+        }
         promptbookString += '\n\n';
         promptbookString += commands.map(function (command) { return "- ".concat(command); }).join('\n');
         try {
@@ -1859,38 +1872,38 @@
                 }
                 if (jokers) {
                     try {
-                        for (var jokers_1 = (e_3 = void 0, __values(jokers)), jokers_1_1 = jokers_1.next(); !jokers_1_1.done; jokers_1_1 = jokers_1.next()) {
+                        for (var jokers_1 = (e_4 = void 0, __values(jokers)), jokers_1_1 = jokers_1.next(); !jokers_1_1.done; jokers_1_1 = jokers_1.next()) {
                             var joker = jokers_1_1.value;
                             commands_1.push("JOKER {".concat(joker, "}"));
                         }
                     }
-                    catch (e_3_1) { e_3 = { error: e_3_1 }; }
+                    catch (e_4_1) { e_4 = { error: e_4_1 }; }
                     finally {
                         try {
-                            if (jokers_1_1 && !jokers_1_1.done && (_c = jokers_1.return)) _c.call(jokers_1);
+                            if (jokers_1_1 && !jokers_1_1.done && (_d = jokers_1.return)) _d.call(jokers_1);
                         }
-                        finally { if (e_3) throw e_3.error; }
+                        finally { if (e_4) throw e_4.error; }
                     }
                 } /* not else */
                 if (postprocessing) {
                     try {
-                        for (var postprocessing_1 = (e_4 = void 0, __values(postprocessing)), postprocessing_1_1 = postprocessing_1.next(); !postprocessing_1_1.done; postprocessing_1_1 = postprocessing_1.next()) {
+                        for (var postprocessing_1 = (e_5 = void 0, __values(postprocessing)), postprocessing_1_1 = postprocessing_1.next(); !postprocessing_1_1.done; postprocessing_1_1 = postprocessing_1.next()) {
                             var postprocessingFunctionName = postprocessing_1_1.value;
                             commands_1.push("POSTPROCESSING `".concat(postprocessingFunctionName, "`"));
                         }
                     }
-                    catch (e_4_1) { e_4 = { error: e_4_1 }; }
+                    catch (e_5_1) { e_5 = { error: e_5_1 }; }
                     finally {
                         try {
-                            if (postprocessing_1_1 && !postprocessing_1_1.done && (_d = postprocessing_1.return)) _d.call(postprocessing_1);
+                            if (postprocessing_1_1 && !postprocessing_1_1.done && (_e = postprocessing_1.return)) _e.call(postprocessing_1);
                         }
-                        finally { if (e_4) throw e_4.error; }
+                        finally { if (e_5) throw e_5.error; }
                     }
                 } /* not else */
                 if (expectations) {
                     try {
-                        for (var _f = (e_5 = void 0, __values(Object.entries(expectations))), _g = _f.next(); !_g.done; _g = _f.next()) {
-                            var _h = __read(_g.value, 2), unit = _h[0], _j = _h[1], min = _j.min, max = _j.max;
+                        for (var _l = (e_6 = void 0, __values(Object.entries(expectations))), _m = _l.next(); !_m.done; _m = _l.next()) {
+                            var _o = __read(_m.value, 2), unit = _o[0], _p = _o[1], min = _p.min, max = _p.max;
                             if (min === max) {
                                 commands_1.push("EXPECT EXACTLY ".concat(min, " ").concat(capitalize(unit + (min > 1 ? 's' : ''))));
                             }
@@ -1904,12 +1917,12 @@
                             }
                         }
                     }
-                    catch (e_5_1) { e_5 = { error: e_5_1 }; }
+                    catch (e_6_1) { e_6 = { error: e_6_1 }; }
                     finally {
                         try {
-                            if (_g && !_g.done && (_e = _f.return)) _e.call(_f);
+                            if (_m && !_m.done && (_f = _l.return)) _f.call(_l);
                         }
-                        finally { if (e_5) throw e_5.error; }
+                        finally { if (e_6) throw e_6.error; }
                     }
                 } /* not else */
                 if (expectFormat) {
@@ -1932,12 +1945,12 @@
                 promptbookString += "`-> {".concat(resultingParameterName, "}`"); // <- TODO: !!! If the parameter here has description, add it and use promptTemplateParameterJsonToString
             }
         }
-        catch (e_2_1) { e_2 = { error: e_2_1 }; }
+        catch (e_3_1) { e_3 = { error: e_3_1 }; }
         finally {
             try {
-                if (promptTemplates_1_1 && !promptTemplates_1_1.done && (_b = promptTemplates_1.return)) _b.call(promptTemplates_1);
+                if (promptTemplates_1_1 && !promptTemplates_1_1.done && (_c = promptTemplates_1.return)) _c.call(promptTemplates_1);
             }
-            finally { if (e_2) throw e_2.error; }
+            finally { if (e_3) throw e_3.error; }
         }
         return promptbookString;
     }
@@ -2271,6 +2284,97 @@
         return TemplateError;
     }(Error));
 
+    /**
+     * Function addPromptResultUsage will add multiple usages into one
+     *
+     * Note: If you provide 0 values, it returns void usage
+     */
+    function addPromptResultUsage() {
+        var usageItems = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            usageItems[_i] = arguments[_i];
+        }
+        var initialStructure = {
+            price: { value: 0 },
+            input: {
+                tokensCount: { value: 0 },
+                charactersCount: { value: 0 },
+                wordsCount: { value: 0 },
+                sentencesCount: { value: 0 },
+                linesCount: { value: 0 },
+                paragraphsCount: { value: 0 },
+                pagesCount: { value: 0 },
+            },
+            output: {
+                tokensCount: { value: 0 },
+                charactersCount: { value: 0 },
+                wordsCount: { value: 0 },
+                sentencesCount: { value: 0 },
+                linesCount: { value: 0 },
+                paragraphsCount: { value: 0 },
+                pagesCount: { value: 0 },
+            },
+        };
+        return usageItems.reduce(function (acc, item) {
+            var e_1, _a, e_2, _b;
+            var _c;
+            acc.price.value += ((_c = item.price) === null || _c === void 0 ? void 0 : _c.value) || 0;
+            try {
+                for (var _d = __values(Object.keys(acc.input)), _e = _d.next(); !_e.done; _e = _d.next()) {
+                    var key = _e.value;
+                    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                    //@ts-ignore
+                    if (item.input[key]) {
+                        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                        //@ts-ignore
+                        acc.input[key].value += item.input[key].value || 0;
+                        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                        //@ts-ignore
+                        if (item.input[key].isUncertain) {
+                            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                            //@ts-ignore
+                            acc.input[key].isUncertain = true;
+                        }
+                    }
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (_e && !_e.done && (_a = _d.return)) _a.call(_d);
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+            try {
+                for (var _f = __values(Object.keys(acc.output)), _g = _f.next(); !_g.done; _g = _f.next()) {
+                    var key = _g.value;
+                    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                    //@ts-ignore
+                    if (item.output[key]) {
+                        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                        //@ts-ignore
+                        acc.output[key].value += item.output[key].value || 0;
+                        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                        //@ts-ignore
+                        if (item.output[key].isUncertain) {
+                            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                            //@ts-ignore
+                            acc.output[key].isUncertain = true;
+                        }
+                    }
+                }
+            }
+            catch (e_2_1) { e_2 = { error: e_2_1 }; }
+            finally {
+                try {
+                    if (_g && !_g.done && (_b = _f.return)) _b.call(_f);
+                }
+                finally { if (e_2) throw e_2.error; }
+            }
+            return acc;
+        }, initialStructure);
+    }
+
     /**
      * Asserts that the execution of a promptnook is successful
      *
@@ -3997,13 +4101,13 @@
                 return ({
                     title: promptExecution.prompt.title,
                     from: 0,
-                    to: ((_b = (_a = promptExecution.result) === null || _a === void 0 ? void 0 : _a.usage) === null || _b === void 0 ? void 0 : _b.price) * (1 + taxRate),
+                    to: (((_b = (_a = promptExecution.result) === null || _a === void 0 ? void 0 : _a.usage) === null || _b === void 0 ? void 0 : _b.price.value) || 0) /* uncertainNumber */ * (1 + taxRate),
                 });
             });
             var duration = moment__default["default"].duration(completedAt.diff(startedAt));
             var llmDuration = moment__default["default"].duration(countWorkingDuration(timingItems) * 1000);
             var executionsWithKnownCost = executionReportJson.promptExecutions.filter(function (promptExecution) { var _a, _b; return (((_b = (_a = promptExecution.result) === null || _a === void 0 ? void 0 : _a.usage) === null || _b === void 0 ? void 0 : _b.price) || 'UNKNOWN') !== 'UNKNOWN'; });
-            var cost = executionsWithKnownCost.reduce(function (cost, promptExecution) { return cost + (promptExecution.result.usage.price || 0); }, 0);
+            var cost = executionsWithKnownCost.reduce(function (cost, promptExecution) { return cost + ((promptExecution.result.usage.price.value /* uncertainNumber */) || 0); }, 0);
             headerList.push("STARTED AT ".concat(moment__default["default"](startedAt).format("YYYY-MM-DD HH:mm:ss")));
             headerList.push("COMPLETED AT ".concat(moment__default["default"](completedAt).format("YYYY-MM-DD HH:mm:ss")));
             headerList.push("TOTAL DURATION ".concat(duration.humanize(MOMENT_ARG_THRESHOLDS)));
@@ -4132,6 +4236,7 @@
     exports.SimplePromptbookLibrary = SimplePromptbookLibrary;
     exports.TemplateError = TemplateError;
     exports.UnexpectedError = UnexpectedError;
+    exports.addPromptResultUsage = addPromptResultUsage;
     exports.assertsExecutionSuccessful = assertsExecutionSuccessful;
     exports.checkExpectations = checkExpectations;
     exports.createPromptbookExecutor = createPromptbookExecutor;