@promptbook/markdown-utils 0.72.0 → 0.74.0-0

package/README.md

@@ -18,10 +18,16 @@ Build responsible, controlled and transparent applications on top of LLM models!
 
 ## ✨ New Features
 
+-   💙 Working on [the **Book** language v1](https://github.com/webgptorg/book)
+-   📚 Support of `.docx`, `.doc` and `.pdf` documents
 -   ✨ **Support of [OpenAI o1 model](https://openai.com/o1/)**
 
 
 
+<blockquote style="color: #ff8811">
+    <b>⚠ Warning:</b> This is a pre-release version of the library. It is not yet ready for production use. Please look at <a href="https://www.npmjs.com/package/@promptbook/core?activeTab=versions">latest stable release</a>.
+</blockquote>
+
 ## 📦 Package `@promptbook/markdown-utils`
 
 - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -50,7 +56,7 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
 
 If you have a simple, single prompt for ChatGPT, GPT-4, Anthropic Claude, Google Gemini, Llama 3, or whatever, it doesn't matter how you integrate it. Whether it's calling a REST API directly, using the SDK, hardcoding the prompt into the source code, or importing a text file, the process remains the same.
 
-But often you will struggle with the **limitations of LLMs**, such as **hallucinations, off-topic responses, poor quality output, language and prompt drift, word repetition repetition repetition repetition or misuse, lack of context, or just plain w𝒆𝐢rd responses**. When this happens, you generally have three options:
+But often you will struggle with the **limitations of LLMs**, such as **hallucinations, off-topic responses, poor quality output, language and prompt drift, word repetition repetition repetition repetition or misuse, lack of context, or just plain w𝒆𝐢rd resp0nses**. When this happens, you generally have three options:
 
 1. **Fine-tune** the model to your specifications or even train your own.
 2. **Prompt-engineer** the prompt to the best shape you can achieve.
@@ -58,248 +64,87 @@ But often you will struggle with the **limitations of LLMs**, such as **hallucin
 
 In all of these situations, but especially in 3., the **✨ Promptbook can make your life waaaaaaaaaay easier**.
 
--   [**Separates concerns**](https://github.com/webgptorg/promptbook/discussions/32) between prompt-engineer and programmer, between code files and prompt files, and between prompts and their execution logic.
--   Establishes a [**common format `.ptbk.md`**](https://github.com/webgptorg/promptbook/discussions/85) that can be used to describe your prompt business logic without having to write code or deal with the technicalities of LLMs.
--   **Forget** about **low-level details** like choosing the right model, tokens, context size, temperature, top-k, top-p, or kernel sampling. **Just write your intent** and [**persona**](https://github.com/webgptorg/promptbook/discussions/22) who should be responsible for the task and let the library do the rest.
--   Has built-in **orchestration** of [pipeline](https://github.com/webgptorg/promptbook/discussions/64) execution and many tools to make the process easier, more reliable, and more efficient, such as caching, [compilation+preparation](https://github.com/webgptorg/promptbook/discussions/78), [just-in-time fine-tuning](https://github.com/webgptorg/promptbook/discussions/33), [expectation-aware generation](https://github.com/webgptorg/promptbook/discussions/37), [agent adversary expectations](https://github.com/webgptorg/promptbook/discussions/39), and more.
+-   [**Separates concerns**](https://github.com/webgptorg/promptbook/discussions/32) between prompt-engineer and programmer, between code files and prompt files, and between prompts and their execution logic. For this purpose, it introduces a new language called [the **💙 Book**](https://github.com/webgptorg/book).
+-   Book allows you to **focus on the business** logic without having to write code or deal with the technicalities of LLMs.
+-   **Forget** about **low-level details** like choosing the right model, tokens, context size, `temperature`, `top-k`, `top-p`, or kernel sampling. **Just write your intent** and [**persona**](https://github.com/webgptorg/promptbook/discussions/22) who should be responsible for the task and let the library do the rest.
+-   We have built-in **orchestration** of [pipeline](https://github.com/webgptorg/promptbook/discussions/64) execution and many tools to make the process easier, more reliable, and more efficient, such as caching, [compilation+preparation](https://github.com/webgptorg/promptbook/discussions/78), [just-in-time fine-tuning](https://github.com/webgptorg/promptbook/discussions/33), [expectation-aware generation](https://github.com/webgptorg/promptbook/discussions/37), [agent adversary expectations](https://github.com/webgptorg/promptbook/discussions/39), and more.
 -   Sometimes even the best prompts with the best framework like Promptbook `:)` can't avoid the problems. In this case, the library has built-in **[anomaly detection](https://github.com/webgptorg/promptbook/discussions/40) and logging** to help you find and fix the problems.
--   Promptbook has built in versioning. You can test multiple **A/B versions** of pipelines and see which one works best.
--   Promptbook is designed to do [**RAG** (Retrieval-Augmented Generation)](https://github.com/webgptorg/promptbook/discussions/41) and other advanced techniques. You can use **knowledge** to improve the quality of the output.
-
-
-
-## 🧔 Pipeline _(for prompt-engeneers)_
-
-**P**romp**t** **b**oo**k** markdown file (or `.ptbk.md` file) is document that describes a **pipeline** - a series of prompts that are chained together to form somewhat reciepe for transforming natural language input.
-
--   Multiple pipelines forms a **collection** which will handle core **know-how of your LLM application**.
--   Theese pipelines are designed such as they **can be written by non-programmers**.
-
-
-
-### Sample:
-
-File `write-website-content.ptbk.md`:
-
-
-
-
-
-> # 🌍 Create website content
->
-> Instructions for creating web page content.
->
-> -   PIPELINE URL https://promptbook.studio/webgpt/write-website-content.ptbk.md
-> -   INPUT  PARAM `{rawTitle}` Automatically suggested a site name or empty text
-> -   INPUT  PARAM `{rawAssigment}` Automatically generated site entry from image recognition
-> -   OUTPUT PARAM `{websiteContent}` Web content
-> -   OUTPUT PARAM `{keywords}` Keywords
->
-> ## 👤 Specifying the assigment
->
-> What is your web about?
->
-> -   DIALOG TEMPLATE
->
-> ```
-> {rawAssigment}
-> ```
->
-> `-> {assigment}` Website assignment and specification
->
-> ## ✨ Improving the title
->
-> -   PERSONA Jane, Copywriter and Marketing Specialist.
->
-> ```
-> As an experienced marketing specialist, you have been entrusted with improving the name of your client's business.
->
-> A suggested name from a client:
-> "{rawTitle}"
->
-> Assignment from customer:
->
-> > {assigment}
->
-> ## Instructions:
->
-> -   Write only one name suggestion
-> -   The name will be used on the website, business cards, visuals, etc.
-> ```
->
-> `-> {enhancedTitle}` Enhanced title
->
-> ## 👤 Website title approval
->
-> Is the title for your website okay?
->
-> -   DIALOG TEMPLATE
->
-> ```
-> {enhancedTitle}
-> ```
->
-> `-> {title}` Title for the website
->
-> ## 🐰 Cunning subtitle
->
-> -   PERSONA Josh, a copywriter, tasked with creating a claim for the website.
->
-> ```
-> As an experienced copywriter, you have been entrusted with creating a claim for the "{title}" web page.
->
-> A website assignment from a customer:
->
-> > {assigment}
->
-> ## Instructions:
->
-> -   Write only one name suggestion
-> -   Claim will be used on website, business cards, visuals, etc.
-> -   Claim should be punchy, funny, original
-> ```
->
-> `-> {claim}` Claim for the web
->
-> ## 🚦 Keyword analysis
->
-> -   PERSONA Paul, extremely creative SEO specialist.
->
-> ```
-> As an experienced SEO specialist, you have been entrusted with creating keywords for the website "{title}".
->
-> Website assignment from the customer:
->
-> > {assigment}
->
-> ## Instructions:
->
-> -   Write a list of keywords
-> -   Keywords are in basic form
->
-> ## Example:
->
-> -   Ice cream
-> -   Olomouc
-> -   Quality
-> -   Family
-> -   Tradition
-> -   Italy
-> -   Craft
->
-> ```
->
-> `-> {keywords}` Keywords
->
-> ## 🔗 Combine the beginning
->
-> -   SIMPLE TEMPLATE
->
-> ```
->
-> # {title}
->
-> > {claim}
->
-> ```
->
-> `-> {contentBeginning}` Beginning of web content
->
-> ## 🖋 Write the content
->
-> -   PERSONA Jane
->
-> ```
-> As an experienced copywriter and web designer, you have been entrusted with creating text for a new website {title}.
->
-> A website assignment from a customer:
->
-> > {assigment}
->
-> ## Instructions:
->
-> -   Text formatting is in Markdown
-> -   Be concise and to the point
-> -   Use keywords, but they should be naturally in the text
-> -   This is the complete content of the page, so don't forget all the important information and elements the page should contain
-> -   Use headings, bullets, text formatting
->
-> ## Keywords:
->
-> {keywords}
->
-> ## Web Content:
->
-> {contentBeginning}
-> ```
->
-> `-> {contentBody}` Middle of the web content
->
-> ## 🔗 Combine the content
->
-> -   SIMPLE TEMPLATE
->
-> ```markdown
-> {contentBeginning}
->
-> {contentBody}
-> ```
->
-> `-> {websiteContent}`
-
-
-
-Following is the scheme how the promptbook above is executed:
-
-```mermaid
-%% 🔮 Tip: Open this on GitHub or in the VSCode website to see the Mermaid graph visually
-
-flowchart LR
-  subgraph "🌍 Create website content"
-
-      direction TB
-
-      input((Input)):::input
-      templateSpecifyingTheAssigment(👤 Specifying the assigment)
-      input--"{rawAssigment}"-->templateSpecifyingTheAssigment
-      templateImprovingTheTitle(✨ Improving the title)
-      input--"{rawTitle}"-->templateImprovingTheTitle
-      templateSpecifyingTheAssigment--"{assigment}"-->templateImprovingTheTitle
-      templateWebsiteTitleApproval(👤 Website title approval)
-      templateImprovingTheTitle--"{enhancedTitle}"-->templateWebsiteTitleApproval
-      templateCunningSubtitle(🐰 Cunning subtitle)
-      templateWebsiteTitleApproval--"{title}"-->templateCunningSubtitle
-      templateSpecifyingTheAssigment--"{assigment}"-->templateCunningSubtitle
-      templateKeywordAnalysis(🚦 Keyword analysis)
-      templateWebsiteTitleApproval--"{title}"-->templateKeywordAnalysis
-      templateSpecifyingTheAssigment--"{assigment}"-->templateKeywordAnalysis
-      templateCombineTheBeginning(🔗 Combine the beginning)
-      templateWebsiteTitleApproval--"{title}"-->templateCombineTheBeginning
-      templateCunningSubtitle--"{claim}"-->templateCombineTheBeginning
-      templateWriteTheContent(🖋 Write the content)
-      templateWebsiteTitleApproval--"{title}"-->templateWriteTheContent
-      templateSpecifyingTheAssigment--"{assigment}"-->templateWriteTheContent
-      templateKeywordAnalysis--"{keywords}"-->templateWriteTheContent
-      templateCombineTheBeginning--"{contentBeginning}"-->templateWriteTheContent
-      templateCombineTheContent(🔗 Combine the content)
-      templateCombineTheBeginning--"{contentBeginning}"-->templateCombineTheContent
-      templateWriteTheContent--"{contentBody}"-->templateCombineTheContent
-
-      templateCombineTheContent--"{websiteContent}"-->output
-      output((Output)):::output
-
-      classDef input color: grey;
-      classDef output color: grey;
-
-  end;
-```
+-   Versioning is build in. You can test multiple **A/B versions** of pipelines and see which one works best.
+-   Promptbook is designed to use [**RAG** (Retrieval-Augmented Generation)](https://github.com/webgptorg/promptbook/discussions/41) and other advanced techniques to bring the context of your business to generic LLM. You can use **knowledge** to improve the quality of the output.
+
+
+
+## 💜 The Promptbook Project
+
+
+
+<table>
+  <tbody>
+    <tr>
+      <td>Promptbook whitepaper</td>
+      <td>Basic motivations and problems which we are trying to solve</td>
+      <td rowspan=3>https://github.com/webgptorg/book</td>
+    </tr>
+    <tr>
+      <td>Promptbook <i>(system)</i></td>
+      <td>Promptbook ...</td>
+    </tr>
+    <tr>
+      <td>Book language</td>
+      <td>
+          Book is a markdown-like language to define projects, pipelines, knowledge,... in the Promptbook system. It is designed to be understandable by non-programmers and non-technical people
+      </td>
+    </tr>
+    <tr>
+      <td>Promptbook typescript project</td>
+      <td>Implementation of Promptbook in TypeScript published into multiple packages to NPM</td>
+      <td>https://github.com/webgptorg/promptbook</td>
+    </tr>
+    <tr>
+      <td>Promptbook studio</td>
+      <td>Promptbook studio</td>
+      <td rowspan=2>https://github.com/hejny/promptbook-studio</td>
+    </tr>
+    <tr>
+      <td>Promptbook miniapps</td>
+      <td>Promptbook miniapps</td>
+    </tr>
+  </tbody>
+</table>
+
+## 💙 Book language _(for prompt-engineer)_
+
+Promptbook [pipelines](https://github.com/webgptorg/promptbook/discussions/64) are written in markdown-like language called [Book](https://github.com/webgptorg/book). It is designed to be understandable by non-programmers and non-technical people.
+
 
--   [More template samples](./samples/pipelines/)
--   [Read more about `.ptbk.md` file format here](https://github.com/webgptorg/promptbook/discussions/categories/concepts?discussions_q=is%3Aopen+label%3A.ptbk.md+category%3AConcepts)
 
-_Note: We are using [postprocessing functions](#postprocessing-functions) like `unwrapResult` that can be used to postprocess the result._
+```markdown
+# 🌟 My first Book
 
-## 📦 Packages
+-   INPUT PARAMETER {subject}
+-   OUTPUT PARAMETER {article}
+
+## Sample subject
+
+> Promptbook
+
+-> {subject}
+
+## Write an article
+
+-   PERSONA Jane, marketing specialist with prior experience in writing articles about technology and artificial intelligence
+-   KNOWLEDGE https://ptbk.io
+-   KNOWLEDGE ./promptbook.pdf
+-   EXPECT MIN 1 Sentence
+-   EXPECT MAX 1 Paragraph
+
+> Write an article about the future of artificial intelligence in the next 10 years and how metalanguages will change the way AI is used in the world.
+> Look specifically at the impact of {subject} on the AI industry.
+
+-> {article}
+```
+
+## 📦 Packages _(for developers)_
 
 This library is divided into several packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
 You can install all of them at once:
@@ -341,6 +186,8 @@ Or you can install them separately:
 
 The following glossary is used to clarify certain concepts:
 
+### Basic terms
+
 
 
 ### Core concepts
@@ -373,8 +220,8 @@ The following glossary is used to clarify certain concepts:
 
 ## 🔌 Usage in Typescript / Javascript
 
--   [Simple usage](./samples/usage/simple-script)
--   [Usage with client and remote server](./samples/usage/remote)
+-   [Simple usage](./examples/usage/simple-script)
+-   [Usage with client and remote server](./examples/usage/remote)
 
 ## ➕➖ When to use Promptbook?
 

package/esm/index.es.js

@@ -12,7 +12,7 @@ import { unparse, parse } from 'papaparse';
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.72.0-34';
+var PROMPTBOOK_VERSION = '0.73.0';
 // TODO: [main] !!!! List here all the versions and annotate + put into script
 
 /*! *****************************************************************************
@@ -362,7 +362,7 @@ function TODO_USE() {
     }
 }
 
-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"}];
+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## 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"]}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-persona.ptbk.md"}];
 
 /**
  * Prettify the html code
@@ -861,10 +861,10 @@ var RESERVED_PARAMETER_NAMES = $asDeeplyFrozenSerializableJson('RESERVED_PARAMET
     'content',
     'context',
     'knowledge',
-    'samples',
+    'examples',
     'modelName',
     'currentDate',
-    // <- TODO: !!!!! list here all command names
+    // <- TODO: list here all command names
     // <- TODO: Add more like 'date', 'modelName',...
     // <- TODO: Add [emoji] + instructions ACRY when adding new reserved parameter
 ]);
@@ -1317,7 +1317,7 @@ function validatePipelineCore(pipeline) {
     }
 }
 /**
- * TODO: !!!!! [🧞‍♀️] Do not allow joker + foreach
+ * TODO: !! [🧞‍♀️] Do not allow joker + foreach
  * TODO: [🧠] Work with promptbookVersion
  * TODO: Use here some json-schema, Zod or something similar and change it to:
  *     > /**
@@ -1329,7 +1329,7 @@ function validatePipelineCore(pipeline) {
  *     >  ex port function validatePipeline(promptbook: really_unknown): asserts promptbook is PipelineJson {
  */
 /**
- * TODO: [🧳][main] !!!! Validate that all samples match expectations
+ * TODO: [🧳][main] !!!! Validate that all examples 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
@@ -2117,12 +2117,12 @@ function isPipelinePrepared(pipeline) {
     return true;
 }
 /**
- * TODO: [🔃][main] !!!!! 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`
  *     - [🏍] ? Is context in each template
- *     - [♨] Are samples prepared
+ *     - [♨] Are examples prepared
  *     - [♨] Are templates prepared
  */
 
@@ -2827,7 +2827,7 @@ function preparePersona(personaDescription, tools, options) {
     });
 }
 /**
- * TODO: [🔃][main] !!!!! 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
@@ -3493,7 +3493,7 @@ function prepareTemplates(pipeline, tools, options) {
                 case 0:
                     _a = options.maxParallelCount, maxParallelCount = _a === void 0 ? DEFAULT_MAX_PARALLEL_COUNT : _a;
                     templates = pipeline.templates, parameters = pipeline.parameters, knowledgePiecesCount = pipeline.knowledgePiecesCount;
-                    // TODO: [main] !!!!! Apply samples to each template (if missing and is for the template defined)
+                    // TODO: [main] !! Apply examples to each template (if missing and is for the template defined)
                     TODO_USE(parameters);
                     templatesPrepared = new Array(templates.length);
                     return [4 /*yield*/, forEachAsync(templates, { maxParallelCount: maxParallelCount /* <- TODO: [🪂] When there are subtasks, this maximul limit can be broken */ }, function (template, index) { return __awaiter(_this, void 0, void 0, function () {
@@ -3523,7 +3523,7 @@ function prepareTemplates(pipeline, tools, options) {
 /**
  * TODO: [🧠] Add context to each template (if missing)
  * TODO: [🧠] What is better name `prepareTemplate` or `prepareTemplateAndParameters`
- * TODO: [♨][main] !!! Prepare index the samples and maybe templates
+ * TODO: [♨][main] !!! Prepare index the examples 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
@@ -4916,7 +4916,7 @@ function getKnowledgeForTemplate(options) {
         var preparedPipeline, template;
         return __generator(this, function (_a) {
             preparedPipeline = options.preparedPipeline, template = options.template;
-            // TODO: [♨] Implement Better - use real index and keyword search from `template` and {samples}
+            // TODO: [♨] Implement Better - use real index and keyword search from `template` and {examples}
             TODO_USE(template);
             return [2 /*return*/, preparedPipeline.knowledgePieces.map(function (_a) {
                     var content = _a.content;
@@ -4931,7 +4931,7 @@ function getKnowledgeForTemplate(options) {
  *
  * @private internal utility of `createPipelineExecutor`
  */
-function getSamplesForTemplate(template) {
+function getExamplesForTemplate(template) {
     return __awaiter(this, void 0, void 0, function () {
         return __generator(this, function (_a) {
             // TODO: [♨] Implement Better - use real index and keyword search
@@ -4948,7 +4948,7 @@ function getSamplesForTemplate(template) {
  */
 function getReservedParametersForTemplate(options) {
     return __awaiter(this, void 0, void 0, function () {
-        var preparedPipeline, template, pipelineIdentification, context, knowledge, samples, currentDate, modelName, reservedParameters, _loop_1, RESERVED_PARAMETER_NAMES_1, RESERVED_PARAMETER_NAMES_1_1, parameterName;
+        var preparedPipeline, template, pipelineIdentification, context, knowledge, examples, currentDate, modelName, reservedParameters, _loop_1, RESERVED_PARAMETER_NAMES_1, RESERVED_PARAMETER_NAMES_1_1, parameterName;
         var e_1, _a;
         return __generator(this, function (_b) {
             switch (_b.label) {
@@ -4960,16 +4960,16 @@ function getReservedParametersForTemplate(options) {
                     return [4 /*yield*/, getKnowledgeForTemplate({ preparedPipeline: preparedPipeline, template: template })];
                 case 2:
                     knowledge = _b.sent();
-                    return [4 /*yield*/, getSamplesForTemplate(template)];
+                    return [4 /*yield*/, getExamplesForTemplate(template)];
                 case 3:
-                    samples = _b.sent();
+                    examples = _b.sent();
                     currentDate = new Date().toISOString();
                     modelName = RESERVED_PARAMETER_MISSING_VALUE;
                     reservedParameters = {
                         content: RESERVED_PARAMETER_RESTRICTED,
                         context: context,
                         knowledge: knowledge,
-                        samples: samples,
+                        examples: examples,
                         currentDate: currentDate,
                         modelName: modelName,
                     };
@@ -5628,7 +5628,7 @@ var MarkdownScraper = /** @class */ (function () {
                         outputParameters = result.outputParameters;
                         knowledgePiecesRaw = outputParameters.knowledgePieces;
                         knowledgeTextPieces = (knowledgePiecesRaw || '').split('\n---\n');
-                        //                                                               <- TODO: [main] !!!!! Smarter split and filter out empty pieces
+                        //                                                               <- TODO: [main] !! Smarter split and filter out empty pieces
                         if (isVerbose) {
                             console.info('knowledgeTextPieces:', knowledgeTextPieces);
                         }