@promptbook/openai 0.71.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.70.0-1';
+    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
@@ -1387,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`
          */
@@ -1682,6 +1760,197 @@
      * TODO: [🧠][🌰] Allow to pass `title` for tracking purposes
      */
 
+    /**
+     * Execution Tools for calling OpenAI API Assistants
+     *
+     * This is usefull for calling OpenAI API with a single assistant, for more wide usage use `OpenAiExecutionTools`.
+     *
+     * @public exported from `@promptbook/openai`
+     */
+    var OpenAiAssistantExecutionTools = /** @class */ (function (_super) {
+        __extends(OpenAiAssistantExecutionTools, _super);
+        /**
+         * Creates OpenAI Execution Tools.
+         *
+         * @param options which are relevant are directly passed to the OpenAI client
+         */
+        function OpenAiAssistantExecutionTools(options) {
+            var _this = _super.call(this, options) || this;
+            _this.assistantId = options.assistantId;
+            return _this;
+        }
+        Object.defineProperty(OpenAiAssistantExecutionTools.prototype, "title", {
+            get: function () {
+                return 'OpenAI Assistant';
+            },
+            enumerable: false,
+            configurable: true
+        });
+        Object.defineProperty(OpenAiAssistantExecutionTools.prototype, "description", {
+            get: function () {
+                return 'Use single assistant provided by OpenAI';
+            },
+            enumerable: false,
+            configurable: true
+        });
+        /**
+         * Calls OpenAI API to use a chat model.
+         */
+        OpenAiAssistantExecutionTools.prototype.callChatModel = function (prompt) {
+            var _a, _b, _c;
+            return __awaiter(this, void 0, void 0, function () {
+                var content, parameters, modelRequirements /*, format*/, client, _d, _e, key, rawPromptContent, rawRequest, start, complete, stream, rawResponse, resultContent, usage;
+                var e_1, _f;
+                var _this = this;
+                return __generator(this, function (_g) {
+                    switch (_g.label) {
+                        case 0:
+                            if (this.options.isVerbose) {
+                                console.info('💬 OpenAI callChatModel call', { prompt: prompt });
+                            }
+                            content = prompt.content, parameters = prompt.parameters, modelRequirements = prompt.modelRequirements;
+                            return [4 /*yield*/, this.getClient()];
+                        case 1:
+                            client = _g.sent();
+                            // TODO: [☂] Use here more modelRequirements
+                            if (modelRequirements.modelVariant !== 'CHAT') {
+                                throw new PipelineExecutionError('Use callChatModel only for CHAT variant');
+                            }
+                            try {
+                                // TODO: [👨‍👨‍👧‍👧] Remove:
+                                for (_d = __values(['maxTokens', 'modelName', 'seed', 'temperature']), _e = _d.next(); !_e.done; _e = _d.next()) {
+                                    key = _e.value;
+                                    if (modelRequirements[key] !== undefined) {
+                                        throw new NotYetImplementedError("In `OpenAiAssistantExecutionTools` you cannot specify `".concat(key, "`"));
+                                    }
+                                }
+                            }
+                            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+                            finally {
+                                try {
+                                    if (_e && !_e.done && (_f = _d.return)) _f.call(_d);
+                                }
+                                finally { if (e_1) throw e_1.error; }
+                            }
+                            rawPromptContent = replaceParameters(content, __assign(__assign({}, parameters), { modelName: 'assistant' }));
+                            rawRequest = {
+                                // [👨‍👨‍👧‍👧] ...modelSettings,
+                                assistant_id: 'asst_CJCZzFCbBL0f2D4OWMXVTdBB',
+                                //             <- Note: This is not a private information, just ID of the assistant which is accessible only with correct API key
+                                thread: {
+                                    messages: [
+                                        // TODO: !!!!!! Unhardcode
+                                        // TODO: !!!!!! Allow threads to be passed
+                                        { role: 'user', content: 'What is the meaning of life? I want breathtaking speech.' },
+                                    ],
+                                },
+                                // !!!!!! user: this.options.user,
+                            };
+                            start = getCurrentIsoDate();
+                            if (this.options.isVerbose) {
+                                console.info(colors__default["default"].bgWhite('rawRequest'), JSON.stringify(rawRequest, null, 4));
+                            }
+                            return [4 /*yield*/, client.beta.threads.createAndRunStream(rawRequest)];
+                        case 2:
+                            stream = _g.sent();
+                            stream.on('connect', function () {
+                                if (_this.options.isVerbose) {
+                                    console.info('connect', stream.currentEvent);
+                                }
+                            });
+                            stream.on('messageDelta', function (messageDelta) {
+                                var _a;
+                                if (_this.options.isVerbose &&
+                                    messageDelta &&
+                                    messageDelta.content &&
+                                    messageDelta.content[0] &&
+                                    messageDelta.content[0].type === 'text') {
+                                    console.info('messageDelta', (_a = messageDelta.content[0].text) === null || _a === void 0 ? void 0 : _a.value);
+                                }
+                                // TODO: !!!!!! report progress
+                            });
+                            stream.on('messageCreated', function (message) {
+                                if (_this.options.isVerbose) {
+                                    console.info('messageCreated', message);
+                                }
+                            });
+                            stream.on('messageDone', function (message) {
+                                if (_this.options.isVerbose) {
+                                    console.info('messageDone', message);
+                                }
+                            });
+                            return [4 /*yield*/, stream.finalMessages()];
+                        case 3:
+                            rawResponse = _g.sent();
+                            if (this.options.isVerbose) {
+                                console.info(colors__default["default"].bgWhite('rawResponse'), JSON.stringify(rawResponse, null, 4));
+                            }
+                            if (rawResponse.length !== 1) {
+                                throw new PipelineExecutionError("There is NOT 1 BUT ".concat(rawResponse.length, " finalMessages from OpenAI"));
+                            }
+                            if (rawResponse[0].content.length !== 1) {
+                                throw new PipelineExecutionError("There is NOT 1 BUT ".concat(rawResponse[0].content.length, " finalMessages content from OpenAI"));
+                            }
+                            if (((_a = rawResponse[0].content[0]) === null || _a === void 0 ? void 0 : _a.type) !== 'text') {
+                                throw new PipelineExecutionError("There is NOT 'text' BUT ".concat((_b = rawResponse[0].content[0]) === null || _b === void 0 ? void 0 : _b.type, " finalMessages content type from OpenAI"));
+                            }
+                            resultContent = (_c = rawResponse[0].content[0]) === null || _c === void 0 ? void 0 : _c.text.value;
+                            //                                                     <- TODO: !!!!!! There are also annotations, maybe use them
+                            // eslint-disable-next-line prefer-const
+                            complete = getCurrentIsoDate();
+                            usage = UNCERTAIN_USAGE;
+                            // TODO: !!!!!!> = computeOpenAiUsage(content, resultContent || '', rawResponse);
+                            if (resultContent === null) {
+                                throw new PipelineExecutionError('No response message from OpenAI');
+                            }
+                            return [2 /*return*/, $asDeeplyFrozenSerializableJson('OpenAiAssistantExecutionTools ChatPromptResult', {
+                                    content: resultContent,
+                                    modelName: 'assistant',
+                                    //          <- TODO: !!!!!! Can we detect really used model: rawResponse.model || modelName,
+                                    timing: {
+                                        start: start,
+                                        complete: complete,
+                                    },
+                                    usage: usage,
+                                    rawPromptContent: rawPromptContent,
+                                    rawRequest: rawRequest,
+                                    rawResponse: rawResponse,
+                                    // <- [🗯]
+                                })];
+                    }
+                });
+            });
+        };
+        return OpenAiAssistantExecutionTools;
+    }(OpenAiExecutionTools));
+    /**
+     * TODO: !!!!!! DO not use colors - can be used in browser
+     * TODO: [🧠][🧙‍♂️] Maybe there can be some wizzard for thoose who want to use just OpenAI
+     * TODO: Maybe make custom OpenAiError
+     * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
+     * 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
      *
@@ -1770,14 +2039,26 @@
      * @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"
      */
 
     exports.OPENAI_MODELS = OPENAI_MODELS;
+    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 });