@promptbook/cli 0.80.0-0 → 0.80.0-1

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

@@ -29,9 +29,9 @@ import { SET_IS_VERBOSE } from '../config';
 import { DEFAULT_IS_AUTO_INSTALLED } from '../config';
 import { ORDER_OF_PIPELINE_JSON } from '../constants';
 import { RESERVED_PARAMETER_NAMES } from '../constants';
+import { compilePipeline } from '../conversion/compilePipeline';
 import { pipelineJsonToString } from '../conversion/pipelineJsonToString';
-import { pipelineStringToJson } from '../conversion/pipelineStringToJson';
-import { pipelineStringToJsonSync } from '../conversion/pipelineStringToJsonSync';
+import { precompilePipeline } from '../conversion/precompilePipeline';
 import { prettifyPipelineString } from '../conversion/prettify/prettifyPipelineString';
 import { extractParameterNamesFromTask } from '../conversion/utils/extractParameterNamesFromTask';
 import { removePipelineCommand } from '../conversion/utils/removePipelineCommand';
@@ -150,9 +150,9 @@ export { SET_IS_VERBOSE };
 export { DEFAULT_IS_AUTO_INSTALLED };
 export { ORDER_OF_PIPELINE_JSON };
 export { RESERVED_PARAMETER_NAMES };
+export { compilePipeline };
 export { pipelineJsonToString };
-export { pipelineStringToJson };
-export { pipelineStringToJsonSync };
+export { precompilePipeline };
 export { prettifyPipelineString };
 export { extractParameterNamesFromTask };
 export { removePipelineCommand };

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

@@ -46,8 +46,6 @@ import type { CsvSettings } from '../formats/csv/CsvSettings';
 import type { AbstractFormfactorDefinition } from '../formfactors/_common/AbstractFormfactorDefinition';
 import type { FormfactorDefinition } from '../formfactors/_common/FormfactorDefinition';
 import type { string_formfactor_name } from '../formfactors/_common/string_formfactor_name';
-import type { AsyncHighLevelAbstraction } from '../high-level-abstractions/_common/HighLevelAbstraction';
-import type { CommonHighLevelAbstraction } from '../high-level-abstractions/_common/HighLevelAbstraction';
 import type { LlmToolsConfiguration } from '../llm-providers/_common/register/LlmToolsConfiguration';
 import type { LlmToolsMetadata } from '../llm-providers/_common/register/LlmToolsMetadata';
 import type { LlmToolsOptions } from '../llm-providers/_common/register/LlmToolsOptions';
@@ -310,8 +308,6 @@ export type { CsvSettings };
 export type { AbstractFormfactorDefinition };
 export type { FormfactorDefinition };
 export type { string_formfactor_name };
-export type { AsyncHighLevelAbstraction };
-export type { CommonHighLevelAbstraction };
 export type { LlmToolsConfiguration };
 export type { LlmToolsMetadata };
 export type { LlmToolsOptions };

package/esm/typings/src/commands/_common/getParserForCommand.d.ts

@@ -6,6 +6,6 @@ import type { CommandParser } from './types/CommandParser';
  * @returns the parser for the command
  * @throws {UnexpectedError} if the parser is not found
  *
- * @private within the pipelineStringToJson
+ * @private within the compilePipeline
  */
 export declare function getParserForCommand<TCommand extends Command>(command: TCommand): CommandParser<TCommand>;

package/esm/typings/src/commands/_common/parseCommand.d.ts

@@ -7,6 +7,6 @@ import type { CommandUsagePlace } from './types/CommandUsagePlaces';
  * @returns parsed command object
  * @throws {ParseError} if the command is invalid
  *
- * @private within the pipelineStringToJson
+ * @private within the compilePipeline
  */
 export declare function parseCommand(raw: string_markdown_text, usagePlace: CommandUsagePlace): Command;

package/esm/typings/src/commands/_common/stringifyCommand.d.ts

