@promptbook/templates 0.88.0-9 → 0.88.0
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 +35 -18
- package/esm/index.es.js +164 -470
- package/esm/index.es.js.map +1 -1
- package/esm/typings/src/config.d.ts +1 -1
- package/esm/typings/src/errors/PipelineExecutionError.d.ts +5 -0
- package/esm/typings/src/errors/utils/ErrorJson.d.ts +5 -0
- package/esm/typings/src/utils/expectation-counters/countCharacters.d.ts +3 -0
- package/esm/typings/src/utils/expectation-counters/countLines.d.ts +3 -0
- package/esm/typings/src/utils/expectation-counters/countPages.d.ts +3 -0
- package/esm/typings/src/utils/expectation-counters/countParagraphs.d.ts +3 -0
- package/esm/typings/src/utils/expectation-counters/countSentences.d.ts +3 -0
- package/esm/typings/src/utils/expectation-counters/countWords.d.ts +3 -0
- package/package.json +2 -2
- package/umd/index.umd.js +164 -470
- package/umd/index.umd.js.map +1 -1
package/README.md
CHANGED
|
@@ -23,10 +23,6 @@
|
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
|
|
26
|
-
<blockquote style="color: #ff8811">
|
|
27
|
-
<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>.
|
|
28
|
-
</blockquote>
|
|
29
|
-
|
|
30
26
|
## 📦 Package `@promptbook/templates`
|
|
31
27
|
|
|
32
28
|
- Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
|
|
@@ -60,6 +56,8 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
|
|
|
60
56
|
|
|
61
57
|
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**!
|
|
62
58
|
|
|
59
|
+
|
|
60
|
+
|
|
63
61
|
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!
|
|
64
62
|
|
|
65
63
|
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.
|
|
@@ -70,6 +68,9 @@ This shift is going to happen, whether we are ready for it or not. Our mission i
|
|
|
70
68
|
|
|
71
69
|
|
|
72
70
|
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
73
74
|
## 🚀 Get started
|
|
74
75
|
|
|
75
76
|
Take a look at the simple starter kit with books integrated into the **Hello World** sample applications:
|
|
@@ -81,6 +82,8 @@ Take a look at the simple starter kit with books integrated into the **Hello Wor
|
|
|
81
82
|
|
|
82
83
|
|
|
83
84
|
|
|
85
|
+
|
|
86
|
+
|
|
84
87
|
## 💜 The Promptbook Project
|
|
85
88
|
|
|
86
89
|
Promptbook project is ecosystem of multiple projects and tools, following is a list of most important pieces of the project:
|
|
@@ -116,22 +119,35 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
|
|
|
116
119
|
</tbody>
|
|
117
120
|
</table>
|
|
118
121
|
|
|
122
|
+
Hello world examples:
|
|
123
|
+
|
|
124
|
+
- [Hello world](https://github.com/webgptorg/hello-world)
|
|
125
|
+
- [Hello world in Node.js](https://github.com/webgptorg/hello-world-node-js)
|
|
126
|
+
- [Hello world in Next.js](https://github.com/webgptorg/hello-world-next-js)
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
119
130
|
We also have a community of developers and users of **Promptbook**:
|
|
120
131
|
|
|
121
132
|
- [Discord community](https://discord.gg/x3QWNaa89N)
|
|
122
133
|
- [Landing page `ptbk.io`](https://ptbk.io)
|
|
123
134
|
- [Github discussions](https://github.com/webgptorg/promptbook/discussions)
|
|
124
135
|
- [LinkedIn `Promptbook`](https://linkedin.com/company/promptbook)
|
|
125
|
-
- [Facebook `Promptbook`](https://www.facebook.com/61560776453536)
|
|
136
|
+
- [Facebook `Promptbook`](https://www.facebook.com/61560776453536)
|
|
126
137
|
|
|
127
138
|
And **Promptbook.studio** branded socials:
|
|
128
139
|
|
|
140
|
+
|
|
141
|
+
|
|
129
142
|
- [Instagram `@promptbook.studio`](https://www.instagram.com/promptbook.studio/)
|
|
130
143
|
|
|
131
144
|
And **Promptujeme** sub-brand:
|
|
132
145
|
|
|
133
146
|
_/Subbrand for Czech clients/_
|
|
134
147
|
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
135
151
|
- [Promptujeme.cz](https://www.promptujeme.cz/)
|
|
136
152
|
- [Facebook `Promptujeme`](https://www.facebook.com/promptujeme/)
|
|
137
153
|
|
|
@@ -149,6 +165,8 @@ _/Sub-brand for images and graphics generated via Promptbook prompting/_
|
|
|
149
165
|
|
|
150
166
|
## 💙 The Book language
|
|
151
167
|
|
|
168
|
+
|
|
169
|
+
|
|
152
170
|
Following is the documentation and blueprint of the [Book language](https://github.com/webgptorg/book).
|
|
153
171
|
|
|
154
172
|
Book is a language that can be used to write AI applications, agents, workflows, automations, knowledgebases, translators, sheet processors, email automations and more. It allows you to harness the power of AI models in human-like terms, without the need to know the specifics and technicalities of the models.
|
|
@@ -198,6 +216,8 @@ Personas can have access to different knowledge, tools and actions. They can als
|
|
|
198
216
|
|
|
199
217
|
- [PERSONA](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PERSONA.md)
|
|
200
218
|
|
|
219
|
+
|
|
220
|
+
|
|
201
221
|
### **How:** Knowledge, Instruments and Actions
|
|
202
222
|
|
|
203
223
|
The resources used by the personas are used to do the work.
|
|
@@ -273,11 +293,9 @@ Or you can install them separately:
|
|
|
273
293
|
|
|
274
294
|
## 📚 Dictionary
|
|
275
295
|
|
|
276
|
-
### 📚 Dictionary
|
|
277
|
-
|
|
278
296
|
The following glossary is used to clarify certain concepts:
|
|
279
297
|
|
|
280
|
-
|
|
298
|
+
### General LLM / AI terms
|
|
281
299
|
|
|
282
300
|
- **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.
|
|
283
301
|
- **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.
|
|
@@ -288,9 +306,13 @@ The following glossary is used to clarify certain concepts:
|
|
|
288
306
|
- **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.
|
|
289
307
|
- **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.
|
|
290
308
|
|
|
291
|
-
_Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
|
|
292
309
|
|
|
293
|
-
|
|
310
|
+
|
|
311
|
+
_Note: This section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
### 💯 Core concepts
|
|
294
316
|
|
|
295
317
|
- [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
|
|
296
318
|
- [📯 Pipeline](https://github.com/webgptorg/promptbook/discussions/64)
|
|
@@ -303,7 +325,7 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
|
|
|
303
325
|
- [🔣 Words not tokens](https://github.com/webgptorg/promptbook/discussions/29)
|
|
304
326
|
- [☯ Separation of concerns](https://github.com/webgptorg/promptbook/discussions/32)
|
|
305
327
|
|
|
306
|
-
|
|
328
|
+
#### Advanced concepts
|
|
307
329
|
|
|
308
330
|
- [📚 Knowledge (Retrieval-augmented generation)](https://github.com/webgptorg/promptbook/discussions/41)
|
|
309
331
|
- [🌏 Remote server](https://github.com/webgptorg/promptbook/discussions/89)
|
|
@@ -318,11 +340,6 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
|
|
|
318
340
|
- [👮 Agent adversary expectations](https://github.com/webgptorg/promptbook/discussions/39)
|
|
319
341
|
- [view more](https://github.com/webgptorg/promptbook/discussions/categories/concepts)
|
|
320
342
|
|
|
321
|
-
### Terms specific to Promptbook TypeScript implementation
|
|
322
|
-
|
|
323
|
-
- Anonymous mode
|
|
324
|
-
- Application mode
|
|
325
|
-
|
|
326
343
|
|
|
327
344
|
|
|
328
345
|
## 🚂 Promptbook Engine
|
|
@@ -393,11 +410,11 @@ See [TODO.md](./TODO.md)
|
|
|
393
410
|
<div style="display: flex; align-items: center; gap: 20px;">
|
|
394
411
|
|
|
395
412
|
<a href="https://promptbook.studio/">
|
|
396
|
-
<img src="./design/promptbook-studio-logo.png" alt="Partner 3" height="
|
|
413
|
+
<img src="./design/promptbook-studio-logo.png" alt="Partner 3" height="70">
|
|
397
414
|
</a>
|
|
398
415
|
|
|
399
416
|
<a href="https://technologickainkubace.org/en/about-technology-incubation/about-the-project/">
|
|
400
|
-
<img src="./other/partners/CI-Technology-Incubation.png" alt="Technology Incubation" height="
|
|
417
|
+
<img src="./other/partners/CI-Technology-Incubation.png" alt="Technology Incubation" height="70">
|
|
401
418
|
</a>
|
|
402
419
|
|
|
403
420
|
</div>
|