@promptbook/markdown-utils 0.94.0 → 0.98.0-2

package/esm/typings/src/scrapers/website/register-metadata.d.ts

@@ -10,7 +10,7 @@ export declare const websiteScraperMetadata: import("type-fest/source/readonly-d
     className: string;
     mimeTypes: string[];
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvilableInBrowser: false;
+    isAvailableInBrowser: false;
     requiredExecutables: never[];
 }>;
 /**
@@ -19,7 +19,7 @@ export declare const websiteScraperMetadata: import("type-fest/source/readonly-d
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
  *
  * @public exported from `@promptbook/core`
- * @public exported from `@promptbook/wizzard`
+ * @public exported from `@promptbook/wizard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _WebsiteScraperMetadataRegistration: Registration;

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

@@ -658,7 +658,7 @@ export type number_seed = number_percent;
  * - ❤ is equivalent to more than 1
  */
 export type number_likeness = number;
-export type number_miliseconds = number_integer;
+export type number_milliseconds = number_integer;
 export type number_seconds = number;
 export type number_minutes = number;
 export type number_hours = number;

package/esm/typings/src/utils/files/listAllFiles.d.ts

@@ -11,7 +11,7 @@ import type { string_filename } from '../../types/typeAliases';
  */
 export declare function listAllFiles(path: string_dirname, isRecursive: boolean, fs: FilesystemTools): Promise<Array<string_filename>>;
 /**
- * TODO: [😶] Unite floder listing
+ * TODO: [😶] Unite folder listing
  * Note: Not [~🟢~] because it is not directly dependent on `fs
  * TODO: [🖇] What about symlinks?
  */

