@promptbook/legacy-documents 0.74.0-0 → 0.74.0-11

package/README.md

@@ -54,8 +54,6 @@ 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:
@@ -76,63 +74,65 @@ In all of these situations, but especially in 3., the **✨ Promptbook can make
 
 
 
-## 💜 The Promptbook Project
 
 
 
+## 💜 The Promptbook Project
+
+Promptbook project is ecosystem of multiple projects and tools, following is a list of most important pieces of the project:
+
 <table>
-  <tbody>
+  <thead>
     <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>
+      <th>Project</th>
+      <th>Description</th>
+      <th>Link</th>
     </tr>
+  </thead>
+  <tbody>
     <tr>
-      <td>Promptbook <i>(system)</i></td>
-      <td>Promptbook ...</td>
+      <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 rowspan=2>https://ptbk.io<br/>https://github.com/webgptorg/book</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
+          Book is a markdown-like language to define core entities like projects, pipelines, knowledge,.... 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>
+      <td>https://github.com/webgptorg/promptbook + Multiple packages on NPM</td>
     </tr>
     <tr>
       <td>Promptbook studio</td>
-      <td>Promptbook studio</td>
-      <td rowspan=2>https://github.com/hejny/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>Promptbook miniapps</td>
+      <td>Builder of LLM miniapps from book notation</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.
 
+## 💙 Book language _(for prompt-engineer)_
 
 
-```markdown
-# 🌟 My first Book
 
--   INPUT PARAMETER {subject}
--   OUTPUT PARAMETER {article}
 
-## Sample subject
+## 💙 The blueprint of book language
 
-> Promptbook
+Following is the documentation and blueprint of the Book language.
 
--> {subject}
+### Example
 
-## Write an article
+```markdown
+# 🌟 My first Book
 
 -   PERSONA Jane, marketing specialist with prior experience in writing articles about technology and artificial intelligence
 -   KNOWLEDGE https://ptbk.io
@@ -141,11 +141,65 @@ Promptbook [pipelines](https://github.com/webgptorg/promptbook/discussions/64) a
 -   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.
+> Look specifically at the impact of Promptbook on the AI industry.
 
 -> {article}
 ```
 
+### Goals and principles of book language
+
+File is designed to be easy to read and write. It is strict subset of markdown. It is designed to be understandable by both humans and machines and without specific knowledge of the language.
+
+It has file with `.ptbk.md` or `.book` extension with `UTF-8` non BOM encoding.
+
+As it is source code, it can leverage all the features of version control systems like git and does not suffer from the problems of binary formats, proprietary formats, or no-code solutions.
+
+But unlike programming languages, it is designed to be understandable by non-programmers and non-technical people.
+
+### Structure
+
+Book is divided into sections. Each section starts with heading. The language itself is not sensitive to the type of heading _(`h1`, `h2`, `h3`, ...)_ but it is recommended to use `h1` for header section and `h2` for other sections.
+
+### Header
+
+Header is the first section of the book. It contains metadata about the pipeline. It is recommended to use `h1` heading for header section but it is not required.
+
+### Parameter
+
+Foo bar
+
+#### Parameter names
+
+Reserved words:
+
+-   _each command_ like `PERSONA`, `EXPECT`, `KNOWLEDGE`, etc.
+-   `content`
+-   `context`
+-   `knowledge`
+-   `examples`
+-   `modelName`
+-   `currentDate`
+
+#### Parameter notation
+
+### Template
+
+Todo todo
+
+### Command
+
+Todo todo
+
+### Block
+
+Todo todo
+
+### Return parameter
+
+### Examples
+
+
+
 ## 📦 Packages _(for developers)_
 
 This library is divided into several packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -184,15 +238,66 @@ Or you can install them separately:
 
 
 
+
+
+
 ## 📚 Dictionary
 
-The following glossary is used to clarify certain concepts:
 
-### Basic terms
 
 
 
-### Core concepts
+
+### 📚 Dictionary
+
+The following glossary is used to clarify certain concepts:
+
+#### General LLM / AI terms
+
+-   **Prompt drift** is a phenomenon where the AI model starts to generate outputs that are not aligned with the original prompt. This can happen due to the model's training data, the prompt's wording, or the model's architecture.
+-   **Pipeline, workflow or chain** is a sequence of tasks that are executed in a specific order. In the context of AI, a pipeline can refer to a sequence of AI models that are used to process data.
+-   **Fine-tuning** is a process where a pre-trained AI model is further trained on a specific dataset to improve its performance on a specific task.
+-   **Zero-shot learning** is a machine learning paradigm where a model is trained to perform a task without any labeled examples. Instead, the model is provided with a description of the task and is expected to generate the correct output.
+-   **Few-shot learning** is a machine learning paradigm where a model is trained to perform a task with only a few labeled examples. This is in contrast to traditional machine learning, where models are trained on large datasets.
+-   **Meta-learning** is a machine learning paradigm where a model is trained on a variety of tasks and is able to learn new tasks with minimal additional training. This is achieved by learning a set of meta-parameters that can be quickly adapted to new tasks.
+-   **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
+
+-   **Organization** _(legacy name collection)_ group jobs, workforce, knowledge, instruments, and actions into one package. Entities in one organization can share resources (= import resources from each other).
+    -   **Jobs**
+        -   **Task**
+        -   **Subtask**
+    -   **Workforce**
+        -   **Persona**
+        -   **Team**
+        -   **Role**
+    -   **Knowledge**
+        -   **Public**
+        -   **Private**
+        -   **Protected**
+    -   **Instruments**
+    -   **Actions**
+
+#### Book language
+
+-   **Book file**
+    -   **Section**
+        -   **Heading**
+        -   **Description**
+        -   **Command**
+        -   **Block**
+        -   **Return statement**
+    -   **Comment**
+    -   **Import**
+    -   **Scope**
+
+#### 💯 Core concepts
 
 -   [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
 -   [📯 Pipeline](https://github.com/webgptorg/promptbook/discussions/64)
@@ -205,7 +310,7 @@ The following glossary is used to clarify certain concepts:
 -   [🔣 Words not tokens](https://github.com/webgptorg/promptbook/discussions/29)
 -   [☯ Separation of concerns](https://github.com/webgptorg/promptbook/discussions/32)
 
-### Advanced concepts
+##### Advanced concepts
 
 -   [📚 Knowledge (Retrieval-augmented generation)](https://github.com/webgptorg/promptbook/discussions/41)
 -   [🌏 Remote server](https://github.com/webgptorg/promptbook/discussions/89)
@@ -220,6 +325,15 @@ The following glossary is used to clarify certain concepts:
 -   [👮 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
+-   Application mode
+
+
+
 ## 🔌 Usage in Typescript / Javascript
 
 -   [Simple usage](./examples/usage/simple-script)