@promptbook/node 0.71.0-0 → 0.72.0-1

package/esm/index.es.js

@@ -15,7 +15,7 @@ import * as dotenv from 'dotenv';
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.70.0-1';
+var PROMPTBOOK_VERSION = '0.72.0-0';
 // TODO:[main] !!!! List here all the versions and annotate + put into script
 
 /*! *****************************************************************************
@@ -700,127 +700,6 @@ function templateParameterJsonToString(templateParameterJson) {
  * TODO: [🧠] Should be in generated .ptbk.md file GENERATOR_WARNING
  */
 
-/**
- * @@@
- *
- * @public exported from `@promptbook/utils`
- */
-function deepClone(objectValue) {
-    return JSON.parse(JSON.stringify(objectValue));
-    /*
-    TODO: [🧠] Is there a better implementation?
-    > const propertyNames = Object.getOwnPropertyNames(objectValue);
-    > for (const propertyName of propertyNames) {
-    >     const value = (objectValue as really_any)[propertyName];
-    >     if (value && typeof value === 'object') {
-    >         deepClone(value);
-    >     }
-    > }
-    > return Object.assign({}, objectValue);
-    */
-}
-/**
- * TODO: [🧠] Is there a way how to meaningfully test this utility
- */
-
-/**
- * @@@
- *
- * @public exported from `@promptbook/core`
- */
-var ZERO_USAGE = $deepFreeze({
-    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 },
-    },
-});
-/**
- * Function `addUsage` will add multiple usages into one
- *
- * Note: If you provide 0 values, it returns ZERO_USAGE
- *
- * @public exported from `@promptbook/core`
- */
-function addUsage() {
-    var usageItems = [];
-    for (var _i = 0; _i < arguments.length; _i++) {
-        usageItems[_i] = arguments[_i];
-    }
-    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;
-    }, deepClone(ZERO_USAGE));
-}
-
 /**
  * Async version of Array.forEach
  *
@@ -896,6 +775,59 @@ function forEachAsync(array, options, callbackfunction) {
     });
 }
 
+/**
+ * Represents the usage with no resources consumed
+ *
+ * @public exported from `@promptbook/core`
+ */
+var ZERO_USAGE = $deepFreeze({
+    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 },
+    },
+});
+/**
+ * Represents the usage with unknown resources consumed
+ *
+ * @public exported from `@promptbook/core`
+ */
+$deepFreeze({
+    price: { value: 0, isUncertain: true },
+    input: {
+        tokensCount: { value: 0, isUncertain: true },
+        charactersCount: { value: 0, isUncertain: true },
+        wordsCount: { value: 0, isUncertain: true },
+        sentencesCount: { value: 0, isUncertain: true },
+        linesCount: { value: 0, isUncertain: true },
+        paragraphsCount: { value: 0, isUncertain: true },
+        pagesCount: { value: 0, isUncertain: true },
+    },
+    output: {
+        tokensCount: { value: 0, isUncertain: true },
+        charactersCount: { value: 0, isUncertain: true },
+        wordsCount: { value: 0, isUncertain: true },
+        sentencesCount: { value: 0, isUncertain: true },
+        linesCount: { value: 0, isUncertain: true },
+        paragraphsCount: { value: 0, isUncertain: true },
+        pagesCount: { value: 0, isUncertain: true },
+    },
+});
+
 var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md",parameters:[{name:"knowledgeContent",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledgePieces",description:"The knowledge JSON object",isInput:false,isOutput:true}],templates:[{templateType:"PROMPT_TEMPLATE",name:"knowledge",title:"Knowledge",content:"You are experienced data researcher, extract the important knowledge from the document.\n\n# Rules\n\n-   Make pieces of information concise, clear, and easy to understand\n-   One piece of information should be approximately 1 paragraph\n-   Divide the paragraphs by markdown horizontal lines ---\n-   Omit irrelevant information\n-   Group redundant information\n-   Write just extracted information, nothing else\n\n# The document\n\nTake information from this document:\n\n> {knowledgeContent}",resultingParameterName:"knowledgePieces",dependentParameterNames:["knowledgeContent"]}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-knowledge-from-markdown.ptbk.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-keywords.ptbk.md",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],templates:[{templateType:"PROMPT_TEMPLATE",name:"knowledge",title:"Knowledge",content:"You are experienced data researcher, detect the important keywords in the document.\n\n# Rules\n\n-   Write just keywords separated by comma\n\n# The document\n\nTake information from this document:\n\n> {knowledgePieceContent}",resultingParameterName:"keywords",dependentParameterNames:["knowledgePieceContent"]}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-knowledge-keywords.ptbk.md"},{title:"Prepare Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-title.ptbk.md",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"title",description:"The title of the document",isInput:false,isOutput:true}],templates:[{templateType:"PROMPT_TEMPLATE",name:"knowledge",title:"Knowledge",content:"You are experienced content creator, write best title for the document.\n\n# Rules\n\n-   Write just title, nothing else\n-   Title should be concise and clear\n-   Write maximum 5 words for the title\n\n# The document\n\n> {knowledgePieceContent}",resultingParameterName:"title",expectations:{words:{min:1,max:8}},dependentParameterNames:["knowledgePieceContent"]}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-knowledge-title.ptbk.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.ptbk.md",parameters:[{name:"availableModelNames",description:"List of available model names separated by comma (,)",isInput:true,isOutput:false},{name:"personaDescription",description:"Description of the persona",isInput:true,isOutput:false},{name:"modelRequirements",description:"Specific requirements for the model",isInput:false,isOutput:true}],templates:[{templateType:"PROMPT_TEMPLATE",name:"make-model-requirements",title:"Make modelRequirements",content:"You are experienced AI engineer, you need to create virtual assistant.\nWrite\n\n## Sample\n\n```json\n{\n\"modelName\": \"gpt-4o\",\n\"systemMessage\": \"You are experienced AI engineer and helpfull assistant.\",\n\"temperature\": 0.7\n}\n```\n\n## Instructions\n\n-   Your output format is JSON object\n-   Write just the JSON object, no other text should be present\n-   It contains the following keys:\n    -   `modelName`: The name of the model to use\n    -   `systemMessage`: The system message to provide context to the model\n    -   `temperature`: The sampling temperature to use\n\n### Key `modelName`\n\nPick from the following models:\n\n-   {availableModelNames}\n\n### Key `systemMessage`\n\nThe system message is used to communicate instructions or provide context to the model at the beginning of a conversation. It is displayed in a different format compared to user messages, helping the model understand its role in the conversation. The system message typically guides the model's behavior, sets the tone, or specifies desired output from the model. By utilizing the system message effectively, users can steer the model towards generating more accurate and relevant responses.\n\nFor example:\n\n> You are an experienced AI engineer and helpful assistant.\n\n> You are a friendly and knowledgeable chatbot.\n\n### Key `temperature`\n\nThe sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.\n\nYou can pick a value between 0 and 2. For example:\n\n-   `0.1`: Low temperature, extremely conservative and deterministic\n-   `0.5`: Medium temperature, balanced between conservative and creative\n-   `1.0`: High temperature, creative and bit random\n-   `1.5`: Very high temperature, extremely creative and often chaotic and unpredictable\n-   `2.0`: Maximum temperature, completely random and unpredictable, for some extreme creative use cases\n\n# The assistant\n\nTake this description of the persona:\n\n> {personaDescription}",resultingParameterName:"modelRequirements",format:"JSON",dependentParameterNames:["availableModelNames","personaDescription"]}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-persona.ptbk.md"}];
 
 /**
@@ -2420,6 +2352,101 @@ function arrayableToArray(input) {
     return [input];
 }
 
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/utils`
+ */
+function deepClone(objectValue) {
+    return JSON.parse(JSON.stringify(objectValue));
+    /*
+    TODO: [🧠] Is there a better implementation?
+    > const propertyNames = Object.getOwnPropertyNames(objectValue);
+    > for (const propertyName of propertyNames) {
+    >     const value = (objectValue as really_any)[propertyName];
+    >     if (value && typeof value === 'object') {
+    >         deepClone(value);
+    >     }
+    > }
+    > return Object.assign({}, objectValue);
+    */
+}
+/**
+ * TODO: [🧠] Is there a way how to meaningfully test this utility
+ */
+
+/**
+ * Function `addUsage` will add multiple usages into one
+ *
+ * Note: If you provide 0 values, it returns ZERO_USAGE
+ *
+ * @public exported from `@promptbook/core`
+ */
+function addUsage() {
+    var usageItems = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+        usageItems[_i] = arguments[_i];
+    }
+    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;
+    }, deepClone(ZERO_USAGE));
+}
+
 /**
  * Parses the given script and returns the list of all used variables that are not defined in the script
  *
@@ -3779,12 +3806,12 @@ function executeFormatCells(options) {
                                             if (!(error instanceof PipelineExecutionError)) {
                                                 throw error;
                                             }
-                                            throw new PipelineExecutionError(spaceTrim$1(function (block) { return "\n                        ".concat(error.message, "\n\n                        This is error in FOREACH command\n                        You have probbably passed wrong data to pipeline or wrong data was generated which are processed by FOREACH command\n\n                        ").concat(block(pipelineIdentification), "\n                    "); }));
+                                            throw new PipelineExecutionError(spaceTrim$1(function (block) { return "\n                        ".concat(error.message, "\n\n                        This is error in FOREACH command\n                        You have probbably passed wrong data to pipeline or wrong data was generated which are processed by FOREACH command\n\n                        ").concat(block(pipelineIdentification), "\n                        Subparameter index: ").concat(index, "\n                    "); }));
                                         }
                                         allSubparameters = __assign(__assign({}, parameters), mappedParameters);
                                         // Note: [👨‍👨‍👧] Now we can freeze `subparameters` because we are sure that all and only used parameters are defined and are not going to be changed
                                         Object.freeze(allSubparameters);
-                                        return [4 /*yield*/, executeAttempts(__assign(__assign({}, options), { priority: priority + index, parameters: allSubparameters, pipelineIdentification: pipelineIdentification }))];
+                                        return [4 /*yield*/, executeAttempts(__assign(__assign({}, options), { priority: priority + index, parameters: allSubparameters, pipelineIdentification: spaceTrim$1(function (block) { return "\n                        ".concat(block(pipelineIdentification), "\n                        Subparameter index: ").concat(index, "\n                    "); }) }))];
                                     case 1:
                                         subresultString = _a.sent();
                                         return [2 /*return*/, subresultString];
