@promptbook/core 0.68.0-4 → 0.68.0-5

package/esm/typings/src/_packages/types.index.d.ts

@@ -14,6 +14,7 @@ import type { PrettifyOptions } from '../conversion/prettify/PrettifyOptions';
 import type { renderPipelineMermaidOptions } from '../conversion/prettify/renderPipelineMermaidOptions';
 import type { ErrorJson } from '../errors/utils/ErrorJson';
 import type { AvailableModel } from '../execution/AvailableModel';
+import type { CommonExecutionToolsOptions } from '../execution/CommonExecutionToolsOptions';
 import type { EmbeddingVector } from '../execution/EmbeddingVector';
 import type { ExecutionTools } from '../execution/ExecutionTools';
 import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
@@ -238,6 +239,7 @@ export type { PrettifyOptions };
 export type { renderPipelineMermaidOptions };
 export type { ErrorJson };
 export type { AvailableModel };
+export type { CommonExecutionToolsOptions };
 export type { EmbeddingVector };
 export type { ExecutionTools };
 export type { LlmExecutionTools };

package/esm/typings/src/commands/TEMPLATE/templateCommandParser.d.ts

@@ -8,5 +8,13 @@ import type { TemplateCommand } from './TemplateCommand';
  */
 export declare const templateCommandParser: PipelineTemplateCommandParser<TemplateCommand>;
 /**
- * Note: [⛱] There are two types of KNOWLEDGE, ACTION and INSTRUMENT commands @@@!!!!!!
+ * Note: [⛱] There are two types of KNOWLEDGE, ACTION and INSTRUMENT commands:
+ * 1) There are commands `KNOWLEDGE`, `ACTION` and `INSTRUMENT` used in the pipeline head, they just define the knowledge, action or instrument as single line after the command
+ *    - KNOWLEDGE Look at https://en.wikipedia.org/wiki/Artificial_intelligence
+ * 2) `KNOWLEDGE TEMPLATE` which has short form `KNOWLEDGE` is used in the template, does not refer the line itself, but the content of the template
+ *   - KNOWLEDGE TEMPLATE
+ *
+ *   ```
+ *   Look at https://en.wikipedia.org/wiki/Artificial_intelligence
+ *   ```
  */

package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts

@@ -9,6 +9,3 @@ import type { BoilerplateCommand } from './BoilerplateCommand';
  * @private within the commands folder
  */
 export declare const boilerplateCommandParser: PipelineBothCommandParser<BoilerplateCommand>;
-/**
- * TODO: !!!!!! Make .ptbk.md file with examples of the BOILERPLATE command and fail
- */

package/esm/typings/src/execution/CommonExecutionToolsOptions.d.ts

