@promptbook/core 0.75.4 → 0.75.5

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

@@ -34,11 +34,12 @@ import { stringifyPipelineJson } from '../conversion/utils/stringifyPipelineJson
 import { validatePipeline } from '../conversion/validation/validatePipeline';
 import { CallbackInterfaceTools } from '../dialogs/callback/CallbackInterfaceTools';
 import type { CallbackInterfaceToolsOptions } from '../dialogs/callback/CallbackInterfaceToolsOptions';
+import { BoilerplateError } from '../errors/0-BoilerplateError';
+import { ERRORS } from '../errors/0-index';
 import { AbstractFormatError } from '../errors/AbstractFormatError';
 import { CollectionError } from '../errors/CollectionError';
 import { EnvironmentMismatchError } from '../errors/EnvironmentMismatchError';
 import { ExpectError } from '../errors/ExpectError';
-import { ERRORS } from '../errors/index';
 import { KnowledgeScrapeError } from '../errors/KnowledgeScrapeError';
 import { LimitReachedError } from '../errors/LimitReachedError';
 import { MissingToolsError } from '../errors/MissingToolsError';
@@ -147,11 +148,12 @@ export { stringifyPipelineJson };
 export { validatePipeline };
 export { CallbackInterfaceTools };
 export type { CallbackInterfaceToolsOptions };
+export { BoilerplateError };
+export { ERRORS };
 export { AbstractFormatError };
 export { CollectionError };
 export { EnvironmentMismatchError };
 export { ExpectError };
-export { ERRORS };
 export { KnowledgeScrapeError };
 export { LimitReachedError };
 export { MissingToolsError };

package/esm/typings/src/errors/0-BoilerplateError.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This error indicates @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class BoilerplateError extends Error {
+    readonly name = "BoilerplateError";
+    constructor(message: string);
+}
+/**
+ * TODO: @@@ Do not forget to add the error into `0-index.ts` ERRORS
+ */

package/esm/typings/src/errors/{index.d.ts → 0-index.d.ts}

@@ -1,7 +1,11 @@
+import { CsvFormatError } from '../formats/csv/CsvFormatError';
+import { AbstractFormatError } from './AbstractFormatError';
 import { CollectionError } from './CollectionError';
 import { EnvironmentMismatchError } from './EnvironmentMismatchError';
 import { ExpectError } from './ExpectError';
+import { KnowledgeScrapeError } from './KnowledgeScrapeError';
 import { LimitReachedError } from './LimitReachedError';
+import { MissingToolsError } from './MissingToolsError';
 import { NotFoundError } from './NotFoundError';
 import { NotYetImplementedError } from './NotYetImplementedError';
 import { ParseError } from './ParseError';
