@promptbook/node 0.75.0-2 → 0.75.1

package/README.md

@@ -2,8 +2,6 @@
 
 # ![Promptbook logo - cube with letters P and B](./other/design/logo-h1.png) Promptbook
 
-Build responsible, controlled and transparent applications on top of LLM models!
-
 
 
 
@@ -25,10 +23,6 @@ Build responsible, controlled and transparent applications on top of LLM models!
 
 
 
-<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/node`
 
 - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -55,28 +49,33 @@ Core of the library for Node.js runtime, it contains the main logic for promptbo
 
 Rest of the documentation is common for **entire promptbook ecosystem**:
 
-## 🤍 The Promptbook Whitepaper
 
-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 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.
-3. Orchestrate **multiple prompts** in a [pipeline](https://github.com/webgptorg/promptbook/discussions/64) to get the best result.
+## 🤍 The Book Abstract
+
+**It's time for a paradigm shift! The future of software is in plain English, French or Latin.**
+
+During the computer revolution, we have seen [multiple generations of computer languages](https://github.com/webgptorg/promptbook/discussions/180), from the physical rewiring of the vacuum tubes through low-level machine code to the high-level languages like Python or JavaScript. And now, we're on the edge of the **next revolution**!
+
+It's a revolution of writing software in plain human language that is understandable and executable by both humans and machines – and it's going to change everything!
+
+The incredible growth in power of microprocessors and the Moore's Law have been the driving force behind the ever-more powerful languages, and it's been an amazing journey! Similarly, the large language models (like GPT or Claude) are the next big thing in language technology, and they're set to transform the way we interact with computers.
 
-In all of these situations, but especially in 3., the **✨ Promptbook can make your life waaaaaaaaaay easier**.
+This shift is going to happen, whether we are ready for it or not. Our mission is to make it excellently, not just good.
 
--   [**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.
--   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.
+**Join us in this journey!**
 
 
 
+## 🚀 Get started
+
+Take a look at the simple starter kit with books integrated into the **Hello World** sample applications:
+
+-   [Hello Book](https://github.com/webgptorg/hello-world)
+-   [Hello Book in Node.js](https://github.com/webgptorg/hello-world-node-js)
+-   [Hello Book in Next.js](https://github.com/webgptorg/hello-world-next-js)
+
 
 
 
@@ -95,7 +94,7 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
   <tbody>
     <tr>
       <td>Core</td>
-      <td>Promptbook core is a description and documentation of basic innerworkings how should be Promptbook implemented and defines which fetures must be descriable by book language</td>
+      <td>Promptbook Core is a description and documentation of the basic concepts, ideas and inner workings of how Promptbook should be implemented, and defines what features must be describable by book language.</td>
       <td rowspan=2>https://ptbk.io<br/>https://github.com/webgptorg/book</td>
     </tr>
     <tr>
@@ -106,17 +105,23 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
     </tr>
     <tr>
       <td>Promptbook typescript project</td>
-      <td>Implementation of Promptbook in TypeScript published into multiple packages to NPM</td>
+      <td>Promptbook implementation in TypeScript released as multiple NPM packages</td>
       <td>https://github.com/webgptorg/promptbook + Multiple packages on NPM</td>
     </tr>
     <tr>
       <td>Promptbook studio</td>
-      <td>No-code studio to write book without need to write even the markdown</td>
-      <td rowspan=2>https://promptbook.studio<br/>https://github.com/hejny/promptbook-studio</td>
-    </tr>
-    <tr>
-      <td>Promptbook miniapps</td>
-      <td>Builder of LLM miniapps from book notation</td>
+      <td>Studio to write Books and instantly publish them as miniapps</td>
+      <td>
+        https://promptbook.studio<br/>
+        https://github.com/hejny/promptbook-studio</td>
+      </tr><tr>
+      <td>Hello World</td>
+      <td>Simple starter kit with Books integrated into the sample applications</td>
+       <td>
+          https://github.com/webgptorg/hello-world<br/>
+          https://github.com/webgptorg/hello-world-node-js<br/>
+          https://github.com/webgptorg/hello-world-next-js
+       </td>
     </tr>
   </tbody>
 </table>
@@ -185,7 +190,9 @@ Reserved words:
 
 #### Parameter notation
 
-### Template
+### Task
+
+### Task type
 
 Todo todo
 
@@ -246,6 +253,11 @@ Or you can install them separately:
 
 ## 📚 Dictionary
 
+
+
+
+
+
 ### 📚 Dictionary
 
 The following glossary is used to clarify certain concepts:
@@ -261,6 +273,8 @@ The following glossary is used to clarify certain concepts:
 -   **Retrieval-augmented generation** is a machine learning paradigm where a model generates text by retrieving relevant information from a large database of text. This approach combines the benefits of generative models and retrieval models.
 -   **Longtail** refers to non-common or rare events, items, or entities that are not well-represented in the training data of machine learning models. Longtail items are often challenging for models to predict accurately.
 
+
+
 _Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
 
 #### Promptbook core
@@ -297,7 +311,7 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
 
 -   [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
 -   [📯 Pipeline](https://github.com/webgptorg/promptbook/discussions/64)
--   [🎺 Pipeline templates](https://github.com/webgptorg/promptbook/discussions/88)
+-   [🙇‍♂️ Tasks and pipeline sections](https://github.com/webgptorg/promptbook/discussions/88)
 -   [🤼 Personas](https://github.com/webgptorg/promptbook/discussions/22)
 -   [⭕ Parameters](https://github.com/webgptorg/promptbook/discussions/83)
 -   [🚀 Pipeline execution](https://github.com/webgptorg/promptbook/discussions/84)
@@ -321,6 +335,8 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
 -   [👮 Agent adversary expectations](https://github.com/webgptorg/promptbook/discussions/39)
 -   [view more](https://github.com/webgptorg/promptbook/discussions/categories/concepts)
 
+
+
 ### Terms specific to Promptbook TypeScript implementation
 
 -   Anonymous mode