@promptbook/node 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 CHANGED
@@ -62,8 +62,6 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
62
62
 
63
63
  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
64
 
65
-
66
-
67
65
  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!
68
66
 
69
67
  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.
@@ -120,27 +118,28 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
120
118
  </tbody>
121
119
  </table>
122
120
 
121
+ Hello world examples:
122
+
123
+ - [Hello world](https://github.com/webgptorg/hello-world)
124
+ - [Hello world in Node.js](https://github.com/webgptorg/hello-world-node-js)
125
+ - [Hello world in Next.js](https://github.com/webgptorg/hello-world-next-js)
126
+
123
127
  We also have a community of developers and users of **Promptbook**:
124
128
 
125
129
  - [Discord community](https://discord.gg/x3QWNaa89N)
126
130
  - [Landing page `ptbk.io`](https://ptbk.io)
127
131
  - [Github discussions](https://github.com/webgptorg/promptbook/discussions)
128
132
  - [LinkedIn `Promptbook`](https://linkedin.com/company/promptbook)
129
- - [Facebook `Promptbook`](https://www.facebook.com/61560776453536)
133
+ - [Facebook `Promptbook`](https://www.facebook.com/61560776453536)
130
134
 
131
135
  And **Promptbook.studio** branded socials:
132
136
 
133
-
134
-
135
137
  - [Instagram `@promptbook.studio`](https://www.instagram.com/promptbook.studio/)
136
138
 
137
139
  And **Promptujeme** sub-brand:
138
140
 
139
141
  _/Subbrand for Czech clients/_
140
142
 
141
-
142
-
143
-
144
143
  - [Promptujeme.cz](https://www.promptujeme.cz/)
145
144
  - [Facebook `Promptujeme`](https://www.facebook.com/promptujeme/)
146
145
 
@@ -158,8 +157,6 @@ _/Sub-brand for images and graphics generated via Promptbook prompting/_
158
157
 
159
158
  ## 💙 The Book language
160
159
 
161
-
162
-
163
160
  Following is the documentation and blueprint of the [Book language](https://github.com/webgptorg/book).
164
161
 
165
162
  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.
@@ -209,8 +206,6 @@ Personas can have access to different knowledge, tools and actions. They can als
209
206
 
210
207
  - [PERSONA](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PERSONA.md)
211
208
 
212
-
213
-
214
209
  ### **How:** Knowledge, Instruments and Actions
215
210
 
216
211
  The resources used by the personas are used to do the work.
@@ -286,16 +281,9 @@ Or you can install them separately:
286
281
 
287
282
  ## 📚 Dictionary
288
283
 
289
-
290
-
291
-
292
-
293
-
294
- ### 📚 Dictionary
295
-
296
284
  The following glossary is used to clarify certain concepts:
297
285
 
298
- #### General LLM / AI terms
286
+ ### General LLM / AI terms
299
287
 
300
288
  - **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.
301
289
  - **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.
@@ -306,13 +294,9 @@ The following glossary is used to clarify certain concepts:
306
294
  - **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.
307
295
  - **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.
308
296
 
297
+ _Note: This section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
309
298
 
310
-
311
- _Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
312
-
313
-
314
-
315
- #### 💯 Core concepts
299
+ ### 💯 Core concepts
316
300
 
317
301
  - [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
318
302
  - [📯 Pipeline](https://github.com/webgptorg/promptbook/discussions/64)
@@ -325,7 +309,7 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
325
309
  - [🔣 Words not tokens](https://github.com/webgptorg/promptbook/discussions/29)
326
310
  - [☯ Separation of concerns](https://github.com/webgptorg/promptbook/discussions/32)
327
311
 
328
- ##### Advanced concepts
312
+ #### Advanced concepts
329
313
 
330
314
  - [📚 Knowledge (Retrieval-augmented generation)](https://github.com/webgptorg/promptbook/discussions/41)
331
315
  - [🌏 Remote server](https://github.com/webgptorg/promptbook/discussions/89)
@@ -342,17 +326,9 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
342
326
 
343
327
 
344
328
 
345
- ### Terms specific to Promptbook TypeScript implementation
346
-
347
- - Anonymous mode
348
- - Application mode
349
-
329
+ ## 🚂 Promptbook Engine
350
330
 
351
-
352
- ## 🔌 Usage in Typescript / Javascript
353
-
354
- - [Simple usage](./examples/usage/simple-script)
355
- - [Usage with client and remote server](./examples/usage/remote)
331
+ ![Schema of Promptbook Engine](./documents/promptbook-engine.svg)
356
332
 
357
333
  ## ➕➖ When to use Promptbook?
358
334
 
@@ -418,13 +394,13 @@ See [TODO.md](./TODO.md)
418
394
  <div style="display: flex; align-items: center; gap: 20px;">
419
395
 
420
396
  <a href="https://promptbook.studio/">
421
- <img src="./design/promptbook-studio-logo.png" alt="Partner 3" height="100">
397
+ <img src="./design/promptbook-studio-logo.png" alt="Partner 3" height="70">
422
398
  </a>
423
399
 
424
400
  <a href="https://technologickainkubace.org/en/about-technology-incubation/about-the-project/">
425
- <img src="./other/partners/CI-Technology-Incubation.png" alt="Technology Incubation" height="100">
401
+ <img src="./other/partners/CI-Technology-Incubation.png" alt="Technology Incubation" height="70">
426
402
  </a>
427
-
403
+
428
404
  </div>
429
405
 
430
406
  ## 🖋️ Contributing
package/esm/index.es.js CHANGED
@@ -5,7 +5,7 @@ import spaceTrim, { spaceTrim as spaceTrim$1 } from 'spacetrim';
5
5
  import JSZip from 'jszip';
6
6
  import { format } from 'prettier';
7
7
  import parserHtml from 'prettier/parser-html';
8
- import { BehaviorSubject } from 'rxjs';
8
+ import { Subject } from 'rxjs';
9
9
  import { randomBytes } from 'crypto';
10
10
  import { forTime } from 'waitasecond';
11
11
  import { parse, unparse } from 'papaparse';
@@ -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-1';
33
+ const PROMPTBOOK_ENGINE_VERSION = '0.88.0-10';
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
@@ -1605,6 +1605,36 @@ function $randomToken(randomness) {
1605
1605
  * TODO: Maybe use nanoid instead https://github.com/ai/nanoid
1606
1606
  */
1607
1607
 
1608
+ /**
1609
+ * Recursively converts JSON strings to JSON objects
1610
+
1611
+ * @public exported from `@promptbook/utils`
1612
+ */
1613
+ function jsonStringsToJsons(object) {
1614
+ if (object === null) {
1615
+ return object;
1616
+ }
1617
+ if (Array.isArray(object)) {
1618
+ return object.map(jsonStringsToJsons);
1619
+ }
1620
+ if (typeof object !== 'object') {
1621
+ return object;
1622
+ }
1623
+ const newObject = { ...object };
1624
+ for (const [key, value] of Object.entries(object)) {
1625
+ if (typeof value === 'string' && isValidJsonString(value)) {
1626
+ newObject[key] = JSON.parse(value);
1627
+ }
1628
+ else {
1629
+ newObject[key] = jsonStringsToJsons(value);
1630
+ }
1631
+ }
1632
+ return newObject;
1633
+ }
1634
+ /**
1635
+ * TODO: Type the return type correctly
1636
+ */
1637
+
1608
1638
  /**
1609
1639
  * This error indicates errors during the execution of the pipeline
1610
1640
  *
@@ -1870,21 +1900,43 @@ function assertsTaskSuccessful(executionResult) {
1870
1900
  function createTask(options) {
1871
1901
  const { taskType, taskProcessCallback } = options;
1872
1902
  const taskId = `${taskType.toLowerCase().substring(0, 4)}-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid simmilar char conflicts */)}`;
1873
- const partialResultSubject = new BehaviorSubject({});
1903
+ let status = 'RUNNING';
1904
+ const createdAt = new Date();
1905
+ let updatedAt = createdAt;
1906
+ const errors = [];
1907
+ const warnings = [];
1908
+ let currentValue = {};
1909
+ const partialResultSubject = new Subject();
1910
+ // <- Note: Not using `BehaviorSubject` because on error we can't access the last value
1874
1911
  const finalResultPromise = /* not await */ taskProcessCallback((newOngoingResult) => {
1912
+ Object.assign(currentValue, newOngoingResult);
1913
+ // <- TODO: assign deep
1875
1914
  partialResultSubject.next(newOngoingResult);
1876
1915
  });
1877
1916
  finalResultPromise
1878
1917
  .catch((error) => {
1918
+ errors.push(error);
1879
1919
  partialResultSubject.error(error);
1880
1920
  })
1881
- .then((value) => {
1882
- if (value) {
1921
+ .then((executionResult) => {
1922
+ if (executionResult) {
1883
1923
  try {
1884
- assertsTaskSuccessful(value);
1885
- partialResultSubject.next(value);
1924
+ updatedAt = new Date();
1925
+ errors.push(...executionResult.errors);
1926
+ warnings.push(...executionResult.warnings);
1927
+ // <- TODO: !!! Only unique errors and warnings should be added (or filtered)
1928
+ // TODO: [🧠] !!! errors, warning, isSuccessful are redundant both in `ExecutionTask` and `ExecutionTask.currentValue`
1929
+ // Also maybe move `ExecutionTask.currentValue.usage` -> `ExecutionTask.usage`
1930
+ // And delete `ExecutionTask.currentValue.preparedPipeline`
1931
+ assertsTaskSuccessful(executionResult);
1932
+ status = 'FINISHED';
1933
+ currentValue = jsonStringsToJsons(executionResult);
1934
+ // <- TODO: [🧠] Is this a good idea to convert JSON strins to JSONs?
1935
+ partialResultSubject.next(executionResult);
1886
1936
  }
1887
1937
  catch (error) {
1938
+ status = 'ERROR';
1939
+ errors.push(error);
1888
1940
  partialResultSubject.error(error);
1889
1941
  }
1890
1942
  }
@@ -1901,12 +1953,33 @@ function createTask(options) {
1901
1953
  return {
1902
1954
  taskType,
1903
1955
  taskId,
1956
+ get status() {
1957
+ return status;
1958
+ // <- Note: [1] Theese must be getters to allow changing the value in the future
1959
+ },
1960
+ get createdAt() {
1961
+ return createdAt;
1962
+ // <- Note: [1]
1963
+ },
1964
+ get updatedAt() {
1965
+ return updatedAt;
1966
+ // <- Note: [1]
1967
+ },
1904
1968
  asPromise,
1905
1969
  asObservable() {
1906
1970
  return partialResultSubject.asObservable();
1907
1971
  },
1972
+ get errors() {
1973
+ return errors;
1974
+ // <- Note: [1]
1975
+ },
1976
+ get warnings() {
1977
+ return warnings;
1978
+ // <- Note: [1]
1979
+ },
1908
1980
  get currentValue() {
1909
- return partialResultSubject.value;
1981
+ return currentValue;
1982
+ // <- Note: [1]
1910
1983
  },
1911
1984
  };
1912
1985
  }
@@ -3673,7 +3746,7 @@ async function executeAttempts(options) {
3673
3746
  Last result:
3674
3747
  ${block($ongoingTaskResult.$resultString === null
3675
3748
  ? 'null'
3676
- : $ongoingTaskResult.$resultString
3749
+ : spaceTrim$1($ongoingTaskResult.$resultString)
3677
3750
  .split('\n')
3678
3751
  .map((line) => `> ${line}`)
3679
3752
  .join('\n'))}