@promptbook/node 0.69.0-15 → 0.69.0-16

package/README.md

@@ -42,6 +42,10 @@ Core of the library for Node.js runtime, it contains the main logic for promptbo
 
 Rest of the documentation is common for **entire promptbook ecosystem**:
 
+# ✨ New Features
+
+-   ✨ **Support [OpenAI o1 model](https://openai.com/o1/)**
+
 ## 🤍 The Promptbook Whitepaper
 
 

package/esm/index.es.js

@@ -15,8 +15,8 @@ import * as dotenv from 'dotenv';
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.69.0-14';
-// TODO: !!!! List here all the versions and annotate + put into script
+var PROMPTBOOK_VERSION = '0.69.0-15';
+// TODO:[main] !!!! List here all the versions and annotate + put into script
 
 /*! *****************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -326,7 +326,7 @@ function checkSerializableAsJson(name, value) {
 }
 /**
  * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
- * TODO: [🧠] !!! In-memory cache of same values to prevent multiple checks
+ * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
  * Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
  */
 
@@ -516,7 +516,7 @@ function pipelineJsonToString(pipelineJson) {
         commands.push("PIPELINE URL ".concat(pipelineUrl));
     }
     commands.push("PROMPTBOOK VERSION ".concat(promptbookVersion));
-    // TODO: !!! This increase size of the bundle and is probbably not necessary
+    // TODO:[main] !!! This increase size of the bundle and is probbably not necessary
     pipelineString = prettifyMarkdown(pipelineString);
     try {
         for (var _g = __values(parameters.filter(function (_a) {
@@ -664,12 +664,12 @@ function pipelineJsonToString(pipelineJson) {
             pipelineString += '```' + contentLanguage;
             pipelineString += '\n';
             pipelineString += spaceTrim$1(content);
-            //                   <- TODO: !!! Escape
+            //                   <- TODO:[main] !!! Escape
             //                   <- TODO: [🧠] Some clear strategy how to spaceTrim the blocks
             pipelineString += '\n';
             pipelineString += '```';
             pipelineString += '\n\n';
-            pipelineString += "`-> {".concat(resultingParameterName, "}`"); // <- TODO: !!! If the parameter here has description, add it and use templateParameterJsonToString
+            pipelineString += "`-> {".concat(resultingParameterName, "}`"); // <- TODO:[main] !!! If the parameter here has description, add it and use templateParameterJsonToString
         }
     }
     catch (e_3_1) { e_3 = { error: e_3_1 }; }
@@ -896,7 +896,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.69.0-14",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.69.0-14",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.69.0-14",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.69.0-14",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",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"}];
 
 /**
  * This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
@@ -971,7 +971,7 @@ function isValidPromptbookVersion(version) {
     if ( /* version === '1.0.0' || */version === '2.0.0' || version === '3.0.0') {
         return false;
     }
-    // <- TODO: !!! Check isValidPromptbookVersion against PROMPTBOOK_VERSIONS
+    // <- TODO:[main] !!! Check isValidPromptbookVersion against PROMPTBOOK_VERSIONS
     return true;
 }
 
@@ -1140,7 +1140,7 @@ function validatePipelineCore(pipeline) {
         // <- Note: [🚲]
         throw new PipelineLogicError(spaceTrim(function (block) { return "\n                    Invalid promptbook URL \"".concat(pipeline.pipelineUrl, "\"\n\n                    ").concat(block(pipelineIdentification), "\n                "); }));
     }
-    if (!isValidPromptbookVersion(pipeline.promptbookVersion)) {
+    if (pipeline.promptbookVersion !== undefined && !isValidPromptbookVersion(pipeline.promptbookVersion)) {
         // <- Note: [🚲]
         throw new PipelineLogicError(spaceTrim(function (block) { return "\n                    Invalid Promptbook Version \"".concat(pipeline.promptbookVersion, "\"\n\n                    ").concat(block(pipelineIdentification), "\n                "); }));
     }
@@ -1335,11 +1335,11 @@ function validatePipelineCore(pipeline) {
  *     >  ex port function validatePipeline(promptbook: really_unknown): asserts promptbook is PipelineJson {
  */
 /**
- * TODO: [🐣] !!!! Validate that all samples match expectations
- * TODO: [🐣][🐝] !!!! Validate that knowledge is valid (non-void)
- * TODO: [🐣] !!!! Validate that persona can be used only with CHAT variant
- * TODO: [🐣] !!!! Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
- * TODO: [🐣] !!!! Validate that reserved parameter is not used as joker
+ * TODO: [🐣][main] !!!! Validate that all samples match expectations
+ * TODO: [🐣][🐝][main] !!!! Validate that knowledge is valid (non-void)
+ * TODO: [🐣][main] !!!! Validate that persona can be used only with CHAT variant
+ * TODO: [🐣][main] !!!! Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
+ * TODO: [🐣][main] !!!! Validate that reserved parameter is not used as joker
  * TODO: [🧠] Validation not only logic itself but imports around - files and websites and rerefenced pipelines exists
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  */
@@ -2083,7 +2083,7 @@ function isPipelinePrepared(pipeline) {
     return true;
 }
 /**
- * TODO: [🔃] !!!!! If the pipeline was prepared with different version or different set of models, prepare it once again
+ * TODO: [🔃][main] !!!!! If the pipeline was prepared with different version or different set of models, prepare it once again
  * TODO: [🐠] Maybe base this on `makeValidator`
  * TODO: [🧊] Pipeline can be partially prepared, this should return true ONLY if fully prepared
  * TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`
@@ -4494,7 +4494,7 @@ function prepareKnowledgeFromMarkdown(knowledgeContent /* <- TODO: [🖖] (?mayb
                     outputParameters = result.outputParameters;
                     knowledgePiecesRaw = outputParameters.knowledgePieces;
                     knowledgeTextPieces = (knowledgePiecesRaw || '').split('\n---\n');
-                    //                                                               <- TODO: !!!!! Smarter split and filter out empty pieces
+                    //                                                               <- TODO:[main] !!!!! Smarter split and filter out empty pieces
                     if (isVerbose) {
                         console.info('knowledgeTextPieces:', knowledgeTextPieces);
                     }
@@ -4579,7 +4579,7 @@ function prepareKnowledgeFromMarkdown(knowledgeContent /* <- TODO: [🖖] (?mayb
     });
 }
 /**
- * TODO: [🐝][🔼] !!! Export via `@promptbook/markdown`
+ * TODO: [🐝][🔼][main] !!! Export via `@promptbook/markdown`
  * TODO: [🪂] Do it in parallel 11:11
  * Note: No need to aggregate usage here, it is done by intercepting the llmTools
  */
@@ -4603,7 +4603,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();
@@ -4795,7 +4795,7 @@ function preparePersona(personaDescription, options) {
     });
 }
 /**
- * TODO: [🔃] !!!!! If the persona was prepared with different version or different set of models, prepare it once again
+ * TODO: [🔃][main] !!!!! If the persona was prepared with different version or different set of models, prepare it once again
  * TODO: [🏢] !! Check validity of `modelName` in pipeline
  * TODO: [🏢] !! Check validity of `systemMessage` in pipeline
  * TODO: [🏢] !! Check validity of `temperature` in pipeline
@@ -4844,7 +4844,7 @@ function prepareTemplates(pipeline, options) {
                 case 0:
                     _a = options.maxParallelCount, maxParallelCount = _a === void 0 ? MAX_PARALLEL_COUNT : _a;
                     templates = pipeline.templates, parameters = pipeline.parameters, knowledgePiecesCount = pipeline.knowledgePiecesCount;
-                    // TODO: !!!!! Apply samples to each template (if missing and is for the template defined)
+                    // TODO:[main] !!!!! Apply samples to each template (if missing and is for the template defined)
                     TODO_USE(parameters);
                     templatesPrepared = new Array(
                     //            <- TODO: [🧱] Implement in a functional (not new Class) way
@@ -4876,7 +4876,7 @@ function prepareTemplates(pipeline, options) {
 /**
  * TODO: [🧠] Add context to each template (if missing)
  * TODO: [🧠] What is better name `prepareTemplate` or `prepareTemplateAndParameters`
- * TODO: [♨] !!! Prepare index the samples and maybe templates
+ * TODO: [♨][main] !!! Prepare index the samples and maybe templates
  * TODO: Write tests for `preparePipeline`
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
  * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
@@ -5048,7 +5048,7 @@ var knowledgeCommandParser = {
         if (sourceContent === '') {
             throw new ParseError("Source is not defined");
         }
-        // TODO: !!!! Following checks should be applied every link in the `sourceContent`
+        // TODO:[main] !!!! Following checks should be applied every link in the `sourceContent`
         if (sourceContent.startsWith('http://')) {
             throw new ParseError("Source is not secure");
         }
@@ -5251,7 +5251,7 @@ var templateCommandParser = {
         if (command.templateType === 'KNOWLEDGE') {
             knowledgeCommandParser.$applyToPipelineJson({
                 type: 'KNOWLEDGE',
-                sourceContent: $templateJson.content, // <- TODO: [🐝] !!! Work with KNOWLEDGE which not referring to the source file or website, but its content itself
+                sourceContent: $templateJson.content, // <- TODO: [🐝][main] !!! Work with KNOWLEDGE which not referring to the source file or website, but its content itself
             }, $pipelineJson);
             $templateJson.isTemplate = false;
             return;
@@ -6548,6 +6548,7 @@ var promptbookVersionCommandParser = {
      * Note: `$` is used to indicate that this function mutates given `pipelineJson`
      */
     $applyToPipelineJson: function (command, $pipelineJson) {
+        // TODO: Warn if the version is overridden
         $pipelineJson.promptbookVersion = command.promptbookVersion;
     },
     /**
@@ -7368,7 +7369,7 @@ function pipelineStringToJsonSync(pipelineString) {
     var $pipelineJson = {
         title: undefined /* <- Note: [🍙] Putting here placeholder to keep `title` on top at final JSON */,
         pipelineUrl: undefined /* <- Note: Putting here placeholder to keep `pipelineUrl` on top at final JSON */,
-        promptbookVersion: PROMPTBOOK_VERSION,
+        promptbookVersion: undefined /* <- Note: By default no explicit version */,
         description: undefined /* <- Note: [🍙] Putting here placeholder to keep `description` on top at final JSON */,
         parameters: [],
         templates: [],
@@ -7659,7 +7660,7 @@ function pipelineStringToJsonSync(pipelineString) {
     return $asDeeplyFrozenSerializableJson('pipelineJson', $pipelineJson);
 }
 /**
- * TODO: !!!! Warn if used only sync version
+ * TODO:[main] !!!! Warn if used only sync version
  * TODO: [🚞] Report here line/column of error
  * TODO: Use spaceTrim more effectively
  * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
@@ -8442,7 +8443,7 @@ function isSerializableAsJson(value) {
     }
 }
 /**
- * TODO: [🧠] !!! In-memory cache of same values to prevent multiple checks
+ * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
  * TODO: [🧠][💺] Can be done this on type-level?
  */