package/esm/typings/src/version.d.ts

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.94.0-16`).
+ * It follows semantic versioning (e.g., `0.98.0-1`).
  *
  * @generated
  */

package/esm/typings/src/{wizzard → wizard}/$getCompiledBook.d.ts

@@ -5,9 +5,9 @@ import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions
 import type { string_filename } from '../types/typeAliases';
 import type { string_pipeline_url } from '../types/typeAliases';
 /**
- * @see ./wizzard.ts `getPipeline` method
+ * @see ./wizard.ts `getPipeline` method
  *
- * @private usable through `ptbk run` and `@prompbook/wizzard`
+ * @private usable through `ptbk run` and `@promptbook/wizard`
  */
 export declare function $getCompiledBook(tools: Required<Pick<ExecutionTools, 'fs' | 'fetch'>>, pipelineSource: string_filename | string_pipeline_url | PipelineString, options?: PrepareAndScrapeOptions): Promise<PipelineJson>;
 /**

package/esm/typings/src/{wizzard/wizzard.d.ts → wizard/wizard.d.ts}

@@ -7,14 +7,14 @@ import type { string_filename } from '../types/typeAliases';
 import type { string_parameter_value } from '../types/typeAliases';
 import type { string_pipeline_url } from '../types/typeAliases';
 /**
- * Wizzard for simple usage of the Promptbook
- * Look at `wizzard` for more details
+ * Wizard for simple usage of the Promptbook
+ * Look at `wizard` for more details
  *
  * Note: This works only in Node.js environment and looks for the configuration, environment, tools and cache in the Node.js environment
  *
  * @private just for single instance
  */
-declare class Wizzard {
+declare class Wizard {
     /**
      * Run the book
      *
@@ -53,14 +53,14 @@ declare class Wizzard {
     getCompiledBook(pipelineSource: string_filename | string_pipeline_url | PipelineString): Promise<PipelineJson>;
 }
 /**
- * Wizzard for simple usage of the Promptbook
+ * Wizard for simple usage of the Promptbook
  *
  * Note: This works only in Node.js environment and looks for the configuration, environment, tools and cache in the Node.js environment
  *
  * @singleton
- * @public exported from `@promptbook/wizzard`
+ * @public exported from `@promptbook/wizard`
  */
-export declare const wizzard: Wizzard;
+export declare const wizard: Wizard;
 export {};
 /**
  * TODO: [🧠] Maybe some way how to handle the progress and streaming?

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/markdown-utils",
-    "version": "0.94.0",
+    "version": "0.98.0-2",
     "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
     "private": false,
     "sideEffects": false,
@@ -70,18 +70,6 @@
         "node": ">=16.0.0",
         "npm": ">=8.0.0"
     },
-    "cspell": {
-        "version": "0.2",
-        "language": "en",
-        "ignorePaths": [
-            "node_modules",
-            ".next",
-            "coverage",
-            "dist",
-            ".git"
-        ],
-        "words": []
-    },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/markdown-utils.index.d.ts",

package/umd/index.umd.js

@@ -25,7 +25,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.94.0';
+    const PROMPTBOOK_ENGINE_VERSION = '0.98.0-2';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -552,7 +552,7 @@
     function keepUnused(...valuesToKeep) {
     }
 
-    var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.book",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:[],sources:[{type:"BOOK",path:null,content:"# Prepare Knowledge from Markdown\n\n-   PIPELINE URL `https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.book`\n-   INPUT PARAMETER `{knowledgeContent}` Markdown document content\n-   OUTPUT PARAMETER `{knowledgePieces}` The knowledge JSON object\n\n## Knowledge\n\n<!-- TODO: [🍆] -FORMAT JSON -->\n\n```markdown\nYou 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}\n```\n\n`-> {knowledgePieces}`\n"}],sourceFile:"./books/prepare-knowledge-from-markdown.book"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-keywords.book",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:[],sources:[{type:"BOOK",path:null,content:"# Prepare Keywords\n\n-   PIPELINE URL `https://promptbook.studio/promptbook/prepare-knowledge-keywords.book`\n-   INPUT PARAMETER `{knowledgePieceContent}` The content\n-   OUTPUT PARAMETER `{keywords}` Keywords separated by comma\n\n## Knowledge\n\n<!-- TODO: [🍆] -FORMAT JSON -->\n\n```markdown\nYou 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}\n```\n\n`-> {keywords}`\n"}],sourceFile:"./books/prepare-knowledge-keywords.book"},{title:"Prepare Knowledge-piece Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-title.book",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-   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:[],sources:[{type:"BOOK",path:null,content:"# Prepare Knowledge-piece Title\n\n-   PIPELINE URL `https://promptbook.studio/promptbook/prepare-knowledge-title.book`\n-   INPUT PARAMETER `{knowledgePieceContent}` The content\n-   OUTPUT PARAMETER `{title}` The title of the document\n\n## Knowledge\n\n-   EXPECT MIN 1 WORD\n-   EXPECT MAX 8 WORDS\n\n```markdown\nYou are experienced content creator, write best title for the document.\n\n# Rules\n\n-   Write just title, nothing else\n-   Write maximum 5 words for the title\n\n# The document\n\n> {knowledgePieceContent}\n```\n\n`-> {title}`\n"}],sourceFile:"./books/prepare-knowledge-title.book"},{title:"Prepare Persona",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.book",formfactorName:"GENERIC",parameters:[{name:"availableModels",description:"List of available model names together with their descriptions as JSON",isInput:true,isOutput:false},{name:"personaDescription",description:"Description of the persona",isInput:true,isOutput:false},{name:"modelsRequirements",description:"Specific requirements for the model",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"make-model-requirements",title:"Make modelRequirements",content:"You are an experienced AI engineer, you need to find the best models for virtual assistants:\n\n## Example\n\n```json\n[\n  {\n  \"modelName\": \"gpt-4o\",\n  \"systemMessage\": \"You are experienced AI engineer and helpfull assistant.\",\n  \"temperature\": 0.7\n  },\n  {\n    \"modelName\": \"claude-3-5-sonnet\",\n    \"systemMessage\": \"You are a friendly and knowledgeable chatbot.\",\n    \"temperature\": 0.5\n  }\n]\n```\n\n## Instructions\n\n-   Your output format is JSON array\n-   Sort best-fitting models first\n-   Omit any models that are not suitable\n-   Write just the JSON, no other text should be present\n-   Array contain items with 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\nHere are the available models:\n\n```json\n{availableModels}\n```\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:"modelsRequirements",format:"JSON",dependentParameterNames:["availableModels","personaDescription"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Persona\n\n-   PIPELINE URL `https://promptbook.studio/promptbook/prepare-persona.book`\n-   INPUT PARAMETER `{availableModels}` List of available model names together with their descriptions as JSON\n-   INPUT PARAMETER `{personaDescription}` Description of the persona\n-   OUTPUT PARAMETER `{modelsRequirements}` Specific requirements for the model\n\n## Make modelRequirements\n\n-   FORMAT JSON\n\n```markdown\nYou are an experienced AI engineer, you need to find the best models for virtual assistants:\n\n## Example\n\n\\`\\`\\`json\n[\n  {\n  \"modelName\": \"gpt-4o\",\n  \"systemMessage\": \"You are experienced AI engineer and helpfull assistant.\",\n  \"temperature\": 0.7\n  },\n  {\n    \"modelName\": \"claude-3-5-sonnet\",\n    \"systemMessage\": \"You are a friendly and knowledgeable chatbot.\",\n    \"temperature\": 0.5\n  }\n]\n\\`\\`\\`\n\n## Instructions\n\n-   Your output format is JSON array\n-   Sort best-fitting models first\n-   Omit any models that are not suitable\n-   Write just the JSON, no other text should be present\n-   Array contain items with 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\nHere are the available models:\n\n\\`\\`\\`json\n{availableModels}\n\\`\\`\\`\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}\n```\n\n`-> {modelsRequirements}`\n"}],sourceFile:"./books/prepare-persona.book"},{title:"Prepare Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-title.book",formfactorName:"GENERIC",parameters:[{name:"book",description:"The book to prepare the title for",isInput:true,isOutput:false},{name:"title",description:"Best title for the book",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"make-title",title:"Make title",content:"Make best title for given text which describes the workflow:\n\n## Rules\n\n-   Write just title, nothing else\n-   Title should be concise and clear - Write maximum ideally 2 words, maximum 5 words\n-   Title starts with emoticon\n-   Title should not mention the input and output of the workflow but the main purpose of the workflow\n    _For example, not \"✍ Convert Knowledge-piece to title\" but \"✍ Title\"_\n\n## The workflow\n\n> {book}",resultingParameterName:"title",expectations:{words:{min:1,max:8},lines:{min:1,max:1}},dependentParameterNames:["book"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Title\n\n-   PIPELINE URL `https://promptbook.studio/promptbook/prepare-title.book`\n-   INPUT PARAMETER `{book}` The book to prepare the title for\n-   OUTPUT PARAMETER `{title}` Best title for the book\n\n## Make title\n\n-   EXPECT MIN 1 Word\n-   EXPECT MAX 8 Words\n-   EXPECT EXACTLY 1 Line\n\n```markdown\nMake best title for given text which describes the workflow:\n\n## Rules\n\n-   Write just title, nothing else\n-   Title should be concise and clear - Write maximum ideally 2 words, maximum 5 words\n-   Title starts with emoticon\n-   Title should not mention the input and output of the workflow but the main purpose of the workflow\n    _For example, not \"✍ Convert Knowledge-piece to title\" but \"✍ Title\"_\n\n## The workflow\n\n> {book}\n```\n\n`-> {title}`\n"}],sourceFile:"./books/prepare-title.book"}];
+    var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.book",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:[],sources:[{type:"BOOK",path:null,content:"# Prepare Knowledge from Markdown\n\n-   PIPELINE URL `https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.book`\n-   INPUT PARAMETER `{knowledgeContent}` Markdown document content\n-   OUTPUT PARAMETER `{knowledgePieces}` The knowledge JSON object\n\n## Knowledge\n\n<!-- TODO: [🍆] -FORMAT JSON -->\n\n```markdown\nYou 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}\n```\n\n`-> {knowledgePieces}`\n"}],sourceFile:"./books/prepare-knowledge-from-markdown.book"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-keywords.book",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:[],sources:[{type:"BOOK",path:null,content:"# Prepare Keywords\n\n-   PIPELINE URL `https://promptbook.studio/promptbook/prepare-knowledge-keywords.book`\n-   INPUT PARAMETER `{knowledgePieceContent}` The content\n-   OUTPUT PARAMETER `{keywords}` Keywords separated by comma\n\n## Knowledge\n\n<!-- TODO: [🍆] -FORMAT JSON -->\n\n```markdown\nYou 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}\n```\n\n`-> {keywords}`\n"}],sourceFile:"./books/prepare-knowledge-keywords.book"},{title:"Prepare Knowledge-piece Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-title.book",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-   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:[],sources:[{type:"BOOK",path:null,content:"# Prepare Knowledge-piece Title\n\n-   PIPELINE URL `https://promptbook.studio/promptbook/prepare-knowledge-title.book`\n-   INPUT PARAMETER `{knowledgePieceContent}` The content\n-   OUTPUT PARAMETER `{title}` The title of the document\n\n## Knowledge\n\n-   EXPECT MIN 1 WORD\n-   EXPECT MAX 8 WORDS\n\n```markdown\nYou are experienced content creator, write best title for the document.\n\n# Rules\n\n-   Write just title, nothing else\n-   Write maximum 5 words for the title\n\n# The document\n\n> {knowledgePieceContent}\n```\n\n`-> {title}`\n"}],sourceFile:"./books/prepare-knowledge-title.book"},{title:"Prepare Persona",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.book",formfactorName:"GENERIC",parameters:[{name:"availableModels",description:"List of available model names together with their descriptions as JSON",isInput:true,isOutput:false},{name:"personaDescription",description:"Description of the persona",isInput:true,isOutput:false},{name:"modelsRequirements",description:"Specific requirements for the model",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"make-model-requirements",title:"Make modelRequirements",content:"You are an experienced AI engineer, you need to find the best models for virtual assistants:\n\n## Example\n\n```json\n[\n  {\n  \"modelName\": \"gpt-4o\",\n  \"systemMessage\": \"You are experienced AI engineer and helpful assistant.\",\n  \"temperature\": 0.7\n  },\n  {\n    \"modelName\": \"claude-3-5-sonnet\",\n    \"systemMessage\": \"You are a friendly and knowledgeable chatbot.\",\n    \"temperature\": 0.5\n  }\n]\n```\n\n## Instructions\n\n-   Your output format is JSON array\n-   Sort best-fitting models first\n-   Omit any models that are not suitable\n-   Write just the JSON, no other text should be present\n-   Array contain items with 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\nHere are the available models:\n\n```json\n{availableModels}\n```\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:"modelsRequirements",format:"JSON",dependentParameterNames:["availableModels","personaDescription"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Persona\n\n-   PIPELINE URL `https://promptbook.studio/promptbook/prepare-persona.book`\n-   INPUT PARAMETER `{availableModels}` List of available model names together with their descriptions as JSON\n-   INPUT PARAMETER `{personaDescription}` Description of the persona\n-   OUTPUT PARAMETER `{modelsRequirements}` Specific requirements for the model\n\n## Make modelRequirements\n\n-   FORMAT JSON\n\n```markdown\nYou are an experienced AI engineer, you need to find the best models for virtual assistants:\n\n## Example\n\n\\`\\`\\`json\n[\n  {\n  \"modelName\": \"gpt-4o\",\n  \"systemMessage\": \"You are experienced AI engineer and helpful assistant.\",\n  \"temperature\": 0.7\n  },\n  {\n    \"modelName\": \"claude-3-5-sonnet\",\n    \"systemMessage\": \"You are a friendly and knowledgeable chatbot.\",\n    \"temperature\": 0.5\n  }\n]\n\\`\\`\\`\n\n## Instructions\n\n-   Your output format is JSON array\n-   Sort best-fitting models first\n-   Omit any models that are not suitable\n-   Write just the JSON, no other text should be present\n-   Array contain items with 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\nHere are the available models:\n\n\\`\\`\\`json\n{availableModels}\n\\`\\`\\`\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}\n```\n\n`-> {modelsRequirements}`\n"}],sourceFile:"./books/prepare-persona.book"},{title:"Prepare Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-title.book",formfactorName:"GENERIC",parameters:[{name:"book",description:"The book to prepare the title for",isInput:true,isOutput:false},{name:"title",description:"Best title for the book",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"make-title",title:"Make title",content:"Make best title for given text which describes the workflow:\n\n## Rules\n\n-   Write just title, nothing else\n-   Title should be concise and clear - Write maximum ideally 2 words, maximum 5 words\n-   Title starts with emoticon\n-   Title should not mention the input and output of the workflow but the main purpose of the workflow\n    _For example, not \"✍ Convert Knowledge-piece to title\" but \"✍ Title\"_\n\n## The workflow\n\n> {book}",resultingParameterName:"title",expectations:{words:{min:1,max:8},lines:{min:1,max:1}},dependentParameterNames:["book"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Title\n\n-   PIPELINE URL `https://promptbook.studio/promptbook/prepare-title.book`\n-   INPUT PARAMETER `{book}` The book to prepare the title for\n-   OUTPUT PARAMETER `{title}` Best title for the book\n\n## Make title\n\n-   EXPECT MIN 1 Word\n-   EXPECT MAX 8 Words\n-   EXPECT EXACTLY 1 Line\n\n```markdown\nMake best title for given text which describes the workflow:\n\n## Rules\n\n-   Write just title, nothing else\n-   Title should be concise and clear - Write maximum ideally 2 words, maximum 5 words\n-   Title starts with emoticon\n-   Title should not mention the input and output of the workflow but the main purpose of the workflow\n    _For example, not \"✍ Convert Knowledge-piece to title\" but \"✍ Title\"_\n\n## The workflow\n\n> {book}\n```\n\n`-> {title}`\n"}],sourceFile:"./books/prepare-title.book"}];
 
     /**
      * Checks if value is valid email
@@ -701,7 +701,7 @@
             });
         }
         catch (error) {
-            // TODO: [🟥] Detect browser / node and make it colorfull
+            // TODO: [🟥] Detect browser / node and make it colorful
             console.error('There was an error with prettifying the markdown, using the original as the fallback', {
                 error,
                 html: content,
@@ -974,7 +974,7 @@
             else {
                 for (const [subName, subValue] of Object.entries(value)) {
                     if (subValue === undefined) {
-                        // Note: undefined in object is serializable - it is just omited
+                        // Note: undefined in object is serializable - it is just omitted
                         continue;
                     }
                     checkSerializableAsJson({ name: `${name}.${subName}`, value: subValue, message });
@@ -1664,7 +1664,7 @@
 
                         Note: You have probably forgotten to run "ptbk make" to update the collection
                         Note: Pipelines with the same URL are not allowed
-                              Only exepction is when the pipelines are identical
+                              Only exception is when the pipelines are identical
 
                     `));
                 }
@@ -2458,12 +2458,12 @@
             get title() {
                 return `${llmTools.title} (+usage)`;
                 // <- TODO: [🧈] Maybe standartize the suffix when wrapping `LlmExecutionTools` up
-                // <- TODO: [🧈][🧠] Does it make sence to suffix "(+usage)"?
+                // <- TODO: [🧈][🧠] Does it make sense to suffix "(+usage)"?
             },
             get description() {
                 return `${llmTools.description} (+usage)`;
                 // <- TODO: [🧈] Maybe standartize the suffix when wrapping `LlmExecutionTools` up
-                // <- TODO: [🧈][🧠] Does it make sence to suffix "(+usage)"?
+                // <- TODO: [🧈][🧠] Does it make sense to suffix "(+usage)"?
             },
             checkConfiguration() {
                 return /* not await */ llmTools.checkConfiguration();
