@promptbook/node 0.68.0-1 → 0.68.0-2

package/README.md

@@ -289,7 +289,7 @@ flowchart LR
   end;
 ```
 
--   [More template samples](./samples/templates/)
+-   [More template samples](./samples/pipelines/)
 -   [Read more about `.ptbk.md` file format here](https://github.com/webgptorg/promptbook/discussions/categories/concepts?discussions_q=is%3Aopen+label%3A.ptbk.md+category%3AConcepts)
 
 _Note: We are using [postprocessing functions](#postprocessing-functions) like `unwrapResult` that can be used to postprocess the result._
@@ -406,7 +406,7 @@ If you have a question [start a discussion](https://github.com/webgptorg/promptb
 
 ### Why not just use the OpenAI SDK / Anthropic Claude SDK / ...?
 
-Different levels of abstraction. OpenAI library is for direct use of OpenAI API. This library is for a higher level of abstraction. It is for creating prompt templates and promptbooks that are independent of the underlying library, LLM model, or even LLM provider.
+Different levels of abstraction. OpenAI library is for direct use of OpenAI API. This library is for a higher level of abstraction. It define pipelines that are independent of the underlying library, LLM model, or even LLM provider.
 
 ### How is it different from the Langchain library?
 

package/esm/index.es.js

@@ -14,7 +14,7 @@ import * as dotenv from 'dotenv';
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.68.0-0';
+var PROMPTBOOK_VERSION = '0.68.0-1';
 // TODO: !!!! List here all the versions and annotate + put into script
 
 /*! *****************************************************************************
@@ -874,7 +874,7 @@ function forEachAsync(array, options, callbackfunction) {
     });
 }
 
-var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md",promptbookVersion:"0.68.0-0",parameters:[{name:"knowledgeContent",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledgePieces",description:"The knowledge JSON object",isInput:false,isOutput:true}],templates:[{blockType:"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-0",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],templates:[{blockType:"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-0",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"title",description:"The title of the document",isInput:false,isOutput:true}],templates:[{blockType:"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-0",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:[{blockType:"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-1",parameters:[{name:"knowledgeContent",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledgePieces",description:"The knowledge JSON object",isInput:false,isOutput:true}],templates:[{blockType:"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-1",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],templates:[{blockType:"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-1",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"title",description:"The title of the document",isInput:false,isOutput:true}],templates:[{blockType:"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-1",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:[{blockType:"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"}];
 
 /**
  * This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
@@ -1125,7 +1125,7 @@ function validatePipeline(pipeline) {
         // Note: Testing that parameter is either input or result of some template
         if (!parameter.isInput &&
             !pipeline.templates.some(function (template) { return template.resultingParameterName === parameter.name; })) {
-            throw new PipelineLogicError(spaceTrim(function (block) { return "\n                        Parameter {".concat(parameter.name, "} is declared but not defined\n\n                        You can do one of these:\n                        - Remove declaration of {").concat(parameter.name, "}\n                        - Add prompt template that results in -> {").concat(parameter.name, "}\n\n                        ").concat(block(pipelineIdentification), "\n                    "); }));
+            throw new PipelineLogicError(spaceTrim(function (block) { return "\n                        Parameter {".concat(parameter.name, "} is declared but not defined\n\n                        You can do one of these:\n                        1) Remove declaration of {").concat(parameter.name, "}\n                        2) Add template that results in -> {").concat(parameter.name, "}\n\n                        ").concat(block(pipelineIdentification), "\n                    "); }));
         }
     };
     try {
@@ -2068,7 +2068,7 @@ function extractVariables(script) {
  */
 
 /**
- * Parses the prompt template and returns the set of all used parameters
+ * Parses the template and returns the set of all used parameters
  *
  * @param template the template with used parameters
  * @returns the set of parameter names
@@ -3231,7 +3231,7 @@ function createPipelineExecutor(options) {
                                                 throw new PipelineExecutionError(spaceTrim(function (block) { return "\n                                                No script execution tools are available\n\n                                                ".concat(block(pipelineIdentification), "\n                                            "); }));
                                             }
                                             if (!currentTemplate.contentLanguage) {
-                                                throw new PipelineExecutionError(spaceTrim(function (block) { return "\n                                                Script language is not defined for prompt template \"".concat(currentTemplate.name, "\"\n\n                                                ").concat(block(pipelineIdentification), "\n                                            "); }));
+                                                throw new PipelineExecutionError(spaceTrim(function (block) { return "\n                                                Script language is not defined for SCRIPT TEMPLATE \"".concat(currentTemplate.name, "\"\n\n                                                ").concat(block(pipelineIdentification), "\n                                            "); }));
                                             }
                                             // TODO: DRY [1]
                                             scriptPipelineExecutionErrors = [];
@@ -4576,7 +4576,7 @@ var blockCommandParser = {
     $applyToTemplateJson: function (command, $templateJson, $pipelineJson) {
         // TODO: !!!!!! Test multiple / no block type
         if ($templateJson.isBlockTypeSet === true) {
-            throw new ParseError("Block type is already defined in the prompt template. It can be defined only once.");
+            throw new ParseError(spaceTrim$1("\n                    Block type is already defined in the template.\n                    It can be defined only once.\n                "));
         }
         $templateJson.isBlockTypeSet = true;
         // TODO: !!!!!! Rearrange better - but at bottom and unwrap from function
@@ -4756,7 +4756,7 @@ var expectCommandParser = {
     /**
      * Description of the FORMAT command
      */
-    description: spaceTrim$1("\n        Expect command describes the desired output of the prompt template (after post-processing)\n        It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs or some other shape of the output.\n    "),
+    description: spaceTrim$1("\n        Expect command describes the desired output of the template (after post-processing)\n        It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs or some other shape of the output.\n    "),
     /**
      * Link to discussion
      */
@@ -4991,7 +4991,7 @@ var formatCommandParser = {
     /**
      * Description of the FORMAT command
      */
-    description: spaceTrim$1("\n        Format command describes the desired output of the prompt template (after post-processing)\n        It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs or some other shape of the output.\n    "),
+    description: spaceTrim$1("\n        Format command describes the desired output of the template (after post-processing)\n        It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs or some other shape of the output.\n    "),
     /**
      * Link to discussion
      */
@@ -5065,7 +5065,7 @@ var jokerCommandParser = {
     /**
      * Description of the JOKER command
      */
-    description: "Joker parameter is used instead of executing the prompt template if it meet the expectations requirements",
+    description: "Joker parameter is used instead of executing the template result if jokers value meets the expectations requirements",
     /**
      * Link to discussion
      */
@@ -5144,7 +5144,7 @@ var modelCommandParser = {
     /**
      * Description of the MODEL command
      */
-    description: "Tells which model and modelRequirements to use for the prompt template execution",
+    description: "Tells which `modelRequirements` (for example which model) to use for the prompt template execution",
     /**
      * Link to discussion
      */
@@ -5276,7 +5276,7 @@ var parameterCommandParser = {
     /**
      * Description of the PARAMETER command
      */
-    description: "Describes one parameter of the prompt template",
+    description: "Describes one parameter of the template",
     /**
      * Link to discussion
      */
@@ -5718,7 +5718,7 @@ var urlCommandParser = {
                 spaceTrim(
                     `
                         URL must not contain hash