@@ -6,6 +6,6 @@ import type { Command } from './types/Command';
  * @returns stringified command
  * @throws {UnexpectedError} if the command is invalid
  *
- * @private within the pipelineStringToJson
+ * @private within the compilePipeline
  */
 export declare function stringifyCommand(command: Command): string_markdown_text;

package/esm/typings/src/conversion/{pipelineStringToJson.d.ts → compilePipeline.d.ts}

@@ -6,8 +6,8 @@ import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions
  * Compile pipeline from string (markdown) format to JSON format
  *
  * Note: There are 3 similar functions:
- * - `pipelineStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
- * - `pipelineStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+ * - `compilePipeline` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
+ * - `precompilePipeline` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
  * - `preparePipeline` - just one step in the compilation process
  *
  * Note: This function does not validate logic of the pipeline only the parsing
@@ -20,7 +20,7 @@ import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions
  * @throws {ParseError} if the promptbook string is not valid
  * @public exported from `@promptbook/core`
  */
-export declare function pipelineStringToJson(pipelineString: PipelineString, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: PrepareAndScrapeOptions): Promise<PipelineJson>;
+export declare function compilePipeline(pipelineString: PipelineString, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: PrepareAndScrapeOptions): Promise<PipelineJson>;
 /**
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools

package/esm/typings/src/conversion/{pipelineStringToJsonSync.d.ts → precompilePipeline.d.ts}

@@ -4,8 +4,8 @@ import type { PipelineString } from '../pipeline/PipelineString';
  * Compile pipeline from string (markdown) format to JSON format synchronously
  *
  * Note: There are 3 similar functions:
- * - `pipelineStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
- * - `pipelineStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+ * - `compilePipeline` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
+ * - `precompilePipeline` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
  * - `preparePipeline` - just one step in the compilation process
  *
  * Note: This function does not validate logic of the pipeline only the parsing
@@ -16,7 +16,7 @@ import type { PipelineString } from '../pipeline/PipelineString';
  * @throws {ParseError} if the promptbook string is not valid
  * @public exported from `@promptbook/core`
  */
-export declare function pipelineStringToJsonSync(pipelineString: PipelineString): PipelineJson;
+export declare function precompilePipeline(pipelineString: PipelineString): PipelineJson;
 /**
  * TODO: [🧠] Maybe more things here can be refactored as high-level abstractions
  * TODO: [main] !!!! Warn if used only sync version

package/esm/typings/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts

@@ -1,6 +1,6 @@
 import type { $PipelineJson } from '../../commands/_common/types/CommandParser';
 /**
- * Used in `pipelineStringToJsonSync`
+ * Used in `precompilePipeline`
  *
  * @private
  */

package/esm/typings/src/high-level-abstractions/index.d.ts

