@promptbook/core 0.54.1 → 0.55.0-1

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,11 +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 { string_markdown_text } 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';
@@ -48,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
  */

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.1",
+    "version": "0.55.0-1",
     "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.54.0';
+    var PROMPTBOOK_VERSION = '0.55.0-0';
 
     /**
      * Parses the template and returns the list of all parameter names
@@ -2284,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
      *
@@ -4010,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)));
@@ -4145,6 +4236,7 @@
     exports.SimplePromptbookLibrary = SimplePromptbookLibrary;
     exports.TemplateError = TemplateError;
     exports.UnexpectedError = UnexpectedError;
+    exports.addPromptResultUsage = addPromptResultUsage;
     exports.assertsExecutionSuccessful = assertsExecutionSuccessful;
     exports.checkExpectations = checkExpectations;
     exports.createPromptbookExecutor = createPromptbookExecutor;