@@ -2690,13 +2690,13 @@
 
             Technically, it's not an error, but it's probably not what you want because it does not make sense to use Promptbook without language models.
         `);
-            // TODO: [🟥] Detect browser / node and make it colorfull
+            // TODO: [🟥] Detect browser / node and make it colorful
             console.warn(warningMessage);
             // <- TODO: [🏮] Some standard way how to transform errors into warnings and how to handle non-critical fails during the tasks
             /*
             return {
                 async listModels() {
-                    // TODO: [🟥] Detect browser / node and make it colorfull
+                    // TODO: [🟥] Detect browser / node and make it colorful
                     console.warn(
                         spaceTrim(
                             (block) => `
@@ -2972,17 +2972,17 @@
          * Mixes registered scrapers from $scrapersMetadataRegister and $scrapersRegister
          */
         const all = [];
-        for (const { packageName, className, mimeTypes, documentationUrl, isAvilableInBrowser, } of $scrapersMetadataRegister.list()) {
+        for (const { packageName, className, mimeTypes, documentationUrl, isAvailableInBrowser, } of $scrapersMetadataRegister.list()) {
             if (all.some((item) => item.packageName === packageName && item.className === className)) {
                 continue;
             }
-            all.push({ packageName, className, mimeTypes, documentationUrl, isAvilableInBrowser });
+            all.push({ packageName, className, mimeTypes, documentationUrl, isAvailableInBrowser });
         }
-        for (const { packageName, className, mimeTypes, documentationUrl, isAvilableInBrowser, } of $scrapersRegister.list()) {
+        for (const { packageName, className, mimeTypes, documentationUrl, isAvailableInBrowser, } of $scrapersRegister.list()) {
             if (all.some((item) => item.packageName === packageName && item.className === className)) {
                 continue;
             }
-            all.push({ packageName, className, mimeTypes, documentationUrl, isAvilableInBrowser });
+            all.push({ packageName, className, mimeTypes, documentationUrl, isAvailableInBrowser });
         }
         for (const { metadata } of availableScrapers) {
             all.push(metadata);
@@ -2994,8 +2994,8 @@
             const isInstalled = $scrapersRegister
                 .list()
                 .find(({ packageName, className }) => metadata.packageName === packageName && metadata.className === className);
-            const isAvilableInTools = availableScrapers.some(({ metadata: { packageName, className } }) => metadata.packageName === packageName && metadata.className === className);
-            return { ...metadata, isMetadataAviailable, isInstalled, isAvilableInTools };
+            const isAvailableInTools = availableScrapers.some(({ metadata: { packageName, className } }) => metadata.packageName === packageName && metadata.className === className);
+            return { ...metadata, isMetadataAviailable, isInstalled, isAvailableInTools };
         });
         if (metadata.length === 0) {
             return spaceTrim__default["default"](`
@@ -3008,7 +3008,7 @@
         return spaceTrim__default["default"]((block) => `
             Available scrapers are:
             ${block(metadata
-        .map(({ packageName, className, isMetadataAviailable, isInstalled, mimeTypes, isAvilableInBrowser, isAvilableInTools, }, i) => {
+        .map(({ packageName, className, isMetadataAviailable, isInstalled, mimeTypes, isAvailableInBrowser, isAvailableInTools, }, i) => {
         const more = [];
         // TODO: [🧠] Maybe use `documentationUrl`
         if (isMetadataAviailable) {
@@ -3017,16 +3017,16 @@
         if (isInstalled) {
             more.push(`🟩 Installed`);
         } // not else
-        if (isAvilableInTools) {
+        if (isAvailableInTools) {
             more.push(`🟦 Available in tools`);
         } // not else
         if (!isMetadataAviailable && isInstalled) {
             more.push(`When no metadata registered but scraper is installed, it is an unexpected behavior`);
         } // not else
-        if (!isInstalled && isAvilableInTools) {
+        if (!isInstalled && isAvailableInTools) {
             more.push(`When the scraper is not installed but available in tools, it is an unexpected compatibility behavior`);
         } // not else
-        if (!isAvilableInBrowser) {
+        if (!isAvailableInBrowser) {
             more.push(`Not usable in browser`);
         }
         const moreText = more.length === 0 ? '' : ` *(${more.join('; ')})*`;
@@ -3753,7 +3753,7 @@
     /**
      * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
      *       Put `knowledgePieces` into `PrepareKnowledgeOptions`
-     * TODO: [🪂] More than max things can run in parallel by acident [1,[2a,2b,_],[3a,3b,_]]
+     * TODO: [🪂] More than max things can run in parallel by accident [1,[2a,2b,_],[3a,3b,_]]
      * TODO: [🧠][❎] Do here proper M:N mapping
      *       [x] One source can make multiple pieces
      *       [ ] One piece can have multiple sources
@@ -5323,10 +5323,10 @@
      */
     async function getKnowledgeForTask(options) {
         const { tools, preparedPipeline, task, parameters } = options;
-        const firstKnowlegePiece = preparedPipeline.knowledgePieces[0];
-        const firstKnowlegeIndex = firstKnowlegePiece === null || firstKnowlegePiece === void 0 ? void 0 : firstKnowlegePiece.index[0];
+        const firstKnowledgePiece = preparedPipeline.knowledgePieces[0];
+        const firstKnowledgeIndex = firstKnowledgePiece === null || firstKnowledgePiece === void 0 ? void 0 : firstKnowledgePiece.index[0];
         // <- TODO: Do not use just first knowledge piece and first index to determine embedding model, use also keyword search
-        if (firstKnowlegePiece === undefined || firstKnowlegeIndex === undefined) {
+        if (firstKnowledgePiece === undefined || firstKnowledgeIndex === undefined) {
             return ''; // <- Note: Np knowledge present, return empty string
         }
         try {
@@ -5337,7 +5337,7 @@
                 title: 'Knowledge Search',
                 modelRequirements: {
                     modelVariant: 'EMBEDDING',
-                    modelName: firstKnowlegeIndex.modelName,
+                    modelName: firstKnowledgeIndex.modelName,
                 },
                 content: task.content,
                 parameters,
@@ -5345,7 +5345,7 @@
             const taskEmbeddingResult = await llmTools.callEmbeddingModel(taskEmbeddingPrompt);
             const knowledgePiecesWithRelevance = preparedPipeline.knowledgePieces.map((knowledgePiece) => {
                 const { index } = knowledgePiece;
-                const knowledgePieceIndex = index.find((i) => i.modelName === firstKnowlegeIndex.modelName);
+                const knowledgePieceIndex = index.find((i) => i.modelName === firstKnowledgeIndex.modelName);
                 // <- TODO: Do not use just first knowledge piece and first index to determine embedding model
                 if (knowledgePieceIndex === undefined) {
                     return {
@@ -5366,8 +5366,8 @@
                 task,
                 taskEmbeddingPrompt,
                 taskEmbeddingResult,
-                firstKnowlegePiece,
-                firstKnowlegeIndex,
+                firstKnowledgePiece,
+                firstKnowledgeIndex,
                 knowledgePiecesWithRelevance,
                 knowledgePiecesSorted,
                 knowledgePiecesLimited,
@@ -5436,7 +5436,7 @@
      * @private internal utility of `createPipelineExecutor`
      */
     async function executeTask(options) {
-        const { currentTask, preparedPipeline, parametersToPass, tools, onProgress, $executionReport, pipelineIdentification, maxExecutionAttempts, maxParallelCount, csvSettings, isVerbose, rootDirname, cacheDirname, intermediateFilesStrategy, isAutoInstalled, isNotPreparedWarningSupressed, } = options;
+        const { currentTask, preparedPipeline, parametersToPass, tools, onProgress, $executionReport, pipelineIdentification, maxExecutionAttempts, maxParallelCount, csvSettings, isVerbose, rootDirname, cacheDirname, intermediateFilesStrategy, isAutoInstalled, isNotPreparedWarningSuppressed, } = options;
         const priority = preparedPipeline.tasks.length - preparedPipeline.tasks.indexOf(currentTask);
         // Note: Check consistency of used and dependent parameters which was also done in `validatePipeline`, but it’s good to doublecheck
         const usedParameterNames = extractParameterNamesFromTask(currentTask);
@@ -5524,7 +5524,7 @@
             cacheDirname,
             intermediateFilesStrategy,
             isAutoInstalled,
-            isNotPreparedWarningSupressed,
+            isNotPreparedWarningSuppressed,
         });
         await onProgress({
             outputParameters: {
@@ -5619,7 +5619,7 @@
                 }
                 return exportJson({
                     name: `executionReport`,
-                    message: `Unuccessful PipelineExecutorResult (with missing parameter {${parameter.name}}) PipelineExecutorResult`,
+                    message: `Unsuccessful PipelineExecutorResult (with missing parameter {${parameter.name}}) PipelineExecutorResult`,
                     order: [],
                     value: {
                         isSuccessful: false,
@@ -5656,7 +5656,7 @@
                 return exportJson({
                     name: 'pipelineExecutorResult',
                     message: spaceTrim.spaceTrim((block) => `
-                        Unuccessful PipelineExecutorResult (with extra parameter {${parameter.name}}) PipelineExecutorResult
+                        Unsuccessful PipelineExecutorResult (with extra parameter {${parameter.name}}) PipelineExecutorResult
 
                         ${block(pipelineIdentification)}
                     `),
@@ -5797,7 +5797,7 @@
             }
             return exportJson({
                 name: 'pipelineExecutorResult',
-                message: `Unuccessful PipelineExecutorResult (with misc errors) PipelineExecutorResult`,
+                message: `Unsuccessful PipelineExecutorResult (with misc errors) PipelineExecutorResult`,
                 order: [],
                 value: {
                     isSuccessful: false,
@@ -5848,7 +5848,7 @@
      * @public exported from `@promptbook/core`
      */
     function createPipelineExecutor(options) {
-        const { pipeline, tools, maxExecutionAttempts = DEFAULT_MAX_EXECUTION_ATTEMPTS, maxParallelCount = DEFAULT_MAX_PARALLEL_COUNT, csvSettings = DEFAULT_CSV_SETTINGS, isVerbose = DEFAULT_IS_VERBOSE, isNotPreparedWarningSupressed = false, cacheDirname = DEFAULT_SCRAPE_CACHE_DIRNAME, intermediateFilesStrategy = DEFAULT_INTERMEDIATE_FILES_STRATEGY, isAutoInstalled = DEFAULT_IS_AUTO_INSTALLED, rootDirname = null, } = options;
+        const { pipeline, tools, maxExecutionAttempts = DEFAULT_MAX_EXECUTION_ATTEMPTS, maxParallelCount = DEFAULT_MAX_PARALLEL_COUNT, csvSettings = DEFAULT_CSV_SETTINGS, isVerbose = DEFAULT_IS_VERBOSE, isNotPreparedWarningSuppressed = false, cacheDirname = DEFAULT_SCRAPE_CACHE_DIRNAME, intermediateFilesStrategy = DEFAULT_INTERMEDIATE_FILES_STRATEGY, isAutoInstalled = DEFAULT_IS_AUTO_INSTALLED, rootDirname = null, } = options;
         validatePipeline(pipeline);
         const pipelineIdentification = (() => {
             // Note: This is a 😐 implementation of [🚞]
@@ -5865,7 +5865,7 @@
         if (isPipelinePrepared(pipeline)) {
             preparedPipeline = pipeline;
         }
-        else if (isNotPreparedWarningSupressed !== true) {
+        else if (isNotPreparedWarningSuppressed !== true) {
             console.warn(spaceTrim.spaceTrim((block) => `
                     Pipeline is not prepared
 
@@ -5898,7 +5898,7 @@
                 maxParallelCount,
                 csvSettings,
                 isVerbose,
-                isNotPreparedWarningSupressed,
+                isNotPreparedWarningSuppressed,
                 rootDirname,
                 cacheDirname,
                 intermediateFilesStrategy,
@@ -5907,7 +5907,7 @@
                 assertsError(error);
                 return exportJson({
                     name: 'pipelineExecutorResult',
-                    message: `Unuccessful PipelineExecutorResult, last catch`,
+                    message: `Unsuccessful PipelineExecutorResult, last catch`,
                     order: [],
                     value: {
                         isSuccessful: false,
@@ -5945,7 +5945,7 @@
         className: 'MarkdownScraper',
         mimeTypes: ['text/markdown', 'text/plain'],
         documentationUrl: 'https://github.com/webgptorg/promptbook/discussions/@@',
-        isAvilableInBrowser: true,
+        isAvailableInBrowser: true,
         // <- Note: [🌏] This is the only scraper which makes sense to be available in the browser, for scraping non-markdown sources in the browser use a remote server
         requiredExecutables: [],
     }); /* <- Note: [🤛] */
@@ -5955,7 +5955,7 @@
      * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
      *
      * @public exported from `@promptbook/core`
-     * @public exported from `@promptbook/wizzard`
+     * @public exported from `@promptbook/wizard`
      * @public exported from `@promptbook/cli`
      */
     $scrapersMetadataRegister.register(markdownScraperMetadata);
@@ -6054,7 +6054,7 @@
                     }
                     // ---
                     if (!llmTools.callEmbeddingModel) {
-                        // TODO: [🟥] Detect browser / node and make it colorfull
+                        // TODO: [🟥] Detect browser / node and make it colorful
                         console.error('No callEmbeddingModel function provided');
                     }
                     else {
@@ -6080,7 +6080,7 @@
                     if (!(error instanceof PipelineExecutionError)) {
                         throw error;
                     }
-                    // TODO: [🟥] Detect browser / node and make it colorfull
+                    // TODO: [🟥] Detect browser / node and make it colorful
                     console.error(error, "<- Note: This error is not critical to prepare the pipeline, just knowledge pieces won't have embeddings");
                 }
                 return {
@@ -6118,7 +6118,7 @@
      * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
      *
      * @public exported from `@promptbook/markdown-utils`
-     * @public exported from `@promptbook/wizzard`
+     * @public exported from `@promptbook/wizard`
      * @public exported from `@promptbook/cli`
      */
     const _MarkdownScraperRegistration = $scrapersRegister.register(createMarkdownScraper);