@@ -1,7 +1,7 @@
 /**
  * All high-level abstractions
  *
- * @private internal index of `pipelineStringToJsonSync` (= used for sync) and `preparePipeline` (= used for async)
+ * @private internal index of `precompilePipeline` (= used for sync) and `preparePipeline` (= used for async)
  */
 export declare const HIGH_LEVEL_ABSTRACTIONS: readonly [{
     type: "SYNC";

package/esm/typings/src/prepare/unpreparePipeline.d.ts

@@ -2,6 +2,7 @@ import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
 /**
  * Unprepare just strips the preparation data of the pipeline
  *
+ * @deprecated In future version this function will be removed or deprecated
  * @public exported from `@promptbook/core`
  */
 export declare function unpreparePipeline(pipeline: PipelineJson): PipelineJson;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/cli",
-    "version": "0.80.0-0",
+    "version": "0.80.0-1",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "--note-0": "    <- [🐊]",
     "private": false,

package/umd/index.umd.js

@@ -49,7 +49,7 @@
      *
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.79.0';
+    var PROMPTBOOK_ENGINE_VERSION = '0.80.0-0';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -2664,6 +2664,100 @@
      * TODO: [🧠] Maybe clear `sourceFile` or clear when exposing through API or remote server
      */
 
+    /**
+     * This error type indicates that some tools are missing for pipeline execution or preparation
+     *
+     * @public exported from `@promptbook/core`
+     */
+    var MissingToolsError = /** @class */ (function (_super) {
+        __extends(MissingToolsError, _super);
+        function MissingToolsError(message) {
+            var _this = _super.call(this, spaceTrim.spaceTrim(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: You have probbably forgot to provide some tools for pipeline execution or preparation\n\n                "); })) || this;
+            _this.name = 'MissingToolsError';
+            Object.setPrototypeOf(_this, MissingToolsError.prototype);
+            return _this;
+        }
+        return MissingToolsError;
+    }(Error));
+
+    /**
+     * Async version of Array.forEach
+     *
+     * @param array - Array to iterate over
+     * @param options - Options for the function
+     * @param callbackfunction - Function to call for each item
+     * @public exported from `@promptbook/utils`
+     * @deprecated [🪂] Use queues instead
+     */
+    function forEachAsync(array, options, callbackfunction) {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a, maxParallelCount, index, runningTasks, tasks, _loop_1, _b, _c, item, e_1_1;
+            var e_1, _d;
+            return __generator(this, function (_e) {
+                switch (_e.label) {
+                    case 0:
+                        _a = options.maxParallelCount, maxParallelCount = _a === void 0 ? Infinity : _a;
+                        index = 0;
+                        runningTasks = [];
+                        tasks = [];
+                        _loop_1 = function (item) {
+                            var currentIndex, task;
+                            return __generator(this, function (_f) {
+                                switch (_f.label) {
+                                    case 0:
+                                        currentIndex = index++;
+                                        task = callbackfunction(item, currentIndex, array);
+                                        tasks.push(task);
+                                        runningTasks.push(task);
+                                        /* not await */ Promise.resolve(task).then(function () {
+                                            runningTasks = runningTasks.filter(function (t) { return t !== task; });
+                                        });
+                                        if (!(maxParallelCount < runningTasks.length)) return [3 /*break*/, 2];
+                                        return [4 /*yield*/, Promise.race(runningTasks)];
+                                    case 1:
+                                        _f.sent();
+                                        _f.label = 2;
+                                    case 2: return [2 /*return*/];
+                                }
+                            });
+                        };
+                        _e.label = 1;
+                    case 1:
+                        _e.trys.push([1, 6, 7, 8]);
+                        _b = __values(array), _c = _b.next();
+                        _e.label = 2;
+                    case 2:
+                        if (!!_c.done) return [3 /*break*/, 5];
+                        item = _c.value;
+                        return [5 /*yield**/, _loop_1(item)];
+                    case 3:
+                        _e.sent();
+                        _e.label = 4;
+                    case 4:
+                        _c = _b.next();
+                        return [3 /*break*/, 2];
+                    case 5: return [3 /*break*/, 8];
+                    case 6:
+                        e_1_1 = _e.sent();
+                        e_1 = { error: e_1_1 };
+                        return [3 /*break*/, 8];
+                    case 7:
+                        try {
+                            if (_c && !_c.done && (_d = _b.return)) _d.call(_b);
+                        }
+                        finally { if (e_1) throw e_1.error; }
+                        return [7 /*endfinally*/];
+                    case 8: return [4 /*yield*/, Promise.all(tasks)];
+                    case 9:
+                        _e.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    }
+
+    var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.book.md",formfactorName:"GENERIC",parameters:[{name:"knowledgeContent",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledgePieces",description:"The knowledge JSON object",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",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"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sourceFile:"./books/prepare-knowledge-from-markdown.book.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-keywords.book.md",formfactorName:"GENERIC",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",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"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sourceFile:"./books/prepare-knowledge-keywords.book.md"},{title:"Prepare Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-title.book.md",formfactorName:"GENERIC",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"title",description:"The title of the document",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",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"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sourceFile:"./books/prepare-knowledge-title.book.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.book.md",formfactorName:"GENERIC",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}],tasks:[{taskType:"PROMPT_TASK",name:"make-model-requirements",title:"Make modelRequirements",content:"You are experienced AI engineer, you need to create virtual assistant.\nWrite\n\n## Example\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"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sourceFile:"./books/prepare-persona.book.md"}];
+
     /**
      * Prettify the html code
      *
@@ -2914,100 +3008,6 @@
      * TODO: [🧠] Should be in generated .book.md file GENERATOR_WARNING
      */
 
-    /**
-     * This error type indicates that some tools are missing for pipeline execution or preparation
-     *
-     * @public exported from `@promptbook/core`
-     */
-    var MissingToolsError = /** @class */ (function (_super) {
-        __extends(MissingToolsError, _super);
-        function MissingToolsError(message) {
-            var _this = _super.call(this, spaceTrim.spaceTrim(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: You have probbably forgot to provide some tools for pipeline execution or preparation\n\n                "); })) || this;
-            _this.name = 'MissingToolsError';
-            Object.setPrototypeOf(_this, MissingToolsError.prototype);
-            return _this;
-        }
-        return MissingToolsError;
-    }(Error));
-
-    /**
-     * Async version of Array.forEach
-     *
-     * @param array - Array to iterate over
-     * @param options - Options for the function
-     * @param callbackfunction - Function to call for each item
-     * @public exported from `@promptbook/utils`
-     * @deprecated [🪂] Use queues instead
-     */
-    function forEachAsync(array, options, callbackfunction) {
-        return __awaiter(this, void 0, void 0, function () {
-            var _a, maxParallelCount, index, runningTasks, tasks, _loop_1, _b, _c, item, e_1_1;
-            var e_1, _d;
-            return __generator(this, function (_e) {
-                switch (_e.label) {
-                    case 0:
-                        _a = options.maxParallelCount, maxParallelCount = _a === void 0 ? Infinity : _a;
-                        index = 0;
-                        runningTasks = [];
-                        tasks = [];
-                        _loop_1 = function (item) {
-                            var currentIndex, task;
-                            return __generator(this, function (_f) {
-                                switch (_f.label) {
-                                    case 0:
-                                        currentIndex = index++;
-                                        task = callbackfunction(item, currentIndex, array);
-                                        tasks.push(task);
-                                        runningTasks.push(task);
-                                        /* not await */ Promise.resolve(task).then(function () {
-                                            runningTasks = runningTasks.filter(function (t) { return t !== task; });
-                                        });
-                                        if (!(maxParallelCount < runningTasks.length)) return [3 /*break*/, 2];
-                                        return [4 /*yield*/, Promise.race(runningTasks)];
-                                    case 1:
-                                        _f.sent();
-                                        _f.label = 2;
-                                    case 2: return [2 /*return*/];
-                                }
-                            });
-                        };
-                        _e.label = 1;
-                    case 1:
-                        _e.trys.push([1, 6, 7, 8]);
-                        _b = __values(array), _c = _b.next();
-                        _e.label = 2;
-                    case 2:
-                        if (!!_c.done) return [3 /*break*/, 5];
-                        item = _c.value;
-                        return [5 /*yield**/, _loop_1(item)];
-                    case 3:
-                        _e.sent();
-                        _e.label = 4;
-                    case 4:
-                        _c = _b.next();
-                        return [3 /*break*/, 2];
-                    case 5: return [3 /*break*/, 8];
-                    case 6:
-                        e_1_1 = _e.sent();
-                        e_1 = { error: e_1_1 };
-                        return [3 /*break*/, 8];
-                    case 7:
-                        try {
-                            if (_c && !_c.done && (_d = _b.return)) _d.call(_b);
-                        }
-                        finally { if (e_1) throw e_1.error; }
-                        return [7 /*endfinally*/];
-                    case 8: return [4 /*yield*/, Promise.all(tasks)];
-                    case 9:
-                        _e.sent();
-                        return [2 /*return*/];
-                }
-            });
-        });
-    }
-
-    var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.book.md",formfactorName:"GENERIC",parameters:[{name:"knowledgeContent",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledgePieces",description:"The knowledge JSON object",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",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"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sourceFile:"./books/prepare-knowledge-from-markdown.book.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-keywords.book.md",formfactorName:"GENERIC",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",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"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sourceFile:"./books/prepare-knowledge-keywords.book.md"},{title:"Prepare Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-title.book.md",formfactorName:"GENERIC",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"title",description:"The title of the document",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",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"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sourceFile:"./books/prepare-knowledge-title.book.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.book.md",formfactorName:"GENERIC",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}],tasks:[{taskType:"PROMPT_TASK",name:"make-model-requirements",title:"Make modelRequirements",content:"You are experienced AI engineer, you need to create virtual assistant.\nWrite\n\n## Example\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"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sourceFile:"./books/prepare-persona.book.md"}];
-
     /**
      * This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
      *
@@ -3515,6 +3515,7 @@
     /**
      * Unprepare just strips the preparation data of the pipeline
      *
+     * @deprecated In future version this function will be removed or deprecated
      * @public exported from `@promptbook/core`
      */
     function unpreparePipeline(pipeline) {
@@ -8294,7 +8295,7 @@
          * Note: `$` is used to indicate that this function mutates given `pipelineJson`
          */
         $applyToPipelineJson: function (command, $pipelineJson) {
-            // Note: [🍣] Do nothing, its application is implemented separately in `pipelineStringToJsonSync`
+            // Note: [🍣] Do nothing, its application is implemented separately in `precompilePipeline`
         },
         /**
          * Apply the PARAMETER command to the `pipelineJson`
@@ -8302,7 +8303,7 @@
          * Note: `$` is used to indicate that this function mutates given `taskJson`
          */
         $applyToTaskJson: function (command, $taskJson, $pipelineJson) {
-            // Note: [🍣] Do nothing, its application is implemented separately in `pipelineStringToJsonSync`
+            // Note: [🍣] Do nothing, its application is implemented separately in `precompilePipeline`
         },
         /**
          * Converts the PARAMETER command back to string
@@ -8810,7 +8811,7 @@
      * @returns the parser for the command
      * @throws {UnexpectedError} if the parser is not found
      *
-     * @private within the pipelineStringToJson
+     * @private within the compilePipeline
      */
     function getParserForCommand(command) {
         var commandParser = COMMANDS.find(function (commandParser) { return commandParser.name === command.type; });
@@ -8846,7 +8847,7 @@
      * @returns parsed command object
      * @throws {ParseError} if the command is invalid
      *
-     * @private within the pipelineStringToJson
+     * @private within the compilePipeline
      */
     function parseCommand(raw, usagePlace) {
         if (raw.includes('\n') || raw.includes('\r')) {
@@ -9261,7 +9262,7 @@
     /**
      * All high-level abstractions
      *
-     * @private internal index of `pipelineStringToJsonSync` (= used for sync) and `preparePipeline` (= used for async)
+     * @private internal index of `precompilePipeline` (= used for sync) and `preparePipeline` (= used for async)
      */
     var HIGH_LEVEL_ABSTRACTIONS = [
         ImplicitFormfactorHla,
@@ -9511,8 +9512,8 @@
      * Compile pipeline from string (markdown) format to JSON format synchronously
      *
      * Note: There are 3 similar functions:
-     * - `pipelineStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
-     * - `pipelineStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+     * - `compilePipeline` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
+     * - `precompilePipeline` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
      * - `preparePipeline` - just one step in the compilation process
      *
      * Note: This function does not validate logic of the pipeline only the parsing
@@ -9523,7 +9524,7 @@
      * @throws {ParseError} if the promptbook string is not valid
      * @public exported from `@promptbook/core`
      */
-    function pipelineStringToJsonSync(pipelineString) {
+    function precompilePipeline(pipelineString) {
         var e_1, _a, e_2, _b, e_3, _c, e_4, _d, e_5, _e, e_6, _f;
         var $pipelineJson = {
             title: DEFAULT_TITLE,
@@ -9943,7 +9944,7 @@
         // TODO: [🍙] Maybe do reorder of `$pipelineJson` here
         return exportJson({
             name: 'pipelineJson',
-            message: "Result of `pipelineStringToJsonSync`",
+            message: "Result of `precompilePipeline`",
             order: ORDER_OF_PIPELINE_JSON,
             value: __assign({ formfactorName: 'GENERIC' }, $pipelineJson),
         });
@@ -9964,8 +9965,8 @@
      * Compile pipeline from string (markdown) format to JSON format
      *
      * Note: There are 3 similar functions:
-     * - `pipelineStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
-     * - `pipelineStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+     * - `compilePipeline` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
+     * - `precompilePipeline` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
      * - `preparePipeline` - just one step in the compilation process
      *
      * Note: This function does not validate logic of the pipeline only the parsing
@@ -9978,13 +9979,13 @@
      * @throws {ParseError} if the promptbook string is not valid
      * @public exported from `@promptbook/core`
      */
-    function pipelineStringToJson(pipelineString, tools, options) {
+    function compilePipeline(pipelineString, tools, options) {
         return __awaiter(this, void 0, void 0, function () {
             var pipelineJson;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        pipelineJson = pipelineStringToJsonSync(pipelineString);
+                        pipelineJson = precompilePipeline(pipelineString);
                         if (!(tools !== undefined && tools.llm !== undefined)) return [3 /*break*/, 2];
                         return [4 /*yield*/, preparePipeline(pipelineJson, tools, options || {
                                 rootDirname: null,
@@ -9993,7 +9994,7 @@
                         pipelineJson = _a.sent();
                         _a.label = 2;
                     case 2: 
-                    // Note: No need to use `$exportJson` because `pipelineStringToJsonSync` and `preparePipeline` already do that
+                    // Note: No need to use `$exportJson` because `precompilePipeline` and `preparePipeline` already do that
                     return [2 /*return*/, pipelineJson];
                 }
             });
@@ -11120,7 +11121,7 @@
                                                         return [4 /*yield*/, promises.readFile(fileName, 'utf-8')];
                                                     case 2:
                                                         pipelineString = (_e.sent());
-                                                        return [4 /*yield*/, pipelineStringToJson(pipelineString, tools, {
+                                                        return [4 /*yield*/, compilePipeline(pipelineString, tools, {
                                                                 rootDirname: rootDirname,
                                                             })];
                                                     case 3:
@@ -11617,7 +11618,7 @@
                     case 0:
                         isGraphAdded = options.isGraphAdded, isPrettifyed = options.isPrettifyed;
                         if (!isGraphAdded) return [3 /*break*/, 2];
-                        return [4 /*yield*/, pipelineStringToJson(pipelineString)];
+                        return [4 /*yield*/, compilePipeline(pipelineString)];
                     case 1:
                         pipelineJson = _a.sent();
                         promptbookMermaid_1 = renderPromptbookMermaid(pipelineJson, {
@@ -12311,7 +12312,7 @@
                         _m.label = 12;
                     case 12:
                         _m.trys.push([12, 14, , 15]);
-                        return [4 /*yield*/, pipelineStringToJson(pipelineString, tools)];
+                        return [4 /*yield*/, compilePipeline(pipelineString, tools)];
                     case 13:
                         pipeline = _m.sent();
                         return [3 /*break*/, 15];
@@ -12575,7 +12576,7 @@
                             return [4 /*yield*/, promises.readFile(filename, 'utf-8')];
                         case 7:
                             pipelineMarkdown = (_f.sent());
-                            return [4 /*yield*/, pipelineStringToJson(pipelineMarkdown, tools)];
+                            return [4 /*yield*/, compilePipeline(pipelineMarkdown, tools)];
                         case 8:
                             pipeline = _f.sent();
                             if (isVerbose) {