@promptbook/remote-client 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 +27 -3
- 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 +3 -2
- package/umd/index.umd.js +30 -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/remote-client`
|
|
31
27
|
|
|
32
28
|
- Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
|
|
@@ -58,6 +54,8 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
|
|
|
58
54
|
|
|
59
55
|
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**!
|
|
60
56
|
|
|
57
|
+
|
|
58
|
+
|
|
61
59
|
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!
|
|
62
60
|
|
|
63
61
|
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.
|
|
@@ -68,6 +66,9 @@ This shift is going to happen, whether we are ready for it or not. Our mission i
|
|
|
68
66
|
|
|
69
67
|
|
|
70
68
|
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
71
72
|
## 🚀 Get started
|
|
72
73
|
|
|
73
74
|
Take a look at the simple starter kit with books integrated into the **Hello World** sample applications:
|
|
@@ -79,6 +80,8 @@ Take a look at the simple starter kit with books integrated into the **Hello Wor
|
|
|
79
80
|
|
|
80
81
|
|
|
81
82
|
|
|
83
|
+
|
|
84
|
+
|
|
82
85
|
## 💜 The Promptbook Project
|
|
83
86
|
|
|
84
87
|
Promptbook project is ecosystem of multiple projects and tools, following is a list of most important pieces of the project:
|
|
@@ -114,22 +117,35 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
|
|
|
114
117
|
</tbody>
|
|
115
118
|
</table>
|
|
116
119
|
|
|
120
|
+
Hello world examples:
|
|
121
|
+
|
|
122
|
+
- [Hello world](https://github.com/webgptorg/hello-world)
|
|
123
|
+
- [Hello world in Node.js](https://github.com/webgptorg/hello-world-node-js)
|
|
124
|
+
- [Hello world in Next.js](https://github.com/webgptorg/hello-world-next-js)
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
117
128
|
We also have a community of developers and users of **Promptbook**:
|
|
118
129
|
|
|
119
130
|
- [Discord community](https://discord.gg/x3QWNaa89N)
|
|
120
131
|
- [Landing page `ptbk.io`](https://ptbk.io)
|
|
121
132
|
- [Github discussions](https://github.com/webgptorg/promptbook/discussions)
|
|
122
133
|
- [LinkedIn `Promptbook`](https://linkedin.com/company/promptbook)
|
|
123
|
-
- [Facebook `Promptbook`](https://www.facebook.com/61560776453536)
|
|
134
|
+
- [Facebook `Promptbook`](https://www.facebook.com/61560776453536)
|
|
124
135
|
|
|
125
136
|
And **Promptbook.studio** branded socials:
|
|
126
137
|
|
|
138
|
+
|
|
139
|
+
|
|
127
140
|
- [Instagram `@promptbook.studio`](https://www.instagram.com/promptbook.studio/)
|
|
128
141
|
|
|
129
142
|
And **Promptujeme** sub-brand:
|
|
130
143
|
|
|
131
144
|
_/Subbrand for Czech clients/_
|
|
132
145
|
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
133
149
|
- [Promptujeme.cz](https://www.promptujeme.cz/)
|
|
134
150
|
- [Facebook `Promptujeme`](https://www.facebook.com/promptujeme/)
|
|
135
151
|
|
|
@@ -147,6 +163,8 @@ _/Sub-brand for images and graphics generated via Promptbook prompting/_
|
|
|
147
163
|
|
|
148
164
|
## 💙 The Book language
|
|
149
165
|
|
|
166
|
+
|
|
167
|
+
|
|
150
168
|
Following is the documentation and blueprint of the [Book language](https://github.com/webgptorg/book).
|
|
151
169
|
|
|
152
170
|
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.
|
|
@@ -196,6 +214,8 @@ Personas can have access to different knowledge, tools and actions. They can als
|
|
|
196
214
|
|
|
197
215
|
- [PERSONA](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PERSONA.md)
|
|
198
216
|
|
|
217
|
+
|
|
218
|
+
|
|
199
219
|
### **How:** Knowledge, Instruments and Actions
|
|
200
220
|
|
|
201
221
|
The resources used by the personas are used to do the work.
|
|
@@ -271,11 +291,9 @@ Or you can install them separately:
|
|
|
271
291
|
|
|
272
292
|
## 📚 Dictionary
|
|
273
293
|
|
|
274
|
-
### 📚 Dictionary
|
|
275
|
-
|
|
276
294
|
The following glossary is used to clarify certain concepts:
|
|
277
295
|
|
|
278
|
-
|
|
296
|
+
### General LLM / AI terms
|
|
279
297
|
|
|
280
298
|
- **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.
|
|
281
299
|
- **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.
|
|
@@ -286,9 +304,13 @@ The following glossary is used to clarify certain concepts:
|
|
|
286
304
|
- **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.
|
|
287
305
|
- **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.
|
|
288
306
|
|
|
289
|
-
_Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
|
|
290
307
|
|
|
291
|
-
|
|
308
|
+
|
|
309
|
+
_Note: This section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
### 💯 Core concepts
|
|
292
314
|
|
|
293
315
|
- [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
|
|
294
316
|
- [📯 Pipeline](https://github.com/webgptorg/promptbook/discussions/64)
|
|
@@ -301,7 +323,7 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
|
|
|
301
323
|
- [🔣 Words not tokens](https://github.com/webgptorg/promptbook/discussions/29)
|
|
302
324
|
- [☯ Separation of concerns](https://github.com/webgptorg/promptbook/discussions/32)
|
|
303
325
|
|
|
304
|
-
|
|
326
|
+
#### Advanced concepts
|
|
305
327
|
|
|
306
328
|
- [📚 Knowledge (Retrieval-augmented generation)](https://github.com/webgptorg/promptbook/discussions/41)
|
|
307
329
|
- [🌏 Remote server](https://github.com/webgptorg/promptbook/discussions/89)
|
|
@@ -316,11 +338,6 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
|
|
|
316
338
|
- [👮 Agent adversary expectations](https://github.com/webgptorg/promptbook/discussions/39)
|
|
317
339
|
- [view more](https://github.com/webgptorg/promptbook/discussions/categories/concepts)
|
|
318
340
|
|
|
319
|
-
### Terms specific to Promptbook TypeScript implementation
|
|
320
|
-
|
|
321
|
-
- Anonymous mode
|
|
322
|
-
- Application mode
|
|
323
|
-
|
|
324
341
|
|
|
325
342
|
|
|
326
343
|
## 🚂 Promptbook Engine
|
|
@@ -391,11 +408,11 @@ See [TODO.md](./TODO.md)
|
|
|
391
408
|
<div style="display: flex; align-items: center; gap: 20px;">
|
|
392
409
|
|
|
393
410
|
<a href="https://promptbook.studio/">
|
|
394
|
-
<img src="./design/promptbook-studio-logo.png" alt="Partner 3" height="
|
|
411
|
+
<img src="./design/promptbook-studio-logo.png" alt="Partner 3" height="70">
|
|
395
412
|
</a>
|
|
396
413
|
|
|
397
414
|
<a href="https://technologickainkubace.org/en/about-technology-incubation/about-the-project/">
|
|
398
|
-
<img src="./other/partners/CI-Technology-Incubation.png" alt="Technology Incubation" height="
|
|
415
|
+
<img src="./other/partners/CI-Technology-Incubation.png" alt="Technology Incubation" height="70">
|
|
399
416
|
</a>
|
|
400
417
|
|
|
401
418
|
</div>
|
package/esm/index.es.js
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import spaceTrim$1, { spaceTrim } from 'spacetrim';
|
|
2
|
+
import { randomBytes } from 'crypto';
|
|
2
3
|
import { io } from 'socket.io-client';
|
|
3
4
|
import { SHA256 } from 'crypto-js';
|
|
4
5
|
import hexEncoder from 'crypto-js/enc-hex';
|
|
@@ -19,7 +20,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
|
|
|
19
20
|
* @generated
|
|
20
21
|
* @see https://github.com/webgptorg/promptbook
|
|
21
22
|
*/
|
|
22
|
-
const PROMPTBOOK_ENGINE_VERSION = '0.88.0
|
|
23
|
+
const PROMPTBOOK_ENGINE_VERSION = '0.88.0';
|
|
23
24
|
/**
|
|
24
25
|
* TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
|
|
25
26
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
@@ -193,6 +194,21 @@ class ParseError extends Error {
|
|
|
193
194
|
* TODO: Maybe split `ParseError` and `ApplyError`
|
|
194
195
|
*/
|
|
195
196
|
|
|
197
|
+
/**
|
|
198
|
+
* Generates random token
|
|
199
|
+
*
|
|
200
|
+
* Note: This function is cryptographically secure (it uses crypto.randomBytes internally)
|
|
201
|
+
*
|
|
202
|
+
* @private internal helper function
|
|
203
|
+
* @returns secure random token
|
|
204
|
+
*/
|
|
205
|
+
function $randomToken(randomness) {
|
|
206
|
+
return randomBytes(randomness).toString('hex');
|
|
207
|
+
}
|
|
208
|
+
/**
|
|
209
|
+
* TODO: Maybe use nanoid instead https://github.com/ai/nanoid
|
|
210
|
+
*/
|
|
211
|
+
|
|
196
212
|
/**
|
|
197
213
|
* This error indicates errors during the execution of the pipeline
|
|
198
214
|
*
|
|
@@ -200,11 +216,17 @@ class ParseError extends Error {
|
|
|
200
216
|
*/
|
|
201
217
|
class PipelineExecutionError extends Error {
|
|
202
218
|
constructor(message) {
|
|
219
|
+
// Added id parameter
|
|
203
220
|
super(message);
|
|
204
221
|
this.name = 'PipelineExecutionError';
|
|
222
|
+
// TODO: [🐙] DRY - Maybe $randomId
|
|
223
|
+
this.id = `error-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid simmilar char conflicts */)}`;
|
|
205
224
|
Object.setPrototypeOf(this, PipelineExecutionError.prototype);
|
|
206
225
|
}
|
|
207
226
|
}
|
|
227
|
+
/**
|
|
228
|
+
* TODO: !!!!!! Add id to all errors
|
|
229
|
+
*/
|
|
208
230
|
|
|
209
231
|
/**
|
|
210
232
|
* This error indicates that the promptbook object has valid syntax (=can be parsed) but contains logical errors (like circular dependencies)
|
|
@@ -460,7 +482,7 @@ const ALL_ERRORS = {
|
|
|
460
482
|
* @public exported from `@promptbook/utils`
|
|
461
483
|
*/
|
|
462
484
|
function deserializeError(error) {
|
|
463
|
-
const { name, stack } = error;
|
|
485
|
+
const { name, stack, id } = error; // Added id
|
|
464
486
|
let { message } = error;
|
|
465
487
|
let ErrorClass = ALL_ERRORS[error.name];
|
|
466
488
|
if (ErrorClass === undefined) {
|
|
@@ -475,7 +497,9 @@ function deserializeError(error) {
|
|
|
475
497
|
${block(stack || '')}
|
|
476
498
|
`);
|
|
477
499
|
}
|
|
478
|
-
|
|
500
|
+
const deserializedError = new ErrorClass(message);
|
|
501
|
+
deserializedError.id = id; // Assign id to the error object
|
|
502
|
+
return deserializedError;
|
|
479
503
|
}
|
|
480
504
|
|
|
481
505
|
/**
|