@@ -1,7 +1,7 @@
 /**
  * @@@
  *
- * @private just abstract the common properties for the execution tools
+ * Note: Keep it public to allow people to make their own execution tools
  */
 export type CommonExecutionToolsOptions = {
     /**

package/esm/typings/src/types/PipelineJson/PipelineJson.d.ts

@@ -86,6 +86,7 @@ export type PipelineJson = {
     readonly preparations: Array<PreparationJson>;
 };
 /**
+ * TODO: [🛳] Default PERSONA for the pipeline `defaultPersonaName` (same as `defaultModelRequirements`)
  * TODO: [🍙] Make some standard order of json properties
  * TODO: [🧠] Maybe wrap all {parameterNames} in brackets for example { "resultingParameterName": "{foo}" }
  * Note: [💼] There was a proposal for multiple types of promptbook objects 78816ff33e2705ee1a187aa2eb8affd976d4ea1a

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/core",
-    "version": "0.68.0-4",
+    "version": "0.68.0-5",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,

package/umd/index.umd.js

@@ -16,7 +16,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.68.0-3';
+    var PROMPTBOOK_VERSION = '0.68.0-4';
     // TODO: !!!! List here all the versions and annotate + put into script
 
     /*! *****************************************************************************
@@ -1794,7 +1794,7 @@
         });
     }
 
-    var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md",promptbookVersion:"0.68.0-3",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",promptbookVersion:"0.68.0-3",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",promptbookVersion:"0.68.0-3",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",promptbookVersion:"0.68.0-3",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"}];
+    var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md",promptbookVersion:"0.68.0-4",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",promptbookVersion:"0.68.0-4",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",promptbookVersion:"0.68.0-4",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",promptbookVersion:"0.68.0-4",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"}];
 
     var defaultDiacriticsRemovalMap = [
         {
@@ -4891,12 +4891,11 @@
          * Note: `$` is used to indicate that this function mutates given `templateJson`
          */
         $applyToTemplateJson: function (command, $templateJson, $pipelineJson) {
-            // TODO: !!!!!! Test multiple / no template type
             if ($templateJson.isTemplateTypeSet === true) {
                 throw new ParseError(spaceTrim__default["default"]("\n                    Template type is already defined in the template.\n                    It can be defined only once.\n                "));
             }
             $templateJson.isTemplateTypeSet = true;
-            // TODO: !!!!!! Rearrange better - but at bottom and unwrap from function
+            // TODO: [🍧] Rearrange better - but at bottom and unwrap from function
             var expectResultingParameterName = function () {
                 if ($templateJson.resultingParameterName) {
                     return;
@@ -4937,12 +4936,6 @@
             }
             expectResultingParameterName();
             $templateJson.templateType = command.templateType;
-            /*
-            TODO: !!!!!! Chat model variant should be applied in `createPipelineExecutor`
-            if (command.templateType ==='PROMPT_TEMPLATE' && templateModelRequirements.modelVariant === undefined) {
-              templateModelRequirements.modelVariant = 'CHAT';
-            }
-            */
             $templateJson.isTemplate = true;
         },
         /**
@@ -4965,7 +4958,15 @@
         },
     };
     /**
-     * Note: [⛱] There are two types of KNOWLEDGE, ACTION and INSTRUMENT commands @@@!!!!!!
+     * Note: [⛱] There are two types of KNOWLEDGE, ACTION and INSTRUMENT commands:
+     * 1) There are commands `KNOWLEDGE`, `ACTION` and `INSTRUMENT` used in the pipeline head, they just define the knowledge, action or instrument as single line after the command
+     *    - KNOWLEDGE Look at https://en.wikipedia.org/wiki/Artificial_intelligence
+     * 2) `KNOWLEDGE TEMPLATE` which has short form `KNOWLEDGE` is used in the template, does not refer the line itself, but the content of the template
+     *   - KNOWLEDGE TEMPLATE
+     *
+     *   ```
+     *   Look at https://en.wikipedia.org/wiki/Artificial_intelligence
+     *   ```
      */
 
     /**
@@ -5513,8 +5514,16 @@
          * Note: `$` is used to indicate that this function mutates given `pipelineJson`
          */
         $applyToPipelineJson: function (command, $pipelineJson) {
-            // TODO: !!!!!! Error on redefine
             $pipelineJson.defaultModelRequirements = $pipelineJson.defaultModelRequirements || {};
+            // TODO: [🚜] DRY
+            if ($pipelineJson.defaultModelRequirements[command.key] !== undefined) {
+                if ($pipelineJson.defaultModelRequirements[command.key] === command.value) {
+                    console.warn("Multiple commands `MODEL ".concat(command.key, " ").concat(command.value, "` in the pipeline head"));
+                }
+                else {
+                    throw new ParseError(spaceTrim__default["default"]("\n                        Redefinition of MODEL `".concat(command.key, "` in the pipeline head\n\n                        You have used:\n                        - MODEL ").concat(command.key, " ").concat($pipelineJson.defaultModelRequirements[command.key], "\n                        - MODEL ").concat(command.key, " ").concat(command.value, "\n                    ")));
+                }
+            }
             $pipelineJson.defaultModelRequirements[command.key] = command.value;
         },
         /**
@@ -5522,13 +5531,23 @@
          *
          * Note: `$` is used to indicate that this function mutates given `templateJson`
          */
-        $applyToTemplateJson: function (command, $templateJson) {
+        $applyToTemplateJson: function (command, $templateJson, $pipelineJson) {
             if ($templateJson.templateType !== 'PROMPT_TEMPLATE') {
                 throw new ParseError("MODEL command can only be used in PROMPT_TEMPLATE block");
             }
-            // TODO: !!!!!! Error on redefine
-            // TODO: Warn if setting same as default in `$pipelineJson`
             $templateJson.modelRequirements = $templateJson.modelRequirements || {};
+            // TODO: [🚜] DRY
+            if ($templateJson.modelRequirements[command.key] !== undefined) {
+                if ($templateJson.modelRequirements[command.key] === command.value) {
+                    console.warn("Multiple commands `MODEL ".concat(command.key, " ").concat(command.value, "` in the template \"").concat($templateJson.title || $templateJson.name, "\""));
+                }
+                else {
+                    throw new ParseError(spaceTrim__default["default"]("\n                              Redefinition of MODEL `".concat(command.key, "` in the template \"").concat($templateJson.title || $templateJson.name, "\"\n\n                              You have used:\n                              - MODEL ").concat(command.key, " ").concat($templateJson.modelRequirements[command.key], "\n                              - MODEL ").concat(command.key, " ").concat(command.value, "\n                          ")));
+                }
+            }
+            if (command.value === ($pipelineJson.defaultModelRequirements || {})[command.key]) {
+                console.log(spaceTrim__default["default"]("\n                    Setting MODEL `".concat(command.key, "` in the template \"").concat($templateJson.title || $templateJson.name, "\" to the same value as in the pipeline head\n\n                    In pipeline head:\n                    - MODEL ").concat(command.key, " ").concat(($pipelineJson.defaultModelRequirements || {})[command.key], "\n\n                    But same value is used in the template:\n                    - MODEL ").concat(command.key, " ").concat(command.value, "\n                ")));
+            }
             $templateJson.modelRequirements[command.key] = command.value;
         },
         /**
@@ -6305,9 +6324,6 @@
             throw new ParseError("BOILERPLATE command is only for testing purposes and should not be used in the .ptbk.md file");
         },
     };
-    /**
-     * TODO: !!!!!! Make .ptbk.md file with examples of the BOILERPLATE command and fail
-     */
 
     /**
      * All available command parsers
@@ -6330,6 +6346,7 @@
         personaCommandParser,
         foreachCommandParser,
         boilerplateCommandParser, // <- TODO: !! Only in development, remove in production
+        // <- Note: [♓️] This is the order of the commands in the pipeline, BUT its not used in parsing and before usage maybe it should be done better
     ];
 
     /**
@@ -7016,9 +7033,7 @@
                 }
             };
             try {
-                // TODO: !!!!!! Test error situation when `PERSONA` is used before `SIMPLE TEMPLATE`
-                // TODO: !!!!!! Test error situation when `MODEL` is used before `SIMPLE TEMPLATE`
-                // TODO [♓️] List commands and before apply order them
+                // TODO [♓️] List commands and before apply order them to achieve order-agnostic commands
                 for (var commands_1 = (e_3 = void 0, __values(commands)), commands_1_1 = commands_1.next(); !commands_1_1.done; commands_1_1 = commands_1.next()) {
                     var _f = commands_1_1.value, listItem = _f.listItem, command = _f.command;
                     _loop_3(listItem, command);
@@ -7031,7 +7046,7 @@
                 }
                 finally { if (e_3) throw e_3.error; }
             }
-            // TODO: [🍧] !!!!!! Should be done in TEMPLATE command
+            // TODO: [🍧] Should be done in TEMPLATE command
             if ($templateJson.templateType === 'SCRIPT_TEMPLATE') {
                 if (!language) {
                     throw new ParseError(spaceTrim.spaceTrim(function (block) { return "\n                            You must specify the language of the script in the SCRIPT TEMPLATE\n\n                            ".concat(block(getPipelineIdentification()), "\n                        "); }));
@@ -7044,9 +7059,7 @@
             }
             $templateJson.dependentParameterNames = Array.from(extractParameterNamesFromTemplate($templateJson));
             /*
-            // TODO: [🍧] !!!!!! This should be checked in `MODEL` command + better error message
-            // TODO: [🍧] !!!!!! Write error `.ptbk.md` file for `MODEL` and `PERSONA` command used in non-prompt template
-            // TODO: [🍧] !!!!!! `PERSONA` command should behave same as `MODEL` command - only usable in prompt template
+            // TODO: [🍧] This should be checked in `MODEL` command + better error message
             if ($templateJson.templateType !== 'PROMPT_TEMPLATE' && $templateJson.modelRequirements !== undefined) {
                 throw new UnexpectedError(
                     spaceTrim(