@promptbook/openai 0.88.0-1 → 0.88.0-9

package/README.md

@@ -261,8 +261,6 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
 
 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**!
 
-
-
 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!
 
 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.
@@ -325,21 +323,16 @@ We also have a community of developers and users of **Promptbook**:
 -   [Landing page `ptbk.io`](https://ptbk.io)
 -   [Github discussions](https://github.com/webgptorg/promptbook/discussions)
 -   [LinkedIn `Promptbook`](https://linkedin.com/company/promptbook)
--   [Facebook `Promptbook`](https://www.facebook.com/61560776453536) 
+-   [Facebook `Promptbook`](https://www.facebook.com/61560776453536)
 
 And **Promptbook.studio** branded socials:
 
-
-
 -   [Instagram `@promptbook.studio`](https://www.instagram.com/promptbook.studio/)
 
 And **Promptujeme** sub-brand:
 
 _/Subbrand for Czech clients/_
 
-
-
-
 -   [Promptujeme.cz](https://www.promptujeme.cz/)
 -   [Facebook `Promptujeme`](https://www.facebook.com/promptujeme/)
 
@@ -357,8 +350,6 @@ _/Sub-brand for images and graphics generated via Promptbook prompting/_
 
 ## 💙 The Book language
 
-
-
 Following is the documentation and blueprint of the [Book language](https://github.com/webgptorg/book).
 
 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.
@@ -408,8 +399,6 @@ Personas can have access to different knowledge, tools and actions. They can als
 
 -   [PERSONA](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PERSONA.md)
 
-
-
 ### **How:** Knowledge, Instruments and Actions
 
 The resources used by the personas are used to do the work.
@@ -485,11 +474,6 @@ Or you can install them separately:
 
 ## 📚 Dictionary
 
-
-
-
-
-
 ### 📚 Dictionary
 
 The following glossary is used to clarify certain concepts:
@@ -505,12 +489,8 @@ The following glossary is used to clarify certain concepts:
 -   **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.
 -   **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.
 
-
-
 _Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
 
-
-
 #### 💯 Core concepts
 
 -   [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
@@ -539,8 +519,6 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
 -   [👮 Agent adversary expectations](https://github.com/webgptorg/promptbook/discussions/39)
 -   [view more](https://github.com/webgptorg/promptbook/discussions/categories/concepts)
 
-
-
 ### Terms specific to Promptbook TypeScript implementation
 
 -   Anonymous mode
@@ -548,10 +526,9 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
 
 
 
-## 🔌 Usage in Typescript / Javascript
+## 🚂 Promptbook Engine
 
--   [Simple usage](./examples/usage/simple-script)
--   [Usage with client and remote server](./examples/usage/remote)
+![Schema of Promptbook Engine](./documents/promptbook-engine.svg)
 
 ## ➕➖ When to use Promptbook?
 

package/esm/index.es.js

@@ -16,7 +16,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.88.0-1';
+const PROMPTBOOK_ENGINE_VERSION = '0.88.0-9';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/_packages/types.index.d.ts

@@ -40,6 +40,7 @@ import type { ExecutionReportString } from '../execution/execution-report/Execut
 import type { ExecutionReportStringOptions } from '../execution/execution-report/ExecutionReportStringOptions';
 import type { ExecutionTask } from '../execution/ExecutionTask';
 import type { PreparationTask } from '../execution/ExecutionTask';
+import type { task_status } from '../execution/ExecutionTask';
 import type { AbstractTask } from '../execution/ExecutionTask';
 import type { Task } from '../execution/ExecutionTask';
 import type { ExecutionTools } from '../execution/ExecutionTools';
@@ -322,6 +323,7 @@ export type { ExecutionReportString };
 export type { ExecutionReportStringOptions };
 export type { ExecutionTask };
 export type { PreparationTask };
+export type { task_status };
 export type { AbstractTask };
 export type { Task };
 export type { ExecutionTools };

package/esm/typings/src/_packages/utils.index.d.ts

@@ -62,6 +62,7 @@ import { clonePipeline } from '../utils/serialization/clonePipeline';
 import { deepClone } from '../utils/serialization/deepClone';
 import { exportJson } from '../utils/serialization/exportJson';
 import { isSerializableAsJson } from '../utils/serialization/isSerializableAsJson';
+import { jsonStringsToJsons } from '../utils/serialization/jsonStringsToJsons';
 import { difference } from '../utils/sets/difference';
 import { intersection } from '../utils/sets/intersection';
 import { union } from '../utils/sets/union';
@@ -143,6 +144,7 @@ export { clonePipeline };
 export { deepClone };
 export { exportJson };
 export { isSerializableAsJson };
+export { jsonStringsToJsons };
 export { difference };
 export { intersection };
 export { union };

package/esm/typings/src/cli/cli-commands/common/handleActionErrors.d.ts

@@ -0,0 +1,11 @@
+import type { Command as Program } from 'commander';
+type actionCallbackFunction = Parameters<Program['action']>[0];
+/**
+ * Wraps action to handle error console logging and exit process with error code
+ *
+ * @param action Action to be wrapped in error handling
+ * @returns Wrapped action
+ * @private internal helper function for CLI commands
+ */
+export declare function handleActionErrors(action: actionCallbackFunction): actionCallbackFunction;
+export {};

package/esm/typings/src/execution/ExecutionTask.d.ts

@@ -40,6 +40,10 @@ export type PreparationTask = AbstractTask<PipelineExecutorResult> & {
     readonly taskType: 'PREPARATION';
     readonly taskId: `prep-${task_id}`;
 };
+/**
+ * Status of a task
+ */
+export type task_status = 'RUNNING' | 'FINISHED' | 'ERROR';
 /**
  * Base interface for all task types
  */
@@ -52,6 +56,18 @@ export type AbstractTask<TTaskResult extends AbstractTaskResult> = {
      * Unique identifier for the task
      */
     readonly taskId: task_id;
+    /**
+     * Status of the task
+     */
+    readonly status: task_status;
+    /**
+     * Date when the task was created
+     */
+    readonly createdAt: Date;
+    /**
+     * Date when the task was last updated
+     */
+    readonly updatedAt: Date;
     /**
      * Gets a promise that resolves with the task result
      */
@@ -66,6 +82,14 @@ export type AbstractTask<TTaskResult extends AbstractTaskResult> = {
      * Gets just the current value which is mutated during the task processing
      */
     currentValue: PartialDeep<TTaskResult>;
+    /**
+     * List of errors that occurred during the task processing
+     */
+    readonly errors: Array<Error>;
+    /**
+     * List of warnings that occurred during the task processing
+     */
+    readonly warnings: Array<Error>;
 };
 export type Task = ExecutionTask | PreparationTask;
 export {};

package/esm/typings/src/utils/serialization/jsonStringsToJsons.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Recursively converts JSON strings to JSON objects
+
+ * @public exported from `@promptbook/utils`
+ */
+export declare function jsonStringsToJsons<T>(object: T): T;
+/**
+ * TODO: Type the return type correctly
+ */

package/esm/typings/src/utils/serialization/jsonStringsToJsons.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.88.0-1",
+    "version": "0.88.0-9",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -47,7 +47,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.88.0-1"
+        "@promptbook/core": "0.88.0-9"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -24,7 +24,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.88.0-1';
+    const PROMPTBOOK_ENGINE_VERSION = '0.88.0-9';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name