@promptbook/node 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 +36 -7
- 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 +36 -7
- 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/node`
|
|
31
27
|
|
|
32
28
|
- Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
|
|
@@ -62,6 +58,8 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
|
|
|
62
58
|
|
|
63
59
|
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**!
|
|
64
60
|
|
|
61
|
+
|
|
62
|
+
|
|
65
63
|
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!
|
|
66
64
|
|
|
67
65
|
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.
|
|
@@ -72,6 +70,9 @@ This shift is going to happen, whether we are ready for it or not. Our mission i
|
|
|
72
70
|
|
|
73
71
|
|
|
74
72
|
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
75
76
|
## ๐ Get started
|
|
76
77
|
|
|
77
78
|
Take a look at the simple starter kit with books integrated into the **Hello World** sample applications:
|
|
@@ -83,6 +84,8 @@ Take a look at the simple starter kit with books integrated into the **Hello Wor
|
|
|
83
84
|
|
|
84
85
|
|
|
85
86
|
|
|
87
|
+
|
|
88
|
+
|
|
86
89
|
## ๐ The Promptbook Project
|
|
87
90
|
|
|
88
91
|
Promptbook project is ecosystem of multiple projects and tools, following is a list of most important pieces of the project:
|
|
@@ -118,22 +121,35 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
|
|
|
118
121
|
</tbody>
|
|
119
122
|
</table>
|
|
120
123
|
|
|
124
|
+
Hello world examples:
|
|
125
|
+
|
|
126
|
+
- [Hello world](https://github.com/webgptorg/hello-world)
|
|
127
|
+
- [Hello world in Node.js](https://github.com/webgptorg/hello-world-node-js)
|
|
128
|
+
- [Hello world in Next.js](https://github.com/webgptorg/hello-world-next-js)
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
121
132
|
We also have a community of developers and users of **Promptbook**:
|
|
122
133
|
|
|
123
134
|
- [Discord community](https://discord.gg/x3QWNaa89N)
|
|
124
135
|
- [Landing page `ptbk.io`](https://ptbk.io)
|
|
125
136
|
- [Github discussions](https://github.com/webgptorg/promptbook/discussions)
|
|
126
137
|
- [LinkedIn `Promptbook`](https://linkedin.com/company/promptbook)
|
|
127
|
-
- [Facebook `Promptbook`](https://www.facebook.com/61560776453536)
|
|
138
|
+
- [Facebook `Promptbook`](https://www.facebook.com/61560776453536)
|
|
128
139
|
|
|
129
140
|
And **Promptbook.studio** branded socials:
|
|
130
141
|
|
|
142
|
+
|
|
143
|
+
|
|
131
144
|
- [Instagram `@promptbook.studio`](https://www.instagram.com/promptbook.studio/)
|
|
132
145
|
|
|
133
146
|
And **Promptujeme** sub-brand:
|
|
134
147
|
|
|
135
148
|
_/Subbrand for Czech clients/_
|
|
136
149
|
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
137
153
|
- [Promptujeme.cz](https://www.promptujeme.cz/)
|
|
138
154
|
- [Facebook `Promptujeme`](https://www.facebook.com/promptujeme/)
|
|
139
155
|
|
|
@@ -151,6 +167,8 @@ _/Sub-brand for images and graphics generated via Promptbook prompting/_
|
|
|
151
167
|
|
|
152
168
|
## ๐ The Book language
|
|
153
169
|
|
|
170
|
+
|
|
171
|
+
|
|
154
172
|
Following is the documentation and blueprint of the [Book language](https://github.com/webgptorg/book).
|
|
155
173
|
|
|
156
174
|
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.
|
|
@@ -200,6 +218,8 @@ Personas can have access to different knowledge, tools and actions. They can als
|
|
|
200
218
|
|
|
201
219
|
- [PERSONA](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PERSONA.md)
|
|
202
220
|
|
|
221
|
+
|
|
222
|
+
|
|
203
223
|
### **How:** Knowledge, Instruments and Actions
|
|
204
224
|
|
|
205
225
|
The resources used by the personas are used to do the work.
|
|
@@ -275,11 +295,9 @@ Or you can install them separately:
|
|
|
275
295
|
|
|
276
296
|
## ๐ Dictionary
|
|
277
297
|
|
|
278
|
-
### ๐ Dictionary
|
|
279
|
-
|
|
280
298
|
The following glossary is used to clarify certain concepts:
|
|
281
299
|
|
|
282
|
-
|
|
300
|
+
### General LLM / AI terms
|
|
283
301
|
|
|
284
302
|
- **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.
|
|
285
303
|
- **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.
|
|
@@ -290,9 +308,13 @@ The following glossary is used to clarify certain concepts:
|
|
|
290
308
|
- **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.
|
|
291
309
|
- **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.
|
|
292
310
|
|
|
293
|
-
_Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
|
|
294
311
|
|
|
295
|
-
|
|
312
|
+
|
|
313
|
+
_Note: This section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
### ๐ฏ Core concepts
|
|
296
318
|
|
|
297
319
|
- [๐ Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
|
|
298
320
|
- [๐ฏ Pipeline](https://github.com/webgptorg/promptbook/discussions/64)
|
|
@@ -305,7 +327,7 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
|
|
|
305
327
|
- [๐ฃ Words not tokens](https://github.com/webgptorg/promptbook/discussions/29)
|
|
306
328
|
- [โฏ Separation of concerns](https://github.com/webgptorg/promptbook/discussions/32)
|
|
307
329
|
|
|
308
|
-
|
|
330
|
+
#### Advanced concepts
|
|
309
331
|
|
|
310
332
|
- [๐ Knowledge (Retrieval-augmented generation)](https://github.com/webgptorg/promptbook/discussions/41)
|
|
311
333
|
- [๐ Remote server](https://github.com/webgptorg/promptbook/discussions/89)
|
|
@@ -320,11 +342,6 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
|
|
|
320
342
|
- [๐ฎ Agent adversary expectations](https://github.com/webgptorg/promptbook/discussions/39)
|
|
321
343
|
- [view more](https://github.com/webgptorg/promptbook/discussions/categories/concepts)
|
|
322
344
|
|
|
323
|
-
### Terms specific to Promptbook TypeScript implementation
|
|
324
|
-
|
|
325
|
-
- Anonymous mode
|
|
326
|
-
- Application mode
|
|
327
|
-
|
|
328
345
|
|
|
329
346
|
|
|
330
347
|
## ๐ Promptbook Engine
|
|
@@ -395,11 +412,11 @@ See [TODO.md](./TODO.md)
|
|
|
395
412
|
<div style="display: flex; align-items: center; gap: 20px;">
|
|
396
413
|
|
|
397
414
|
<a href="https://promptbook.studio/">
|
|
398
|
-
<img src="./design/promptbook-studio-logo.png" alt="Partner 3" height="
|
|
415
|
+
<img src="./design/promptbook-studio-logo.png" alt="Partner 3" height="70">
|
|
399
416
|
</a>
|
|
400
417
|
|
|
401
418
|
<a href="https://technologickainkubace.org/en/about-technology-incubation/about-the-project/">
|
|
402
|
-
<img src="./other/partners/CI-Technology-Incubation.png" alt="Technology Incubation" height="
|
|
419
|
+
<img src="./other/partners/CI-Technology-Incubation.png" alt="Technology Incubation" height="70">
|
|
403
420
|
</a>
|
|
404
421
|
|
|
405
422
|
</div>
|
package/esm/index.es.js
CHANGED
|
@@ -30,7 +30,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
|
|
|
30
30
|
* @generated
|
|
31
31
|
* @see https://github.com/webgptorg/promptbook
|
|
32
32
|
*/
|
|
33
|
-
const PROMPTBOOK_ENGINE_VERSION = '0.88.0
|
|
33
|
+
const PROMPTBOOK_ENGINE_VERSION = '0.88.0';
|
|
34
34
|
/**
|
|
35
35
|
* TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
|
|
36
36
|
* Note: [๐] Ignore a discrepancy between file name and entity name
|
|
@@ -157,7 +157,7 @@ const DEFAULT_MAX_PARALLEL_COUNT = 5; // <- TODO: [๐คนโโ๏ธ]
|
|
|
157
157
|
*
|
|
158
158
|
* @public exported from `@promptbook/core`
|
|
159
159
|
*/
|
|
160
|
-
const DEFAULT_MAX_EXECUTION_ATTEMPTS =
|
|
160
|
+
const DEFAULT_MAX_EXECUTION_ATTEMPTS = 10; // <- TODO: [๐คนโโ๏ธ]
|
|
161
161
|
// <- TODO: [๐] Make also `BOOKS_DIRNAME_ALTERNATIVES`
|
|
162
162
|
/**
|
|
163
163
|
* Where to store the temporary downloads
|
|
@@ -1642,11 +1642,17 @@ function jsonStringsToJsons(object) {
|
|
|
1642
1642
|
*/
|
|
1643
1643
|
class PipelineExecutionError extends Error {
|
|
1644
1644
|
constructor(message) {
|
|
1645
|
+
// Added id parameter
|
|
1645
1646
|
super(message);
|
|
1646
1647
|
this.name = 'PipelineExecutionError';
|
|
1648
|
+
// TODO: [๐] DRY - Maybe $randomId
|
|
1649
|
+
this.id = `error-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid simmilar char conflicts */)}`;
|
|
1647
1650
|
Object.setPrototypeOf(this, PipelineExecutionError.prototype);
|
|
1648
1651
|
}
|
|
1649
1652
|
}
|
|
1653
|
+
/**
|
|
1654
|
+
* TODO: !!!!!! Add id to all errors
|
|
1655
|
+
*/
|
|
1650
1656
|
|
|
1651
1657
|
/**
|
|
1652
1658
|
* This error indicates problems parsing the format value
|
|
@@ -1834,7 +1840,7 @@ const ALL_ERRORS = {
|
|
|
1834
1840
|
* @public exported from `@promptbook/utils`
|
|
1835
1841
|
*/
|
|
1836
1842
|
function deserializeError(error) {
|
|
1837
|
-
const { name, stack } = error;
|
|
1843
|
+
const { name, stack, id } = error; // Added id
|
|
1838
1844
|
let { message } = error;
|
|
1839
1845
|
let ErrorClass = ALL_ERRORS[error.name];
|
|
1840
1846
|
if (ErrorClass === undefined) {
|
|
@@ -1849,7 +1855,9 @@ function deserializeError(error) {
|
|
|
1849
1855
|
${block(stack || '')}
|
|
1850
1856
|
`);
|
|
1851
1857
|
}
|
|
1852
|
-
|
|
1858
|
+
const deserializedError = new ErrorClass(message);
|
|
1859
|
+
deserializedError.id = id; // Assign id to the error object
|
|
1860
|
+
return deserializedError;
|
|
1853
1861
|
}
|
|
1854
1862
|
|
|
1855
1863
|
/**
|
|
@@ -1899,6 +1907,7 @@ function assertsTaskSuccessful(executionResult) {
|
|
|
1899
1907
|
*/
|
|
1900
1908
|
function createTask(options) {
|
|
1901
1909
|
const { taskType, taskProcessCallback } = options;
|
|
1910
|
+
// TODO: [๐] DRY
|
|
1902
1911
|
const taskId = `${taskType.toLowerCase().substring(0, 4)}-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid simmilar char conflicts */)}`;
|
|
1903
1912
|
let status = 'RUNNING';
|
|
1904
1913
|
const createdAt = new Date();
|
|
@@ -1931,7 +1940,7 @@ function createTask(options) {
|
|
|
1931
1940
|
assertsTaskSuccessful(executionResult);
|
|
1932
1941
|
status = 'FINISHED';
|
|
1933
1942
|
currentValue = jsonStringsToJsons(executionResult);
|
|
1934
|
-
// <- TODO:
|
|
1943
|
+
// <- TODO: [๐ง ] Is this a good idea to convert JSON strins to JSONs?
|
|
1935
1944
|
partialResultSubject.next(executionResult);
|
|
1936
1945
|
}
|
|
1937
1946
|
catch (error) {
|
|
@@ -1995,19 +2004,21 @@ function createTask(options) {
|
|
|
1995
2004
|
*/
|
|
1996
2005
|
function serializeError(error) {
|
|
1997
2006
|
const { name, message, stack } = error;
|
|
2007
|
+
const { id } = error;
|
|
1998
2008
|
if (!Object.keys(ALL_ERRORS).includes(name)) {
|
|
1999
2009
|
console.error(spaceTrim((block) => `
|
|
2000
|
-
|
|
2010
|
+
|
|
2001
2011
|
Cannot serialize error with name "${name}"
|
|
2002
2012
|
|
|
2003
2013
|
${block(stack || message)}
|
|
2004
|
-
|
|
2014
|
+
|
|
2005
2015
|
`));
|
|
2006
2016
|
}
|
|
2007
2017
|
return {
|
|
2008
2018
|
name: name,
|
|
2009
2019
|
message,
|
|
2010
2020
|
stack,
|
|
2021
|
+
id, // Include id in the serialized object
|
|
2011
2022
|
};
|
|
2012
2023
|
}
|
|
2013
2024
|
|
|
@@ -3050,6 +3061,9 @@ function countCharacters(text) {
|
|
|
3050
3061
|
text = text.replace(/\p{Extended_Pictographic}(\u{200D}\p{Extended_Pictographic})*/gu, '-');
|
|
3051
3062
|
return text.length;
|
|
3052
3063
|
}
|
|
3064
|
+
/**
|
|
3065
|
+
* TODO: [๐ฅด] Implement counting in formats - like JSON, CSV, XML,...
|
|
3066
|
+
*/
|
|
3053
3067
|
|
|
3054
3068
|
/**
|
|
3055
3069
|
* Number of characters per standard line with 11pt Arial font size.
|
|
@@ -3081,6 +3095,9 @@ function countLines(text) {
|
|
|
3081
3095
|
const lines = text.split('\n');
|
|
3082
3096
|
return lines.reduce((count, line) => count + Math.ceil(line.length / CHARACTERS_PER_STANDARD_LINE), 0);
|
|
3083
3097
|
}
|
|
3098
|
+
/**
|
|
3099
|
+
* TODO: [๐ฅด] Implement counting in formats - like JSON, CSV, XML,...
|
|
3100
|
+
*/
|
|
3084
3101
|
|
|
3085
3102
|
/**
|
|
3086
3103
|
* Counts number of pages in the text
|
|
@@ -3092,6 +3109,9 @@ function countLines(text) {
|
|
|
3092
3109
|
function countPages(text) {
|
|
3093
3110
|
return Math.ceil(countLines(text) / LINES_PER_STANDARD_PAGE);
|
|
3094
3111
|
}
|
|
3112
|
+
/**
|
|
3113
|
+
* TODO: [๐ฅด] Implement counting in formats - like JSON, CSV, XML,...
|
|
3114
|
+
*/
|
|
3095
3115
|
|
|
3096
3116
|
/**
|
|
3097
3117
|
* Counts number of paragraphs in the text
|
|
@@ -3101,6 +3121,9 @@ function countPages(text) {
|
|
|
3101
3121
|
function countParagraphs(text) {
|
|
3102
3122
|
return text.split(/\n\s*\n/).filter((paragraph) => paragraph.trim() !== '').length;
|
|
3103
3123
|
}
|
|
3124
|
+
/**
|
|
3125
|
+
* TODO: [๐ฅด] Implement counting in formats - like JSON, CSV, XML,...
|
|
3126
|
+
*/
|
|
3104
3127
|
|
|
3105
3128
|
/**
|
|
3106
3129
|
* Split text into sentences
|
|
@@ -3118,6 +3141,9 @@ function splitIntoSentences(text) {
|
|
|
3118
3141
|
function countSentences(text) {
|
|
3119
3142
|
return splitIntoSentences(text).length;
|
|
3120
3143
|
}
|
|
3144
|
+
/**
|
|
3145
|
+
* TODO: [๐ฅด] Implement counting in formats - like JSON, CSV, XML,...
|
|
3146
|
+
*/
|
|
3121
3147
|
|
|
3122
3148
|
const defaultDiacriticsRemovalMap = [
|
|
3123
3149
|
{
|
|
@@ -3392,6 +3418,9 @@ function countWords(text) {
|
|
|
3392
3418
|
text = text.replace(/([a-z])([A-Z])/g, '$1 $2');
|
|
3393
3419
|
return text.split(/[^a-zะฐ-ั0-9]+/i).filter((word) => word.length > 0).length;
|
|
3394
3420
|
}
|
|
3421
|
+
/**
|
|
3422
|
+
* TODO: [๐ฅด] Implement counting in formats - like JSON, CSV, XML,...
|
|
3423
|
+
*/
|
|
3395
3424
|
|
|
3396
3425
|
/**
|
|
3397
3426
|
* Index of all counter functions
|