promptbook 0.73.0 → 0.74.0-2
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.
- package/README.md +126 -3
- package/package.json +21 -21
package/README.md
CHANGED
|
@@ -28,6 +28,8 @@ Build responsible, controlled and transparent applications on top of LLM models!
|
|
|
28
28
|
|
|
29
29
|
## 🤍 The Promptbook Whitepaper
|
|
30
30
|
|
|
31
|
+
|
|
32
|
+
|
|
31
33
|
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.
|
|
32
34
|
|
|
33
35
|
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:
|
|
@@ -48,6 +50,52 @@ In all of these situations, but especially in 3., the **✨ Promptbook can make
|
|
|
48
50
|
|
|
49
51
|
|
|
50
52
|
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
## 💜 The Promptbook Project
|
|
57
|
+
|
|
58
|
+
Promptbook project is ecosystem of multiple projects and tools, following is a list of most important pieces of the project:
|
|
59
|
+
|
|
60
|
+
<table>
|
|
61
|
+
<thead>
|
|
62
|
+
<tr>
|
|
63
|
+
<th>Project</th>
|
|
64
|
+
<th>Description</th>
|
|
65
|
+
<th>Link</th>
|
|
66
|
+
</tr>
|
|
67
|
+
</thead>
|
|
68
|
+
<tbody>
|
|
69
|
+
<tr>
|
|
70
|
+
<td>Core</td>
|
|
71
|
+
<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>
|
|
72
|
+
<td rowspan=2>https://ptbk.io<br/>https://github.com/webgptorg/book</td>
|
|
73
|
+
</tr>
|
|
74
|
+
<tr>
|
|
75
|
+
<td>Book language</td>
|
|
76
|
+
<td>
|
|
77
|
+
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
|
|
78
|
+
</td>
|
|
79
|
+
</tr>
|
|
80
|
+
<tr>
|
|
81
|
+
<td>Promptbook typescript project</td>
|
|
82
|
+
<td>Implementation of Promptbook in TypeScript published into multiple packages to NPM</td>
|
|
83
|
+
<td>https://github.com/webgptorg/promptbook + Multiple packages on NPM</td>
|
|
84
|
+
</tr>
|
|
85
|
+
<tr>
|
|
86
|
+
<td>Promptbook studio</td>
|
|
87
|
+
<td>No-code studio to write book without need to write even the markdown</td>
|
|
88
|
+
<td rowspan=2>https://promptbook.studio<br/>https://github.com/hejny/promptbook-studio</td>
|
|
89
|
+
</tr>
|
|
90
|
+
<tr>
|
|
91
|
+
<td>Promptbook miniapps</td>
|
|
92
|
+
<td>Builder of LLM miniapps from book notation</td>
|
|
93
|
+
</tr>
|
|
94
|
+
</tbody>
|
|
95
|
+
</table>
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
51
99
|
## 💙 Book language _(for prompt-engineer)_
|
|
52
100
|
|
|
53
101
|
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.
|
|
@@ -57,6 +105,17 @@ Promptbook [pipelines](https://github.com/webgptorg/promptbook/discussions/64) a
|
|
|
57
105
|
```markdown
|
|
58
106
|
# 🌟 My first Book
|
|
59
107
|
|
|
108
|
+
- INPUT PARAMETER {subject}
|
|
109
|
+
- OUTPUT PARAMETER {article}
|
|
110
|
+
|
|
111
|
+
## Sample subject
|
|
112
|
+
|
|
113
|
+
> Promptbook
|
|
114
|
+
|
|
115
|
+
-> {subject}
|
|
116
|
+
|
|
117
|
+
## Write an article
|
|
118
|
+
|
|
60
119
|
- PERSONA Jane, marketing specialist with prior experience in writing articles about technology and artificial intelligence
|
|
61
120
|
- KNOWLEDGE https://ptbk.io
|
|
62
121
|
- KNOWLEDGE ./promptbook.pdf
|
|
@@ -64,7 +123,7 @@ Promptbook [pipelines](https://github.com/webgptorg/promptbook/discussions/64) a
|
|
|
64
123
|
- EXPECT MAX 1 Paragraph
|
|
65
124
|
|
|
66
125
|
> 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.
|
|
67
|
-
> Look specifically at the impact of
|
|
126
|
+
> Look specifically at the impact of {subject} on the AI industry.
|
|
68
127
|
|
|
69
128
|
-> {article}
|
|
70
129
|
```
|
|
@@ -107,11 +166,66 @@ Or you can install them separately:
|
|
|
107
166
|
|
|
108
167
|
|
|
109
168
|
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
110
172
|
## 📚 Dictionary
|
|
111
173
|
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
### 📚 Dictionary
|
|
180
|
+
|
|
112
181
|
The following glossary is used to clarify certain concepts:
|
|
113
182
|
|
|
114
|
-
|
|
183
|
+
#### General LLM / AI terms
|
|
184
|
+
|
|
185
|
+
- **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.
|
|
186
|
+
- **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.
|
|
187
|
+
- **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.
|
|
188
|
+
- **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.
|
|
189
|
+
- **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.
|
|
190
|
+
- **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.
|
|
191
|
+
- **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.
|
|
192
|
+
- **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.
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
_Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
|
|
197
|
+
|
|
198
|
+
#### Promptbook core
|
|
199
|
+
|
|
200
|
+
- **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).
|
|
201
|
+
- **Jobs**
|
|
202
|
+
- **Task**
|
|
203
|
+
- **Subtask**
|
|
204
|
+
- **Workforce**
|
|
205
|
+
- **Persona**
|
|
206
|
+
- **Team**
|
|
207
|
+
- **Role**
|
|
208
|
+
- **Knowledge**
|
|
209
|
+
- **Public**
|
|
210
|
+
- **Private**
|
|
211
|
+
- **Protected**
|
|
212
|
+
- **Instruments**
|
|
213
|
+
- **Actions**
|
|
214
|
+
|
|
215
|
+
#### Book language
|
|
216
|
+
|
|
217
|
+
- **Book file**
|
|
218
|
+
- **Section**
|
|
219
|
+
- **Heading**
|
|
220
|
+
- **Description**
|
|
221
|
+
- **Command**
|
|
222
|
+
- **Block**
|
|
223
|
+
- **Return statement**
|
|
224
|
+
- **Comment**
|
|
225
|
+
- **Import**
|
|
226
|
+
- **Scope**
|
|
227
|
+
|
|
228
|
+
#### 💯 Core concepts
|
|
115
229
|
|
|
116
230
|
- [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
|
|
117
231
|
- [📯 Pipeline](https://github.com/webgptorg/promptbook/discussions/64)
|
|
@@ -124,7 +238,7 @@ The following glossary is used to clarify certain concepts:
|
|
|
124
238
|
- [🔣 Words not tokens](https://github.com/webgptorg/promptbook/discussions/29)
|
|
125
239
|
- [☯ Separation of concerns](https://github.com/webgptorg/promptbook/discussions/32)
|
|
126
240
|
|
|
127
|
-
|
|
241
|
+
##### Advanced concepts
|
|
128
242
|
|
|
129
243
|
- [📚 Knowledge (Retrieval-augmented generation)](https://github.com/webgptorg/promptbook/discussions/41)
|
|
130
244
|
- [🌏 Remote server](https://github.com/webgptorg/promptbook/discussions/89)
|
|
@@ -139,6 +253,15 @@ The following glossary is used to clarify certain concepts:
|
|
|
139
253
|
- [👮 Agent adversary expectations](https://github.com/webgptorg/promptbook/discussions/39)
|
|
140
254
|
- [view more](https://github.com/webgptorg/promptbook/discussions/categories/concepts)
|
|
141
255
|
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
### Terms specific to Promptbook TypeScript implementation
|
|
259
|
+
|
|
260
|
+
- Anonymous mode
|
|
261
|
+
- Application mode
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
142
265
|
## 🔌 Usage in Typescript / Javascript
|
|
143
266
|
|
|
144
267
|
- [Simple usage](./examples/usage/simple-script)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "promptbook",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.74.0-2",
|
|
4
4
|
"description": "Supercharge your use of large language models",
|
|
5
5
|
"private": false,
|
|
6
6
|
"sideEffects": false,
|
|
@@ -50,27 +50,27 @@
|
|
|
50
50
|
}
|
|
51
51
|
],
|
|
52
52
|
"peerDependencies": {
|
|
53
|
-
"@promptbook/core": "0.
|
|
53
|
+
"@promptbook/core": "0.74.0-2"
|
|
54
54
|
},
|
|
55
55
|
"dependencies": {
|
|
56
|
-
"@promptbook/anthropic-claude": "0.
|
|
57
|
-
"@promptbook/azure-openai": "0.
|
|
58
|
-
"@promptbook/browser": "0.
|
|
59
|
-
"@promptbook/cli": "0.
|
|
60
|
-
"@promptbook/core": "0.
|
|
61
|
-
"@promptbook/documents": "0.
|
|
62
|
-
"@promptbook/execute-javascript": "0.
|
|
63
|
-
"@promptbook/fake-llm": "0.
|
|
64
|
-
"@promptbook/langtail": "0.
|
|
65
|
-
"@promptbook/legacy-documents": "0.
|
|
66
|
-
"@promptbook/markdown-utils": "0.
|
|
67
|
-
"@promptbook/node": "0.
|
|
68
|
-
"@promptbook/openai": "0.
|
|
69
|
-
"@promptbook/pdf": "0.
|
|
70
|
-
"@promptbook/remote-client": "0.
|
|
71
|
-
"@promptbook/remote-server": "0.
|
|
72
|
-
"@promptbook/types": "0.
|
|
73
|
-
"@promptbook/utils": "0.
|
|
74
|
-
"@promptbook/website-crawler": "0.
|
|
56
|
+
"@promptbook/anthropic-claude": "0.74.0-2",
|
|
57
|
+
"@promptbook/azure-openai": "0.74.0-2",
|
|
58
|
+
"@promptbook/browser": "0.74.0-2",
|
|
59
|
+
"@promptbook/cli": "0.74.0-2",
|
|
60
|
+
"@promptbook/core": "0.74.0-2",
|
|
61
|
+
"@promptbook/documents": "0.74.0-2",
|
|
62
|
+
"@promptbook/execute-javascript": "0.74.0-2",
|
|
63
|
+
"@promptbook/fake-llm": "0.74.0-2",
|
|
64
|
+
"@promptbook/langtail": "0.74.0-2",
|
|
65
|
+
"@promptbook/legacy-documents": "0.74.0-2",
|
|
66
|
+
"@promptbook/markdown-utils": "0.74.0-2",
|
|
67
|
+
"@promptbook/node": "0.74.0-2",
|
|
68
|
+
"@promptbook/openai": "0.74.0-2",
|
|
69
|
+
"@promptbook/pdf": "0.74.0-2",
|
|
70
|
+
"@promptbook/remote-client": "0.74.0-2",
|
|
71
|
+
"@promptbook/remote-server": "0.74.0-2",
|
|
72
|
+
"@promptbook/types": "0.74.0-2",
|
|
73
|
+
"@promptbook/utils": "0.74.0-2",
|
|
74
|
+
"@promptbook/website-crawler": "0.74.0-2"
|
|
75
75
|
}
|
|
76
76
|
}
|