@promptbook/pdf 0.88.0-1 → 0.88.0-10
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 +16 -40
- package/esm/index.es.js +82 -9
- package/esm/index.es.js.map +1 -1
- package/esm/typings/src/_packages/types.index.d.ts +2 -0
- package/esm/typings/src/_packages/utils.index.d.ts +2 -0
- package/esm/typings/src/cli/cli-commands/common/handleActionErrors.d.ts +11 -0
- package/esm/typings/src/execution/ExecutionTask.d.ts +24 -0
- package/esm/typings/src/utils/serialization/jsonStringsToJsons.d.ts +9 -0
- package/esm/typings/src/utils/serialization/jsonStringsToJsons.test.d.ts +1 -0
- package/package.json +2 -2
- package/umd/index.umd.js +81 -8
- package/umd/index.umd.js.map +1 -1
package/README.md
CHANGED
|
@@ -60,8 +60,6 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
|
|
|
60
60
|
|
|
61
61
|
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
62
|
|
|
63
|
-
|
|
64
|
-
|
|
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.
|
|
@@ -118,27 +116,28 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
|
|
|
118
116
|
</tbody>
|
|
119
117
|
</table>
|
|
120
118
|
|
|
119
|
+
Hello world examples:
|
|
120
|
+
|
|
121
|
+
- [Hello world](https://github.com/webgptorg/hello-world)
|
|
122
|
+
- [Hello world in Node.js](https://github.com/webgptorg/hello-world-node-js)
|
|
123
|
+
- [Hello world in Next.js](https://github.com/webgptorg/hello-world-next-js)
|
|
124
|
+
|
|
121
125
|
We also have a community of developers and users of **Promptbook**:
|
|
122
126
|
|
|
123
127
|
- [Discord community](https://discord.gg/x3QWNaa89N)
|
|
124
128
|
- [Landing page `ptbk.io`](https://ptbk.io)
|
|
125
129
|
- [Github discussions](https://github.com/webgptorg/promptbook/discussions)
|
|
126
130
|
- [LinkedIn `Promptbook`](https://linkedin.com/company/promptbook)
|
|
127
|
-
- [Facebook `Promptbook`](https://www.facebook.com/61560776453536)
|
|
131
|
+
- [Facebook `Promptbook`](https://www.facebook.com/61560776453536)
|
|
128
132
|
|
|
129
133
|
And **Promptbook.studio** branded socials:
|
|
130
134
|
|
|
131
|
-
|
|
132
|
-
|
|
133
135
|
- [Instagram `@promptbook.studio`](https://www.instagram.com/promptbook.studio/)
|
|
134
136
|
|
|
135
137
|
And **Promptujeme** sub-brand:
|
|
136
138
|
|
|
137
139
|
_/Subbrand for Czech clients/_
|
|
138
140
|
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
141
|
- [Promptujeme.cz](https://www.promptujeme.cz/)
|
|
143
142
|
- [Facebook `Promptujeme`](https://www.facebook.com/promptujeme/)
|
|
144
143
|
|
|
@@ -156,8 +155,6 @@ _/Sub-brand for images and graphics generated via Promptbook prompting/_
|
|
|
156
155
|
|
|
157
156
|
## 💙 The Book language
|
|
158
157
|
|
|
159
|
-
|
|
160
|
-
|
|
161
158
|
Following is the documentation and blueprint of the [Book language](https://github.com/webgptorg/book).
|
|
162
159
|
|
|
163
160
|
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.
|
|
@@ -207,8 +204,6 @@ Personas can have access to different knowledge, tools and actions. They can als
|
|
|
207
204
|
|
|
208
205
|
- [PERSONA](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PERSONA.md)
|
|
209
206
|
|
|
210
|
-
|
|
211
|
-
|
|
212
207
|
### **How:** Knowledge, Instruments and Actions
|
|
213
208
|
|
|
214
209
|
The resources used by the personas are used to do the work.
|
|
@@ -284,16 +279,9 @@ Or you can install them separately:
|
|
|
284
279
|
|
|
285
280
|
## 📚 Dictionary
|
|
286
281
|
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
### 📚 Dictionary
|
|
293
|
-
|
|
294
282
|
The following glossary is used to clarify certain concepts:
|
|
295
283
|
|
|
296
|
-
|
|
284
|
+
### General LLM / AI terms
|
|
297
285
|
|
|
298
286
|
- **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.
|
|
299
287
|
- **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.
|
|
@@ -304,13 +292,9 @@ The following glossary is used to clarify certain concepts:
|
|
|
304
292
|
- **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.
|
|
305
293
|
- **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.
|
|
306
294
|
|
|
295
|
+
_Note: This section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
|
|
307
296
|
|
|
308
|
-
|
|
309
|
-
_Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
#### 💯 Core concepts
|
|
297
|
+
### 💯 Core concepts
|
|
314
298
|
|
|
315
299
|
- [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
|
|
316
300
|
- [📯 Pipeline](https://github.com/webgptorg/promptbook/discussions/64)
|
|
@@ -323,7 +307,7 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
|
|
|
323
307
|
- [🔣 Words not tokens](https://github.com/webgptorg/promptbook/discussions/29)
|
|
324
308
|
- [☯ Separation of concerns](https://github.com/webgptorg/promptbook/discussions/32)
|
|
325
309
|
|
|
326
|
-
|
|
310
|
+
#### Advanced concepts
|
|
327
311
|
|
|
328
312
|
- [📚 Knowledge (Retrieval-augmented generation)](https://github.com/webgptorg/promptbook/discussions/41)
|
|
329
313
|
- [🌏 Remote server](https://github.com/webgptorg/promptbook/discussions/89)
|
|
@@ -340,17 +324,9 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
|
|
|
340
324
|
|
|
341
325
|
|
|
342
326
|
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
- Anonymous mode
|
|
346
|
-
- Application mode
|
|
347
|
-
|
|
327
|
+
## 🚂 Promptbook Engine
|
|
348
328
|
|
|
349
|
-
|
|
350
|
-
## 🔌 Usage in Typescript / Javascript
|
|
351
|
-
|
|
352
|
-
- [Simple usage](./examples/usage/simple-script)
|
|
353
|
-
- [Usage with client and remote server](./examples/usage/remote)
|
|
329
|
+

|
|
354
330
|
|
|
355
331
|
## ➕➖ When to use Promptbook?
|
|
356
332
|
|
|
@@ -416,13 +392,13 @@ See [TODO.md](./TODO.md)
|
|
|
416
392
|
<div style="display: flex; align-items: center; gap: 20px;">
|
|
417
393
|
|
|
418
394
|
<a href="https://promptbook.studio/">
|
|
419
|
-
<img src="./design/promptbook-studio-logo.png" alt="Partner 3" height="
|
|
395
|
+
<img src="./design/promptbook-studio-logo.png" alt="Partner 3" height="70">
|
|
420
396
|
</a>
|
|
421
397
|
|
|
422
398
|
<a href="https://technologickainkubace.org/en/about-technology-incubation/about-the-project/">
|
|
423
|
-
<img src="./other/partners/CI-Technology-Incubation.png" alt="Technology Incubation" height="
|
|
399
|
+
<img src="./other/partners/CI-Technology-Incubation.png" alt="Technology Incubation" height="70">
|
|
424
400
|
</a>
|
|
425
|
-
|
|
401
|
+
|
|
426
402
|
</div>
|
|
427
403
|
|
|
428
404
|
## 🖋️ Contributing
|
package/esm/index.es.js
CHANGED
|
@@ -5,7 +5,7 @@ import hexEncoder from 'crypto-js/enc-hex';
|
|
|
5
5
|
import { basename, join, dirname } from 'path';
|
|
6
6
|
import { format } from 'prettier';
|
|
7
7
|
import parserHtml from 'prettier/parser-html';
|
|
8
|
-
import {
|
|
8
|
+
import { Subject } from 'rxjs';
|
|
9
9
|
import { randomBytes } from 'crypto';
|
|
10
10
|
import { forTime } from 'waitasecond';
|
|
11
11
|
import sha256 from 'crypto-js/sha256';
|
|
@@ -26,7 +26,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
|
|
|
26
26
|
* @generated
|
|
27
27
|
* @see https://github.com/webgptorg/promptbook
|
|
28
28
|
*/
|
|
29
|
-
const PROMPTBOOK_ENGINE_VERSION = '0.88.0-
|
|
29
|
+
const PROMPTBOOK_ENGINE_VERSION = '0.88.0-10';
|
|
30
30
|
/**
|
|
31
31
|
* TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
|
|
32
32
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
@@ -2081,6 +2081,36 @@ function $randomToken(randomness) {
|
|
|
2081
2081
|
* TODO: Maybe use nanoid instead https://github.com/ai/nanoid
|
|
2082
2082
|
*/
|
|
2083
2083
|
|
|
2084
|
+
/**
|
|
2085
|
+
* Recursively converts JSON strings to JSON objects
|
|
2086
|
+
|
|
2087
|
+
* @public exported from `@promptbook/utils`
|
|
2088
|
+
*/
|
|
2089
|
+
function jsonStringsToJsons(object) {
|
|
2090
|
+
if (object === null) {
|
|
2091
|
+
return object;
|
|
2092
|
+
}
|
|
2093
|
+
if (Array.isArray(object)) {
|
|
2094
|
+
return object.map(jsonStringsToJsons);
|
|
2095
|
+
}
|
|
2096
|
+
if (typeof object !== 'object') {
|
|
2097
|
+
return object;
|
|
2098
|
+
}
|
|
2099
|
+
const newObject = { ...object };
|
|
2100
|
+
for (const [key, value] of Object.entries(object)) {
|
|
2101
|
+
if (typeof value === 'string' && isValidJsonString(value)) {
|
|
2102
|
+
newObject[key] = JSON.parse(value);
|
|
2103
|
+
}
|
|
2104
|
+
else {
|
|
2105
|
+
newObject[key] = jsonStringsToJsons(value);
|
|
2106
|
+
}
|
|
2107
|
+
}
|
|
2108
|
+
return newObject;
|
|
2109
|
+
}
|
|
2110
|
+
/**
|
|
2111
|
+
* TODO: Type the return type correctly
|
|
2112
|
+
*/
|
|
2113
|
+
|
|
2084
2114
|
/**
|
|
2085
2115
|
* This error indicates problems parsing the format value
|
|
2086
2116
|
*
|
|
@@ -2307,21 +2337,43 @@ function assertsTaskSuccessful(executionResult) {
|
|
|
2307
2337
|
function createTask(options) {
|
|
2308
2338
|
const { taskType, taskProcessCallback } = options;
|
|
2309
2339
|
const taskId = `${taskType.toLowerCase().substring(0, 4)}-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid simmilar char conflicts */)}`;
|
|
2310
|
-
|
|
2340
|
+
let status = 'RUNNING';
|
|
2341
|
+
const createdAt = new Date();
|
|
2342
|
+
let updatedAt = createdAt;
|
|
2343
|
+
const errors = [];
|
|
2344
|
+
const warnings = [];
|
|
2345
|
+
let currentValue = {};
|
|
2346
|
+
const partialResultSubject = new Subject();
|
|
2347
|
+
// <- Note: Not using `BehaviorSubject` because on error we can't access the last value
|
|
2311
2348
|
const finalResultPromise = /* not await */ taskProcessCallback((newOngoingResult) => {
|
|
2349
|
+
Object.assign(currentValue, newOngoingResult);
|
|
2350
|
+
// <- TODO: assign deep
|
|
2312
2351
|
partialResultSubject.next(newOngoingResult);
|
|
2313
2352
|
});
|
|
2314
2353
|
finalResultPromise
|
|
2315
2354
|
.catch((error) => {
|
|
2355
|
+
errors.push(error);
|
|
2316
2356
|
partialResultSubject.error(error);
|
|
2317
2357
|
})
|
|
2318
|
-
.then((
|
|
2319
|
-
if (
|
|
2358
|
+
.then((executionResult) => {
|
|
2359
|
+
if (executionResult) {
|
|
2320
2360
|
try {
|
|
2321
|
-
|
|
2322
|
-
|
|
2361
|
+
updatedAt = new Date();
|
|
2362
|
+
errors.push(...executionResult.errors);
|
|
2363
|
+
warnings.push(...executionResult.warnings);
|
|
2364
|
+
// <- TODO: !!! Only unique errors and warnings should be added (or filtered)
|
|
2365
|
+
// TODO: [🧠] !!! errors, warning, isSuccessful are redundant both in `ExecutionTask` and `ExecutionTask.currentValue`
|
|
2366
|
+
// Also maybe move `ExecutionTask.currentValue.usage` -> `ExecutionTask.usage`
|
|
2367
|
+
// And delete `ExecutionTask.currentValue.preparedPipeline`
|
|
2368
|
+
assertsTaskSuccessful(executionResult);
|
|
2369
|
+
status = 'FINISHED';
|
|
2370
|
+
currentValue = jsonStringsToJsons(executionResult);
|
|
2371
|
+
// <- TODO: [🧠] Is this a good idea to convert JSON strins to JSONs?
|
|
2372
|
+
partialResultSubject.next(executionResult);
|
|
2323
2373
|
}
|
|
2324
2374
|
catch (error) {
|
|
2375
|
+
status = 'ERROR';
|
|
2376
|
+
errors.push(error);
|
|
2325
2377
|
partialResultSubject.error(error);
|
|
2326
2378
|
}
|
|
2327
2379
|
}
|
|
@@ -2338,12 +2390,33 @@ function createTask(options) {
|
|
|
2338
2390
|
return {
|
|
2339
2391
|
taskType,
|
|
2340
2392
|
taskId,
|
|
2393
|
+
get status() {
|
|
2394
|
+
return status;
|
|
2395
|
+
// <- Note: [1] Theese must be getters to allow changing the value in the future
|
|
2396
|
+
},
|
|
2397
|
+
get createdAt() {
|
|
2398
|
+
return createdAt;
|
|
2399
|
+
// <- Note: [1]
|
|
2400
|
+
},
|
|
2401
|
+
get updatedAt() {
|
|
2402
|
+
return updatedAt;
|
|
2403
|
+
// <- Note: [1]
|
|
2404
|
+
},
|
|
2341
2405
|
asPromise,
|
|
2342
2406
|
asObservable() {
|
|
2343
2407
|
return partialResultSubject.asObservable();
|
|
2344
2408
|
},
|
|
2409
|
+
get errors() {
|
|
2410
|
+
return errors;
|
|
2411
|
+
// <- Note: [1]
|
|
2412
|
+
},
|
|
2413
|
+
get warnings() {
|
|
2414
|
+
return warnings;
|
|
2415
|
+
// <- Note: [1]
|
|
2416
|
+
},
|
|
2345
2417
|
get currentValue() {
|
|
2346
|
-
return
|
|
2418
|
+
return currentValue;
|
|
2419
|
+
// <- Note: [1]
|
|
2347
2420
|
},
|
|
2348
2421
|
};
|
|
2349
2422
|
}
|
|
@@ -4718,7 +4791,7 @@ async function executeAttempts(options) {
|
|
|
4718
4791
|
Last result:
|
|
4719
4792
|
${block($ongoingTaskResult.$resultString === null
|
|
4720
4793
|
? 'null'
|
|
4721
|
-
: $ongoingTaskResult.$resultString
|
|
4794
|
+
: spaceTrim$1($ongoingTaskResult.$resultString)
|
|
4722
4795
|
.split('\n')
|
|
4723
4796
|
.map((line) => `> ${line}`)
|
|
4724
4797
|
.join('\n'))}
|