-                        Hash is used for identification of the prompt template in the pipeline
+                        Hash is used for identification of the template in the pipeline
                     `,
                 ),
             );
@@ -6618,7 +6618,7 @@ function pipelineStringToJsonSync(pipelineString) {
     }
     var _loop_2 = function (section) {
         var e_3, _d;
-        // TODO: Parse prompt template description (the content out of the codeblock and lists)
+        // TODO: Parse template description (the content out of the codeblock and lists)
         var listItems_2 = extractAllListItemsFromMarkdown(section.content);
         var _e = extractOneBlockFromMarkdown(section.content), language = _e.language, content = _e.content;
         // TODO: [🎾][1] DRY description
@@ -6705,7 +6705,7 @@ function pipelineStringToJsonSync(pipelineString) {
         // TODO: [🍧] !!!!!! Should be done in BLOCK command
         if ($templateJson.blockType === 'SCRIPT_TEMPLATE') {
             if (!language) {
-                throw new ParseError(spaceTrim(function (block) { return "\n                            You must specify the language of the script in the prompt template\n\n                            ".concat(block(getPipelineIdentification()), "\n                        "); }));
+                throw new ParseError(spaceTrim(function (block) { return "\n                            You must specify the language of the script in the SCRIPT TEMPLATE\n\n                            ".concat(block(getPipelineIdentification()), "\n                        "); }));
             }
             if (!SUPPORTED_SCRIPT_LANGUAGES.includes(language)) {
                 throw new ParseError(spaceTrim(function (block) { return "\n                            Script language ".concat(language, " is not supported.\n\n                            Supported languages are:\n                            ").concat(block(SUPPORTED_SCRIPT_LANGUAGES.join(', ')), "\n\n                        "); }));
@@ -6724,7 +6724,7 @@ function pipelineStringToJsonSync(pipelineString) {
                     (block) => `
                         Model requirements are defined for the block type ${
                             $templateJson.blockType
-                        } which is not a prompt template
+                        } which is not a PROMPT TEMPLATE
 
                         This should be avoided by the \`modelCommandParser\`