promptbook 0.75.0-2 → 0.75.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +46 -26
  2. package/package.json +21 -21
package/README.md CHANGED
@@ -2,8 +2,6 @@
2
2
 
3
3
  # ![Promptbook logo - cube with letters P and B](./other/design/logo-h1.png) Promptbook
4
4
 
5
- Build responsible, controlled and transparent applications on top of LLM models!
6
-
7
5
 
8
6
 
9
7
 
@@ -27,27 +25,32 @@ Build responsible, controlled and transparent applications on top of LLM models!
27
25
 
28
26
 
29
27
 
30
- ## 🤍 The Promptbook Whitepaper
31
28
 
32
- 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.
33
29
 
34
- 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:
35
30
 
36
- 1. **Fine-tune** the model to your specifications or even train your own.
37
- 2. **Prompt-engineer** the prompt to the best shape you can achieve.
38
- 3. Orchestrate **multiple prompts** in a [pipeline](https://github.com/webgptorg/promptbook/discussions/64) to get the best result.
31
+ ## 🤍 The Book Abstract
32
+
33
+ **It's time for a paradigm shift! The future of software is in plain English, French or Latin.**
34
+
35
+ 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**!
36
+
37
+ 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!
38
+
39
+ 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.
40
+
41
+ This shift is going to happen, whether we are ready for it or not. Our mission is to make it excellently, not just good.
39
42
 
40
- In all of these situations, but especially in 3., the **✨ Promptbook can make your life waaaaaaaaaay easier**.
43
+ **Join us in this journey!**
41
44
 
42
- - [**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).
43
- - Book allows you to **focus on the business** logic without having to write code or deal with the technicalities of LLMs.
44
- - **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.
45
- - 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.
46
- - 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.
47
- - Versioning is build in. You can test multiple **A/B versions** of pipelines and see which one works best.
48
- - 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.
49
45
 
50
46
 
47
+ ## 🚀 Get started
48
+
49
+ Take a look at the simple starter kit with books integrated into the **Hello World** sample applications:
50
+
51
+ - [Hello Book](https://github.com/webgptorg/hello-world)
52
+ - [Hello Book in Node.js](https://github.com/webgptorg/hello-world-node-js)
53
+ - [Hello Book in Next.js](https://github.com/webgptorg/hello-world-next-js)
51
54
 
52
55
 
53
56
 
@@ -67,7 +70,7 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
67
70
  <tbody>
68
71
  <tr>
69
72
  <td>Core</td>
70
- <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>
73
+ <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>
71
74
  <td rowspan=2>https://ptbk.io<br/>https://github.com/webgptorg/book</td>
72
75
  </tr>
73
76
  <tr>
@@ -78,17 +81,23 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
78
81
  </tr>
79
82
  <tr>
80
83
  <td>Promptbook typescript project</td>
81
- <td>Implementation of Promptbook in TypeScript published into multiple packages to NPM</td>
84
+ <td>Promptbook implementation in TypeScript released as multiple NPM packages</td>
82
85
  <td>https://github.com/webgptorg/promptbook + Multiple packages on NPM</td>
83
86
  </tr>
84
87
  <tr>
85
88
  <td>Promptbook studio</td>
86
- <td>No-code studio to write book without need to write even the markdown</td>
87
- <td rowspan=2>https://promptbook.studio<br/>https://github.com/hejny/promptbook-studio</td>
88
- </tr>
89
- <tr>
90
- <td>Promptbook miniapps</td>
91
- <td>Builder of LLM miniapps from book notation</td>
89
+ <td>Studio to write Books and instantly publish them as miniapps</td>
90
+ <td>
91
+ https://promptbook.studio<br/>
92
+ https://github.com/hejny/promptbook-studio</td>
93
+ </tr><tr>
94
+ <td>Hello World</td>
95
+ <td>Simple starter kit with Books integrated into the sample applications</td>
96
+ <td>
97
+ https://github.com/webgptorg/hello-world<br/>
98
+ https://github.com/webgptorg/hello-world-node-js<br/>
99
+ https://github.com/webgptorg/hello-world-next-js
100
+ </td>
92
101
  </tr>
93
102
  </tbody>
94
103
  </table>
@@ -157,7 +166,9 @@ Reserved words:
157
166
 
158
167
  #### Parameter notation
159
168
 
160
- ### Template
169
+ ### Task
170
+
171
+ ### Task type
161
172
 
162
173
  Todo todo
163
174
 
@@ -218,6 +229,11 @@ Or you can install them separately:
218
229
 
219
230
  ## 📚 Dictionary
220
231
 
232
+
233
+
234
+
235
+
236
+
221
237
  ### 📚 Dictionary
222
238
 
223
239
  The following glossary is used to clarify certain concepts:
@@ -233,6 +249,8 @@ The following glossary is used to clarify certain concepts:
233
249
  - **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.
234
250
  - **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.
235
251
 
252
+
253
+
236
254
  _Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
237
255
 
238
256
  #### Promptbook core
@@ -269,7 +287,7 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
269
287
 
270
288
  - [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
271
289
  - [📯 Pipeline](https://github.com/webgptorg/promptbook/discussions/64)
272
- - [🎺 Pipeline templates](https://github.com/webgptorg/promptbook/discussions/88)
290
+ - [🙇‍♂️ Tasks and pipeline sections](https://github.com/webgptorg/promptbook/discussions/88)
273
291
  - [🤼 Personas](https://github.com/webgptorg/promptbook/discussions/22)
274
292
  - [⭕ Parameters](https://github.com/webgptorg/promptbook/discussions/83)
275
293
  - [🚀 Pipeline execution](https://github.com/webgptorg/promptbook/discussions/84)
@@ -293,6 +311,8 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
293
311
  - [👮 Agent adversary expectations](https://github.com/webgptorg/promptbook/discussions/39)
294
312
  - [view more](https://github.com/webgptorg/promptbook/discussions/categories/concepts)
295
313
 
314
+
315
+
296
316
  ### Terms specific to Promptbook TypeScript implementation
297
317
 
298
318
  - Anonymous mode
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "promptbook",
3
- "version": "0.75.0-2",
3
+ "version": "0.75.1",
4
4
  "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
5
5
  "--note-0": " <- [🐊]",
6
6
  "private": false,
@@ -51,27 +51,27 @@
51
51
  }
52
52
  ],
53
53
  "peerDependencies": {
54
- "@promptbook/core": "0.75.0-2"
54
+ "@promptbook/core": "0.75.1"
55
55
  },
56
56
  "dependencies": {
57
- "@promptbook/anthropic-claude": "0.75.0-2",
58
- "@promptbook/azure-openai": "0.75.0-2",
59
- "@promptbook/browser": "0.75.0-2",
60
- "@promptbook/cli": "0.75.0-2",
61
- "@promptbook/core": "0.75.0-2",
62
- "@promptbook/documents": "0.75.0-2",
63
- "@promptbook/execute-javascript": "0.75.0-2",
64
- "@promptbook/fake-llm": "0.75.0-2",
65
- "@promptbook/langtail": "0.75.0-2",
66
- "@promptbook/legacy-documents": "0.75.0-2",
67
- "@promptbook/markdown-utils": "0.75.0-2",
68
- "@promptbook/node": "0.75.0-2",
69
- "@promptbook/openai": "0.75.0-2",
70
- "@promptbook/pdf": "0.75.0-2",
71
- "@promptbook/remote-client": "0.75.0-2",
72
- "@promptbook/remote-server": "0.75.0-2",
73
- "@promptbook/types": "0.75.0-2",
74
- "@promptbook/utils": "0.75.0-2",
75
- "@promptbook/website-crawler": "0.75.0-2"
57
+ "@promptbook/anthropic-claude": "0.75.1",
58
+ "@promptbook/azure-openai": "0.75.1",
59
+ "@promptbook/browser": "0.75.1",
60
+ "@promptbook/cli": "0.75.1",
61
+ "@promptbook/core": "0.75.1",
62
+ "@promptbook/documents": "0.75.1",
63
+ "@promptbook/execute-javascript": "0.75.1",
64
+ "@promptbook/fake-llm": "0.75.1",
65
+ "@promptbook/langtail": "0.75.1",
66
+ "@promptbook/legacy-documents": "0.75.1",
67
+ "@promptbook/markdown-utils": "0.75.1",
68
+ "@promptbook/node": "0.75.1",
69
+ "@promptbook/openai": "0.75.1",
70
+ "@promptbook/pdf": "0.75.1",
71
+ "@promptbook/remote-client": "0.75.1",
72
+ "@promptbook/remote-server": "0.75.1",
73
+ "@promptbook/types": "0.75.1",
74
+ "@promptbook/utils": "0.75.1",
75
+ "@promptbook/website-crawler": "0.75.1"
76
76
  }
77
77
  }