@@ -15,10 +19,14 @@ import { UnexpectedError } from './UnexpectedError';
  * @public exported from `@promptbook/core`
  */
 export declare const ERRORS: {
-    readonly ExpectError: typeof ExpectError;
+    readonly AbstractFormatError: typeof AbstractFormatError;
+    readonly CsvFormatError: typeof CsvFormatError;
     readonly CollectionError: typeof CollectionError;
     readonly EnvironmentMismatchError: typeof EnvironmentMismatchError;
+    readonly ExpectError: typeof ExpectError;
+    readonly KnowledgeScrapeError: typeof KnowledgeScrapeError;
     readonly LimitReachedError: typeof LimitReachedError;
+    readonly MissingToolsError: typeof MissingToolsError;
     readonly NotFoundError: typeof NotFoundError;
     readonly NotYetImplementedError: typeof NotYetImplementedError;
     readonly ParseError: typeof ParseError;
@@ -29,4 +37,4 @@ export declare const ERRORS: {
 };
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
- */ 
+ */

package/esm/typings/src/errors/utils/ErrorJson.d.ts

@@ -1,4 +1,4 @@
-import type { ERRORS } from '../index';
+import type { ERRORS } from '../0-index';
 /**
  * Represents a serialized error or custom Promptbook error
  *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/core",
-    "version": "0.75.4",
+    "version": "0.75.5",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "--note-0": "    <- [🐊]",
     "private": false,

package/umd/index.umd.js

@@ -24,7 +24,7 @@
      *
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.75.3';
+    var PROMPTBOOK_ENGINE_VERSION = '0.75.4';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -2355,6 +2355,42 @@
 
     var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.book.md",formfactorName:"GENERIC",parameters:[{name:"knowledgeContent",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledgePieces",description:"The knowledge JSON object",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"knowledge",title:"Knowledge",content:"You are experienced data researcher, extract the important knowledge from the document.\n\n# Rules\n\n-   Make pieces of information concise, clear, and easy to understand\n-   One piece of information should be approximately 1 paragraph\n-   Divide the paragraphs by markdown horizontal lines ---\n-   Omit irrelevant information\n-   Group redundant information\n-   Write just extracted information, nothing else\n\n# The document\n\nTake information from this document:\n\n> {knowledgeContent}",resultingParameterName:"knowledgePieces",dependentParameterNames:["knowledgeContent"]}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./books/prepare-knowledge-from-markdown.book.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-keywords.book.md",formfactorName:"GENERIC",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"knowledge",title:"Knowledge",content:"You are experienced data researcher, detect the important keywords in the document.\n\n# Rules\n\n-   Write just keywords separated by comma\n\n# The document\n\nTake information from this document:\n\n> {knowledgePieceContent}",resultingParameterName:"keywords",dependentParameterNames:["knowledgePieceContent"]}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./books/prepare-knowledge-keywords.book.md"},{title:"Prepare Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-title.book.md",formfactorName:"GENERIC",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"title",description:"The title of the document",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"knowledge",title:"Knowledge",content:"You are experienced content creator, write best title for the document.\n\n# Rules\n\n-   Write just title, nothing else\n-   Title should be concise and clear\n-   Write maximum 5 words for the title\n\n# The document\n\n> {knowledgePieceContent}",resultingParameterName:"title",expectations:{words:{min:1,max:8}},dependentParameterNames:["knowledgePieceContent"]}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./books/prepare-knowledge-title.book.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.book.md",formfactorName:"GENERIC",parameters:[{name:"availableModelNames",description:"List of available model names separated by comma (,)",isInput:true,isOutput:false},{name:"personaDescription",description:"Description of the persona",isInput:true,isOutput:false},{name:"modelRequirements",description:"Specific requirements for the model",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"make-model-requirements",title:"Make modelRequirements",content:"You are experienced AI engineer, you need to create virtual assistant.\nWrite\n\n## Example\n\n```json\n{\n\"modelName\": \"gpt-4o\",\n\"systemMessage\": \"You are experienced AI engineer and helpfull assistant.\",\n\"temperature\": 0.7\n}\n```\n\n## Instructions\n\n-   Your output format is JSON object\n-   Write just the JSON object, no other text should be present\n-   It contains the following keys:\n    -   `modelName`: The name of the model to use\n    -   `systemMessage`: The system message to provide context to the model\n    -   `temperature`: The sampling temperature to use\n\n### Key `modelName`\n\nPick from the following models:\n\n-   {availableModelNames}\n\n### Key `systemMessage`\n\nThe system message is used to communicate instructions or provide context to the model at the beginning of a conversation. It is displayed in a different format compared to user messages, helping the model understand its role in the conversation. The system message typically guides the model's behavior, sets the tone, or specifies desired output from the model. By utilizing the system message effectively, users can steer the model towards generating more accurate and relevant responses.\n\nFor example:\n\n> You are an experienced AI engineer and helpful assistant.\n\n> You are a friendly and knowledgeable chatbot.\n\n### Key `temperature`\n\nThe sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.\n\nYou can pick a value between 0 and 2. For example:\n\n-   `0.1`: Low temperature, extremely conservative and deterministic\n-   `0.5`: Medium temperature, balanced between conservative and creative\n-   `1.0`: High temperature, creative and bit random\n-   `1.5`: Very high temperature, extremely creative and often chaotic and unpredictable\n-   `2.0`: Maximum temperature, completely random and unpredictable, for some extreme creative use cases\n\n# The assistant\n\nTake this description of the persona:\n\n> {personaDescription}",resultingParameterName:"modelRequirements",format:"JSON",dependentParameterNames:["availableModelNames","personaDescription"]}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./books/prepare-persona.book.md"}];
 
+    /**
+     * This error indicates problems parsing the format value
+     *
+     * For example, when the format value is not a valid JSON or CSV
+     * This is not thrown directly but in extended classes
+     *
+     * @public exported from `@promptbook/core`
+     */
+    var AbstractFormatError = /** @class */ (function (_super) {
+        __extends(AbstractFormatError, _super);
+        // Note: To allow instanceof do not put here error `name`
+        // public readonly name = 'AbstractFormatError';
+        function AbstractFormatError(message) {
+            var _this = _super.call(this, message) || this;
+            Object.setPrototypeOf(_this, AbstractFormatError.prototype);
+            return _this;
+        }
+        return AbstractFormatError;
+    }(Error));
+
+    /**
+     * This error indicates problem with parsing of CSV
+     *
+     * @public exported from `@promptbook/core`
+     */
+    var CsvFormatError = /** @class */ (function (_super) {
+        __extends(CsvFormatError, _super);
+        function CsvFormatError(message) {
+            var _this = _super.call(this, message) || this;
+            _this.name = 'CsvFormatError';
+            Object.setPrototypeOf(_this, CsvFormatError.prototype);
+            return _this;
+        }
+        return CsvFormatError;
+    }(AbstractFormatError));
+
     /**
      * This error indicates that the pipeline collection cannot be propperly loaded
      *
@@ -2406,6 +2442,22 @@
         return ExpectError;
     }(Error));
 
+    /**
+     * This error indicates that the promptbook can not retrieve knowledge from external sources
+     *
+     * @public exported from `@promptbook/core`
+     */
+    var KnowledgeScrapeError = /** @class */ (function (_super) {
+        __extends(KnowledgeScrapeError, _super);
+        function KnowledgeScrapeError(message) {
+            var _this = _super.call(this, message) || this;
+            _this.name = 'KnowledgeScrapeError';
+            Object.setPrototypeOf(_this, KnowledgeScrapeError.prototype);
+            return _this;
+        }
+        return KnowledgeScrapeError;
+    }(Error));
+
     /**
      * This error type indicates that some limit was reached
      *
@@ -2444,10 +2496,14 @@
      * @public exported from `@promptbook/core`
      */
     var ERRORS = {
-        ExpectError: ExpectError,
+        AbstractFormatError: AbstractFormatError,
+        CsvFormatError: CsvFormatError,
         CollectionError: CollectionError,
         EnvironmentMismatchError: EnvironmentMismatchError,
+        ExpectError: ExpectError,
+        KnowledgeScrapeError: KnowledgeScrapeError,
         LimitReachedError: LimitReachedError,
+        MissingToolsError: MissingToolsError,
         NotFoundError: NotFoundError,
         NotYetImplementedError: NotYetImplementedError,
         ParseError: ParseError,
@@ -2760,42 +2816,6 @@
         return union;
     }
 
-    /**
-     * This error indicates problems parsing the format value
-     *
-     * For example, when the format value is not a valid JSON or CSV
-     * This is not thrown directly but in extended classes
-     *
-     * @public exported from `@promptbook/core`
-     */
-    var AbstractFormatError = /** @class */ (function (_super) {
-        __extends(AbstractFormatError, _super);
-        // Note: To allow instanceof do not put here error `name`
-        // public readonly name = 'AbstractFormatError';
-        function AbstractFormatError(message) {
-            var _this = _super.call(this, message) || this;
-            Object.setPrototypeOf(_this, AbstractFormatError.prototype);
-            return _this;
-        }
-        return AbstractFormatError;
-    }(Error));
-
-    /**
-     * This error indicates problem with parsing of CSV
-     *
-     * @public exported from `@promptbook/core`
-     */
-    var CsvFormatError = /** @class */ (function (_super) {
-        __extends(CsvFormatError, _super);
-        function CsvFormatError(message) {
-            var _this = _super.call(this, message) || this;
-            _this.name = 'CsvFormatError';
-            Object.setPrototypeOf(_this, CsvFormatError.prototype);
-            return _this;
-        }
-        return CsvFormatError;
-    }(AbstractFormatError));
-
     /**
      * @@@
      *
@@ -2836,7 +2856,7 @@
                                 case 0:
                                     csv = papaparse.parse(value, __assign(__assign({}, settings), MANDATORY_CSV_SETTINGS));
                                     if (csv.errors.length !== 0) {
-                                        throw new CsvFormatError(spaceTrim__default["default"](function (block) { return "\n                                CSV parsing error\n\n                                ".concat(block(csv.errors.map(function (error) { return error.message; }).join('\n\n')), "\n                            "); }));
+                                        throw new CsvFormatError(spaceTrim__default["default"](function (block) { return "\n                                CSV parsing error\n\n                                Error(s) from CSV parsing:\n                                ".concat(block(csv.errors.map(function (error) { return error.message; }).join('\n\n')), "\n\n                                The CSV data:\n                                ").concat(block(value), "\n                            "); }));
                                     }
                                     return [4 /*yield*/, Promise.all(csv.data.map(function (row, index) { return __awaiter(_this, void 0, void 0, function () {
                                             var _a, _b;
@@ -2874,7 +2894,7 @@
                                 case 0:
                                     csv = papaparse.parse(value, __assign(__assign({}, settings), MANDATORY_CSV_SETTINGS));
                                     if (csv.errors.length !== 0) {
-                                        throw new CsvFormatError(spaceTrim__default["default"](function (block) { return "\n                                CSV parsing error\n\n                                ".concat(block(csv.errors.map(function (error) { return error.message; }).join('\n\n')), "\n                            "); }));
+                                        throw new CsvFormatError(spaceTrim__default["default"](function (block) { return "\n                                CSV parsing error\n\n                                Error(s) from CSV parsing:\n                                ".concat(block(csv.errors.map(function (error) { return error.message; }).join('\n\n')), "\n\n                                The CSV data:\n                                ").concat(block(value), "\n                            "); }));
                                     }
                                     return [4 /*yield*/, Promise.all(csv.data.map(function (row, rowIndex) { return __awaiter(_this, void 0, void 0, function () {
                                             var _this = this;
@@ -4934,22 +4954,6 @@
      * TODO: [🏢] !! Check validity of `temperature` in pipeline
      */
 
-    /**
-     * This error indicates that the promptbook can not retrieve knowledge from external sources
-     *
-     * @public exported from `@promptbook/core`
-     */
-    var KnowledgeScrapeError = /** @class */ (function (_super) {
-        __extends(KnowledgeScrapeError, _super);
-        function KnowledgeScrapeError(message) {
-            var _this = _super.call(this, message) || this;
-            _this.name = 'KnowledgeScrapeError';
-            Object.setPrototypeOf(_this, KnowledgeScrapeError.prototype);
-            return _this;
-        }
-        return KnowledgeScrapeError;
-    }(Error));
-
     /**
      * @@@
      *
@@ -9133,6 +9137,25 @@
         return CallbackInterfaceTools;
     }());
 
+    /**
+     * This error indicates @@@
+     *
+     * @public exported from `@promptbook/core`
+     */
+    var BoilerplateError = /** @class */ (function (_super) {
+        __extends(BoilerplateError, _super);
+        function BoilerplateError(message) {
+            var _this = _super.call(this, message) || this;
+            _this.name = 'BoilerplateError';
+            Object.setPrototypeOf(_this, BoilerplateError.prototype);
+            return _this;
+        }
+        return BoilerplateError;
+    }(Error));
+    /**
+     * TODO: @@@ Do not forget to add the error into `0-index.ts` ERRORS
+     */
+
     /**
      * Pretty print an embedding vector for logging
      *
@@ -10463,6 +10486,7 @@
     exports.AbstractFormatError = AbstractFormatError;
     exports.BOOK_LANGUAGE_VERSION = BOOK_LANGUAGE_VERSION;
     exports.BlackholeStorage = BlackholeStorage;
+    exports.BoilerplateError = BoilerplateError;
     exports.BoilerplateFormfactorDefinition = BoilerplateFormfactorDefinition;
     exports.CLAIM = CLAIM;
     exports.CallbackInterfaceTools = CallbackInterfaceTools;