@@ -4294,7 +4321,7 @@ function executePipeline(options) {
                                         },
                                         settings: settings,
                                         $executionReport: executionReport,
-                                        pipelineIdentification: pipelineIdentification,
+                                        pipelineIdentification: spaceTrim(function (block) { return "\n                            ".concat(block(pipelineIdentification), "\n                            Template name: ").concat(currentTemplate.name, "\n                            Template title: ").concat(currentTemplate.title, "\n                        "); }),
                                     })
                                         .then(function (newParametersToPass) {
                                         parametersToPass = __assign(__assign({}, newParametersToPass), parametersToPass);
@@ -4417,9 +4444,11 @@ function createPipelineExecutor(options) {
     else if (isNotPreparedWarningSupressed !== true) {
         console.warn(spaceTrim(function (block) { return "\n                    Pipeline is not prepared\n\n                    ".concat(block(pipelineIdentification), "\n\n                    It will be prepared ad-hoc before the first execution and **returned as `preparedPipeline` in `PipelineExecutorResult`**\n                    But it is recommended to prepare the pipeline during collection preparation\n\n                    @see more at https://ptbk.io/prepare-pipeline\n                "); }));
     }
+    var runCount = 0;
     var pipelineExecutor = function (inputParameters, onProgress) { return __awaiter(_this, void 0, void 0, function () {
         return __generator(this, function (_a) {
-            return [2 /*return*/, executePipeline({
+            runCount++;
+            return [2 /*return*/, /* not await */ executePipeline({
                     pipeline: pipeline,
                     preparedPipeline: preparedPipeline,
                     setPreparedPipeline: function (newPreparedPipeline) {
@@ -4428,7 +4457,7 @@ function createPipelineExecutor(options) {
                     inputParameters: inputParameters,
                     tools: tools,
                     onProgress: onProgress,
-                    pipelineIdentification: pipelineIdentification,
+                    pipelineIdentification: spaceTrim(function (block) { return "\n                    ".concat(block(pipelineIdentification), "\n                    ").concat(runCount === 1 ? '' : "Run #".concat(runCount), "\n                "); }),
                     settings: {
                         maxExecutionAttempts: maxExecutionAttempts,
                         maxParallelCount: maxParallelCount,
@@ -4601,7 +4630,7 @@ function prepareKnowledgePieces(knowledgeSources, options) {
                             var partialPieces, pieces;
                             return __generator(this, function (_a) {
                                 switch (_a.label) {
-                                    case 0: return [4 /*yield*/, prepareKnowledgeFromMarkdown(knowledgeSource.sourceContent, // <- TODO: [🐝] !!!!!! Unhardcode markdown, detect which type it is - BE AWARE of big package size
+                                    case 0: return [4 /*yield*/, prepareKnowledgeFromMarkdown(knowledgeSource.sourceContent, // <- TODO: [🐝][main] !!! Unhardcode markdown, detect which type it is - BE AWARE of big package size
                                         options)];
                                     case 1:
                                         partialPieces = _a.sent();