@promptbook/openai 0.72.0-0 → 0.72.0-1

package/umd/index.umd.js

@@ -1,20 +1,20 @@
 (function (global, factory) {
-    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('colors'), require('openai'), require('spacetrim')) :
-    typeof define === 'function' && define.amd ? define(['exports', 'colors', 'openai', 'spacetrim'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-openai"] = {}, global.colors, global.OpenAI, global.spaceTrim));
-})(this, (function (exports, colors, OpenAI, spaceTrim) { 'use strict';
+    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('colors'), require('spacetrim'), require('openai')) :
+    typeof define === 'function' && define.amd ? define(['exports', 'colors', 'spacetrim', 'openai'], factory) :
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-openai"] = {}, global.colors, global.spaceTrim, global.OpenAI));
+})(this, (function (exports, colors, spaceTrim, OpenAI) { 'use strict';
 
     function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
     var colors__default = /*#__PURE__*/_interopDefaultLegacy(colors);
-    var OpenAI__default = /*#__PURE__*/_interopDefaultLegacy(OpenAI);
     var spaceTrim__default = /*#__PURE__*/_interopDefaultLegacy(spaceTrim);
+    var OpenAI__default = /*#__PURE__*/_interopDefaultLegacy(OpenAI);
 
     // ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.68.5';
+    var PROMPTBOOK_VERSION = '0.72.0-0';
     // TODO:[main] !!!! List here all the versions and annotate + put into script
 
     /*! *****************************************************************************
@@ -155,46 +155,37 @@
     var $isRunningInWebWorker = new Function("\n    try {\n        if (typeof WorkerGlobalScope !== 'undefined' && self instanceof WorkerGlobalScope) {\n            return true;\n        } else {\n            return false;\n        }\n    } catch (e) {\n        return false;\n    }\n");
 
     /**
-     * This error indicates errors during the execution of the pipeline
+     * This error type indicates that some part of the code is not implemented yet
      *
      * @public exported from `@promptbook/core`
      */
-    var PipelineExecutionError = /** @class */ (function (_super) {
-        __extends(PipelineExecutionError, _super);
-        function PipelineExecutionError(message) {
-            var _this = _super.call(this, message) || this;
-            _this.name = 'PipelineExecutionError';
-            Object.setPrototypeOf(_this, PipelineExecutionError.prototype);
+    var NotYetImplementedError = /** @class */ (function (_super) {
+        __extends(NotYetImplementedError, _super);
+        function NotYetImplementedError(message) {
+            var _this = _super.call(this, spaceTrim.spaceTrim(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: This feature is not implemented yet but it will be soon.\n\n                    If you want speed up the implementation or just read more, look here:\n                    https://github.com/webgptorg/promptbook\n\n                    Or contact us on me@pavolhejny.com\n\n                "); })) || this;
+            _this.name = 'NotYetImplementedError';
+            Object.setPrototypeOf(_this, NotYetImplementedError.prototype);
             return _this;
         }
-        return PipelineExecutionError;
+        return NotYetImplementedError;
     }(Error));
 
     /**
-     * This error type indicates that the error should not happen and its last check before crashing with some other error
+     * This error indicates errors during the execution of the pipeline
      *
      * @public exported from `@promptbook/core`
      */
-    var UnexpectedError = /** @class */ (function (_super) {
-        __extends(UnexpectedError, _super);
-        function UnexpectedError(message) {
-            var _this = _super.call(this, spaceTrim.spaceTrim(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: This error should not happen.\n                    It's probbably a bug in the pipeline collection\n\n                    Please report issue:\n                    https://github.com/webgptorg/promptbook/issues\n\n                    Or contact us on me@pavolhejny.com\n\n                "); })) || this;
-            _this.name = 'UnexpectedError';
-            Object.setPrototypeOf(_this, UnexpectedError.prototype);
+    var PipelineExecutionError = /** @class */ (function (_super) {
+        __extends(PipelineExecutionError, _super);
+        function PipelineExecutionError(message) {
+            var _this = _super.call(this, message) || this;
+            _this.name = 'PipelineExecutionError';
+            Object.setPrototypeOf(_this, PipelineExecutionError.prototype);
             return _this;
         }
-        return UnexpectedError;
+        return PipelineExecutionError;
     }(Error));
 
-    /**
-     * Get current date in ISO 8601 format
-     *
-     * @private internal utility
-     */
-    function getCurrentIsoDate() {
-        return new Date().toISOString();
-    }
-
     /**
      * @@@
      *
@@ -229,6 +220,84 @@
      * TODO: [🧠] Is there a way how to meaningfully test this utility
      */
 
+    /**
+     * Represents the usage with no resources consumed
+     *
+     * @public exported from `@promptbook/core`
+     */
+    $deepFreeze({
+        price: { value: 0 },
+        input: {
+            tokensCount: { value: 0 },
+            charactersCount: { value: 0 },
+            wordsCount: { value: 0 },
+            sentencesCount: { value: 0 },
+            linesCount: { value: 0 },
+            paragraphsCount: { value: 0 },
+            pagesCount: { value: 0 },
+        },
+        output: {
+            tokensCount: { value: 0 },
+            charactersCount: { value: 0 },
+            wordsCount: { value: 0 },
+            sentencesCount: { value: 0 },
+            linesCount: { value: 0 },
+            paragraphsCount: { value: 0 },
+            pagesCount: { value: 0 },
+        },
+    });
+    /**
+     * Represents the usage with unknown resources consumed
+     *
+     * @public exported from `@promptbook/core`
+     */
+    var UNCERTAIN_USAGE = $deepFreeze({
+        price: { value: 0, isUncertain: true },
+        input: {
+            tokensCount: { value: 0, isUncertain: true },
+            charactersCount: { value: 0, isUncertain: true },
+            wordsCount: { value: 0, isUncertain: true },
+            sentencesCount: { value: 0, isUncertain: true },
+            linesCount: { value: 0, isUncertain: true },
+            paragraphsCount: { value: 0, isUncertain: true },
+            pagesCount: { value: 0, isUncertain: true },
+        },
+        output: {
+            tokensCount: { value: 0, isUncertain: true },
+            charactersCount: { value: 0, isUncertain: true },
+            wordsCount: { value: 0, isUncertain: true },
+            sentencesCount: { value: 0, isUncertain: true },
+            linesCount: { value: 0, isUncertain: true },
+            paragraphsCount: { value: 0, isUncertain: true },
+            pagesCount: { value: 0, isUncertain: true },
+        },
+    });
+
+    /**
+     * Get current date in ISO 8601 format
+     *
+     * @private internal utility
+     */
+    function getCurrentIsoDate() {
+        return new Date().toISOString();
+    }
+
+    /**
+     * This error type indicates that the error should not happen and its last check before crashing with some other error
+     *
+     * @public exported from `@promptbook/core`
+     */
+    var UnexpectedError = /** @class */ (function (_super) {
+        __extends(UnexpectedError, _super);
+        function UnexpectedError(message) {
+            var _this = _super.call(this, spaceTrim.spaceTrim(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: This error should not happen.\n                    It's probbably a bug in the pipeline collection\n\n                    Please report issue:\n                    https://github.com/webgptorg/promptbook/issues\n\n                    Or contact us on me@pavolhejny.com\n\n                "); })) || this;
+            _this.name = 'UnexpectedError';
+            Object.setPrototypeOf(_this, UnexpectedError.prototype);
+            return _this;
+        }
+        return UnexpectedError;
+    }(Error));
+
     /**
      * Checks if the value is [🚉] serializable as JSON
      * If not, throws an UnexpectedError with a rich error message and tracking
@@ -397,6 +466,7 @@
         'samples',
         'modelName',
         'currentDate',
+        // <- TODO: !!!!! list here all command names
         // <- TODO: Add more like 'date', 'modelName',...
         // <- TODO: Add [emoji] + instructions ACRY when adding new reserved parameter
     ]);
@@ -412,6 +482,18 @@
      * @private within the repository
      */
     var RESERVED_PARAMETER_RESTRICTED = 'RESTRICTED-' + REPLACING_NONCE;
+    // <- TODO: [🧜‍♂️]
+    /**
+     * @@@
+     *
+     * @public exported from `@promptbook/core`
+     */
+    Object.freeze({
+        delimiter: ',',
+        quoteChar: '"',
+        newline: '\n',
+        skipEmptyLines: true,
+    });
     /**
      * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
      */
@@ -1374,6 +1456,15 @@
                 });
             });
         };
+        /**
+         * Create (sub)tools for calling OpenAI API Assistants
+         *
+         * @param assistantId Which assistant to use
+         * @returns Tools for calling OpenAI API Assistants with same token
+         */
+        OpenAiExecutionTools.prototype.createAssistantSubtools = function (assistantId) {
+            return new OpenAiAssistantExecutionTools(__assign(__assign({}, this.options), { assistantId: assistantId }));
+        };
         /**
          * Check the `options` passed to `constructor`
          */
@@ -1470,7 +1561,7 @@
                             resultContent = rawResponse.choices[0].message.content;
                             // eslint-disable-next-line prefer-const
                             complete = getCurrentIsoDate();
-                            usage = computeOpenAiUsage(content, resultContent || '', rawResponse);
+                            usage = computeOpenAiUsage(content || '', resultContent || '', rawResponse);
                             if (resultContent === null) {
                                 throw new PipelineExecutionError('No response message from OpenAI');
                             }
@@ -1542,7 +1633,7 @@
                             resultContent = rawResponse.choices[0].text;
                             // eslint-disable-next-line prefer-const
                             complete = getCurrentIsoDate();
-                            usage = computeOpenAiUsage(content, resultContent || '', rawResponse);
+                            usage = computeOpenAiUsage(content || '', resultContent || '', rawResponse);
                             return [2 /*return*/, $asDeeplyFrozenSerializableJson('OpenAiExecutionTools CompletionPromptResult', {
                                     content: resultContent,
                                     modelName: rawResponse.model || modelName,
@@ -1602,7 +1693,9 @@
                             resultContent = rawResponse.data[0].embedding;
                             // eslint-disable-next-line prefer-const
                             complete = getCurrentIsoDate();
-                            usage = computeOpenAiUsage(content, '', rawResponse);
+                            usage = computeOpenAiUsage(content || '', '', 
+                            // <- Note: Embedding does not have result content
+                            rawResponse);
                             return [2 /*return*/, $asDeeplyFrozenSerializableJson('OpenAiExecutionTools EmbeddingPromptResult', {
                                     content: resultContent,
                                     modelName: rawResponse.model || modelName,
@@ -1667,95 +1760,6 @@
      * TODO: [🧠][🌰] Allow to pass `title` for tracking purposes
      */
 
-    /**
-     * Execution Tools for calling OpenAI API
-     *
-     * @public exported from `@promptbook/openai`
-     */
-    var createOpenAiExecutionTools = Object.assign(function (options) {
-        // TODO: [🧠][main] !!!! If browser, auto add `dangerouslyAllowBrowser`
-        if (($isRunningInBrowser() || $isRunningInWebWorker()) && !options.dangerouslyAllowBrowser) {
-            options = __assign(__assign({}, options), { dangerouslyAllowBrowser: true });
-        }
-        return new OpenAiExecutionTools(options);
-    }, {
-        packageName: '@promptbook/openai',
-        className: 'OpenAiExecutionTools',
-    });
-    /**
-     * TODO: [🦺] Is there some way how to put `packageName` and `className` on top and function definition on bottom?
-     * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
-     */
-
-    /**
-     * This error type indicates that some part of the code is not implemented yet
-     *
-     * @public exported from `@promptbook/core`
-     */
-    var NotYetImplementedError = /** @class */ (function (_super) {
-        __extends(NotYetImplementedError, _super);
-        function NotYetImplementedError(message) {
-            var _this = _super.call(this, spaceTrim.spaceTrim(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: This feature is not implemented yet but it will be soon.\n\n                    If you want speed up the implementation or just read more, look here:\n                    https://github.com/webgptorg/promptbook\n\n                    Or contact us on me@pavolhejny.com\n\n                "); })) || this;
-            _this.name = 'NotYetImplementedError';
-            Object.setPrototypeOf(_this, NotYetImplementedError.prototype);
-            return _this;
-        }
-        return NotYetImplementedError;
-    }(Error));
-
-    /**
-     * Represents the usage with no resources consumed
-     *
-     * @public exported from `@promptbook/core`
-     */
-    $deepFreeze({
-        price: { value: 0 },
-        input: {
-            tokensCount: { value: 0 },
-            charactersCount: { value: 0 },
-            wordsCount: { value: 0 },
-            sentencesCount: { value: 0 },
-            linesCount: { value: 0 },
-            paragraphsCount: { value: 0 },
-            pagesCount: { value: 0 },
-        },
-        output: {
-            tokensCount: { value: 0 },
-            charactersCount: { value: 0 },
-            wordsCount: { value: 0 },
-            sentencesCount: { value: 0 },
-            linesCount: { value: 0 },
-            paragraphsCount: { value: 0 },
-            pagesCount: { value: 0 },
-        },
-    });
-    /**
-     * Represents the usage with unknown resources consumed
-     *
-     * @public exported from `@promptbook/core`
-     */
-    var UNCERTAIN_USAGE = $deepFreeze({
-        price: { value: 0, isUncertain: true },
-        input: {
-            tokensCount: { value: 0, isUncertain: true },
-            charactersCount: { value: 0, isUncertain: true },
-            wordsCount: { value: 0, isUncertain: true },
-            sentencesCount: { value: 0, isUncertain: true },
-            linesCount: { value: 0, isUncertain: true },
-            paragraphsCount: { value: 0, isUncertain: true },
-            pagesCount: { value: 0, isUncertain: true },
-        },
-        output: {
-            tokensCount: { value: 0, isUncertain: true },
-            charactersCount: { value: 0, isUncertain: true },
-            wordsCount: { value: 0, isUncertain: true },
-            sentencesCount: { value: 0, isUncertain: true },
-            linesCount: { value: 0, isUncertain: true },
-            paragraphsCount: { value: 0, isUncertain: true },
-            pagesCount: { value: 0, isUncertain: true },
-        },
-    });
-
     /**
      * Execution Tools for calling OpenAI API Assistants
      *
@@ -1771,8 +1775,9 @@
          * @param options which are relevant are directly passed to the OpenAI client
          */
         function OpenAiAssistantExecutionTools(options) {
-            if (options === void 0) { options = {}; }
-            return _super.call(this, options) || this;
+            var _this = _super.call(this, options) || this;
+            _this.assistantId = options.assistantId;
+            return _this;
         }
         Object.defineProperty(OpenAiAssistantExecutionTools.prototype, "title", {
             get: function () {
@@ -1926,6 +1931,46 @@
      * TODO: [🧠][🌰] Allow to pass `title` for tracking purposes
      */
 
+    /**
+     * Execution Tools for calling OpenAI API
+     *
+     * @public exported from `@promptbook/openai`
+     */
+    var createOpenAiAssistantExecutionTools = Object.assign(function (options) {
+        // TODO: [🧠][main] !!!! If browser, auto add `dangerouslyAllowBrowser`
+        if (($isRunningInBrowser() || $isRunningInWebWorker()) && !options.dangerouslyAllowBrowser) {
+            options = __assign(__assign({}, options), { dangerouslyAllowBrowser: true });
+        }
+        return new OpenAiAssistantExecutionTools(options);
+    }, {
+        packageName: '@promptbook/openai',
+        className: 'OpenAiAssistantExecutionTools',
+    });
+    /**
+     * TODO: [🦺] Is there some way how to put `packageName` and `className` on top and function definition on bottom?
+     * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+     */
+
+    /**
+     * Execution Tools for calling OpenAI API
+     *
+     * @public exported from `@promptbook/openai`
+     */
+    var createOpenAiExecutionTools = Object.assign(function (options) {
+        // TODO: [🧠][main] !!!! If browser, auto add `dangerouslyAllowBrowser`
+        if (($isRunningInBrowser() || $isRunningInWebWorker()) && !options.dangerouslyAllowBrowser) {
+            options = __assign(__assign({}, options), { dangerouslyAllowBrowser: true });
+        }
+        return new OpenAiExecutionTools(options);
+    }, {
+        packageName: '@promptbook/openai',
+        className: 'OpenAiExecutionTools',
+    });
+    /**
+     * TODO: [🦺] Is there some way how to put `packageName` and `className` on top and function definition on bottom?
+     * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+     */
+
     /**
      * @@@
      *
@@ -1994,6 +2039,15 @@
      * @public exported from `@promptbook/cli`
      */
     var _OpenAiRegistration = $llmToolsRegister.register(createOpenAiExecutionTools);
+    /**
+     * @@@ registration2
+     *
+     * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
+     *
+     * @public exported from `@promptbook/openai`
+     * @public exported from `@promptbook/cli`
+     */
+    var _OpenAiAssistantRegistration = $llmToolsRegister.register(createOpenAiAssistantExecutionTools);
     /**
      * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
      */
@@ -2002,7 +2056,9 @@
     exports.OpenAiAssistantExecutionTools = OpenAiAssistantExecutionTools;
     exports.OpenAiExecutionTools = OpenAiExecutionTools;
     exports.PROMPTBOOK_VERSION = PROMPTBOOK_VERSION;
+    exports._OpenAiAssistantRegistration = _OpenAiAssistantRegistration;
     exports._OpenAiRegistration = _OpenAiRegistration;
+    exports.createOpenAiAssistantExecutionTools = createOpenAiAssistantExecutionTools;
     exports.createOpenAiExecutionTools = createOpenAiExecutionTools;
 
     Object.defineProperty(exports, '__esModule', { value: true });