@promptbook/openai 0.72.0-2 → 0.72.0-26

package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts

@@ -1,4 +1,4 @@
-import type { string_file_path } from '../../../types/typeAliases';
+import type { string_filename } from '../../../types/typeAliases';
 import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Tests if given string is valid URL.
@@ -6,4 +6,4 @@ import type { really_unknown } from '../../organization/really_unknown';
  * Note: This does not check if the file exists only if the path is valid
  * @public exported from `@promptbook/utils`
  */
-export declare function isValidFilePath(filePath: really_unknown): filePath is string_file_path;
+export declare function isValidFilePath(filename: really_unknown): filename is string_filename;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.72.0-2",
+    "version": "0.72.0-26",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -11,6 +11,7 @@
     "contributors": [
         "Pavol Hejný <me@pavolhejny.com> (https://www.pavolhejny.com/)"
     ],
+    "todo-0": "TODO: [❇️] Make better list of keywords",
     "keywords": [
         "ai",
         "llm",
@@ -51,11 +52,11 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.72.0-2"
+        "@promptbook/core": "0.72.0-26"
     },
     "dependencies": {
         "colors": "1.4.0",
-        "openai": "4.55.9",
-        "spacetrim": "0.11.39"
+        "openai": "4.63.0",
+        "spacetrim": "0.11.59"
     }
 }

package/umd/index.umd.js

@@ -14,8 +14,8 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.72.0-1';
-    // TODO:[main] !!!! List here all the versions and annotate + put into script
+    var PROMPTBOOK_VERSION = '0.72.0-25';
+    // TODO: [main] !!!! List here all the versions and annotate + put into script
 
     /*! *****************************************************************************
     Copyright (c) Microsoft Corporation.
@@ -1286,7 +1286,7 @@
                 prompt: computeUsage("$5.00 / 1M tokens"),
                 output: computeUsage("$15.00 / 1M tokens"),
             },
-            //TODO:[main] !!!!!! Add gpt-4o-mini-2024-07-18 and all others to be up to date
+            //TODO: [main] !!! Add gpt-4o-mini-2024-07-18 and all others to be up to date
         },
         /**/
         /**/
@@ -1316,7 +1316,7 @@
             modelVariant: 'CHAT',
             modelTitle: 'o1-preview-2024-09-12',
             modelName: 'o1-preview-2024-09-12',
-            //             <- TODO:[main] !!!!!! Some better system to organize theese date suffixes and versions
+            //             <- TODO: [main] !!! Some better system to organize theese date suffixes and versions
             pricing: {
                 prompt: computeUsage("$15.00 / 1M tokens"),
                 output: computeUsage("$60.00 / 1M tokens"),
@@ -1421,7 +1421,6 @@
          * @param options which are relevant are directly passed to the OpenAI client
          */
         function OpenAiExecutionTools(options) {
-            if (options === void 0) { options = {}; }
             this.options = options;
             /**
              * OpenAI API client.
@@ -1449,8 +1448,8 @@
                     if (this.client === null) {
                         openAiOptions = __assign({}, this.options);
                         delete openAiOptions.isVerbose;
-                        delete openAiOptions.user;
-                        this.client = new OpenAI__default["default"](__assign({}, openAiOptions));
+                        delete openAiOptions.userId;
+                        this.client = new OpenAI__default["default"](openAiOptions);
                     }
                     return [2 /*return*/, this.client];
                 });
@@ -1497,10 +1496,12 @@
          * Calls OpenAI API to use a chat model.
          */
         OpenAiExecutionTools.prototype.callChatModel = function (prompt) {
+            var _a;
             return __awaiter(this, void 0, void 0, function () {
                 var content, parameters, modelRequirements, format, client, modelName, modelSettings, rawPromptContent, rawRequest, start, complete, rawResponse, resultContent, usage;
-                return __generator(this, function (_a) {
-                    switch (_a.label) {
+                var _this = this;
+                return __generator(this, function (_b) {
+                    switch (_b.label) {
                         case 0:
                             if (this.options.isVerbose) {
                                 console.info('💬 OpenAI callChatModel call', { prompt: prompt });
@@ -1508,7 +1509,7 @@
                             content = prompt.content, parameters = prompt.parameters, modelRequirements = prompt.modelRequirements, format = prompt.format;
                             return [4 /*yield*/, this.getClient()];
                         case 1:
-                            client = _a.sent();
+                            client = _b.sent();
                             // TODO: [☂] Use here more modelRequirements
                             if (modelRequirements.modelVariant !== 'CHAT') {
                                 throw new PipelineExecutionError('Use callChatModel only for CHAT variant');
@@ -1540,14 +1541,19 @@
                                         role: 'user',
                                         content: rawPromptContent,
                                     },
-                                ], false), user: this.options.user });
+                                ], false), user: (_a = this.options.userId) === null || _a === void 0 ? void 0 : _a.toString() });
                             start = getCurrentIsoDate();
                             if (this.options.isVerbose) {
                                 console.info(colors__default["default"].bgWhite('rawRequest'), JSON.stringify(rawRequest, null, 4));
                             }
-                            return [4 /*yield*/, client.chat.completions.create(rawRequest)];
+                            return [4 /*yield*/, client.chat.completions.create(rawRequest).catch(function (error) {
+                                    if (_this.options.isVerbose) {
+                                        console.info(colors__default["default"].bgRed('error'), error);
+                                    }
+                                    throw error;
+                                })];
                         case 2:
-                            rawResponse = _a.sent();
+                            rawResponse = _b.sent();
                             if (this.options.isVerbose) {
                                 console.info(colors__default["default"].bgWhite('rawResponse'), JSON.stringify(rawResponse, null, 4));
                             }
@@ -1586,10 +1592,12 @@
          * Calls OpenAI API to use a complete model.
          */
         OpenAiExecutionTools.prototype.callCompletionModel = function (prompt) {
+            var _a;
             return __awaiter(this, void 0, void 0, function () {
                 var content, parameters, modelRequirements, client, modelName, modelSettings, rawPromptContent, rawRequest, start, complete, rawResponse, resultContent, usage;
-                return __generator(this, function (_a) {
-                    switch (_a.label) {
+                var _this = this;
+                return __generator(this, function (_b) {
+                    switch (_b.label) {
                         case 0:
                             if (this.options.isVerbose) {
                                 console.info('🖋 OpenAI callCompletionModel call', { prompt: prompt });
@@ -1597,7 +1605,7 @@
                             content = prompt.content, parameters = prompt.parameters, modelRequirements = prompt.modelRequirements;
                             return [4 /*yield*/, this.getClient()];
                         case 1:
-                            client = _a.sent();
+                            client = _b.sent();
                             // TODO: [☂] Use here more modelRequirements
                             if (modelRequirements.modelVariant !== 'COMPLETION') {
                                 throw new PipelineExecutionError('Use callCompletionModel only for COMPLETION variant');
@@ -1612,14 +1620,19 @@
                                 // <- Note: [🧆]
                             };
                             rawPromptContent = replaceParameters(content, __assign(__assign({}, parameters), { modelName: modelName }));
-                            rawRequest = __assign(__assign({}, modelSettings), { prompt: rawPromptContent, user: this.options.user });
+                            rawRequest = __assign(__assign({}, modelSettings), { prompt: rawPromptContent, user: (_a = this.options.userId) === null || _a === void 0 ? void 0 : _a.toString() });
                             start = getCurrentIsoDate();
                             if (this.options.isVerbose) {
                                 console.info(colors__default["default"].bgWhite('rawRequest'), JSON.stringify(rawRequest, null, 4));
                             }
-                            return [4 /*yield*/, client.completions.create(rawRequest)];
+                            return [4 /*yield*/, client.completions.create(rawRequest).catch(function (error) {
+                                    if (_this.options.isVerbose) {
+                                        console.info(colors__default["default"].bgRed('error'), error);
+                                    }
+                                    throw error;
+                                })];
                         case 2:
-                            rawResponse = _a.sent();
+                            rawResponse = _b.sent();
                             if (this.options.isVerbose) {
                                 console.info(colors__default["default"].bgWhite('rawResponse'), JSON.stringify(rawResponse, null, 4));
                             }
@@ -1657,6 +1670,7 @@
         OpenAiExecutionTools.prototype.callEmbeddingModel = function (prompt) {
             return __awaiter(this, void 0, void 0, function () {
                 var content, parameters, modelRequirements, client, modelName, rawPromptContent, rawRequest, start, complete, rawResponse, resultContent, usage;
+                var _this = this;
                 return __generator(this, function (_a) {
                     switch (_a.label) {
                         case 0:
@@ -1681,7 +1695,12 @@
                             if (this.options.isVerbose) {
                                 console.info(colors__default["default"].bgWhite('rawRequest'), JSON.stringify(rawRequest, null, 4));
                             }
-                            return [4 /*yield*/, client.embeddings.create(rawRequest)];
+                            return [4 /*yield*/, client.embeddings.create(rawRequest).catch(function (error) {
+                                    if (_this.options.isVerbose) {
+                                        console.info(colors__default["default"].bgRed('error'), error);
+                                    }
+                                    throw error;
+                                })];
                         case 2:
                             rawResponse = _a.sent();
                             if (this.options.isVerbose) {
@@ -1834,14 +1853,13 @@
                             }
                             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
+                                // TODO: [👨‍👨‍👧‍👧] ...modelSettings,
+                                // TODO: [👨‍👨‍👧‍👧][🧠] What about system message for assistants, does it make sence - combination of OpenAI assistants with Promptbook Personas
+                                assistant_id: this.assistantId,
                                 thread: {
                                     messages: [
-                                        // TODO: !!!!!! Unhardcode
-                                        // TODO: !!!!!! Allow threads to be passed
-                                        { role: 'user', content: 'What is the meaning of life? I want breathtaking speech.' },
+                                        // TODO:  [🗯] !!!!!! Allow threads to be passed
+                                        { role: 'user', content: rawPromptContent },
                                     ],
                                 },
                                 // !!!!!! user: this.options.user,
@@ -1867,7 +1885,7 @@
                                     messageDelta.content[0].type === 'text') {
                                     console.info('messageDelta', (_a = messageDelta.content[0].text) === null || _a === void 0 ? void 0 : _a.value);
                                 }
-                                // TODO: !!!!!! report progress
+                                // <- TODO: [🐚] Make streaming and running tasks working
                             });
                             stream.on('messageCreated', function (message) {
                                 if (_this.options.isVerbose) {
@@ -1899,14 +1917,16 @@
                             // eslint-disable-next-line prefer-const
                             complete = getCurrentIsoDate();
                             usage = UNCERTAIN_USAGE;
-                            // TODO: !!!!!!> = computeOpenAiUsage(content, resultContent || '', rawResponse);
+                            // <- TODO: [🥘] Compute real usage for assistant
+                            //       ?> const usage = 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,
+                                    // <- TODO: [🥘] Detect used model in assistant
+                                    //       ?> model: rawResponse.model || modelName,
                                     timing: {
                                         start: start,
                                         complete: complete,
@@ -1924,7 +1944,6 @@
         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
@@ -1982,6 +2001,85 @@
         return Function('return this')();
     }
 
+    /**
+     * @@@
+     *
+     * @param text @@@
+     * @returns @@@
+     * @example 'HELLO_WORLD'
+     * @example 'I_LOVE_PROMPTBOOK'
+     * @public exported from `@promptbook/utils`
+     */
+    function normalizeTo_SCREAMING_CASE(text) {
+        var e_1, _a;
+        var charType;
+        var lastCharType = 'OTHER';
+        var normalizedName = '';
+        try {
+            for (var text_1 = __values(text), text_1_1 = text_1.next(); !text_1_1.done; text_1_1 = text_1.next()) {
+                var char = text_1_1.value;
+                var normalizedChar = void 0;
+                if (/^[a-z]$/.test(char)) {
+                    charType = 'LOWERCASE';
+                    normalizedChar = char.toUpperCase();
+                }
+                else if (/^[A-Z]$/.test(char)) {
+                    charType = 'UPPERCASE';
+                    normalizedChar = char;
+                }
+                else if (/^[0-9]$/.test(char)) {
+                    charType = 'NUMBER';
+                    normalizedChar = char;
+                }
+                else {
+                    charType = 'OTHER';
+                    normalizedChar = '_';
+                }
+                if (charType !== lastCharType &&
+                    !(lastCharType === 'UPPERCASE' && charType === 'LOWERCASE') &&
+                    !(lastCharType === 'NUMBER') &&
+                    !(charType === 'NUMBER')) {
+                    normalizedName += '_';
+                }
+                normalizedName += normalizedChar;
+                lastCharType = charType;
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (text_1_1 && !text_1_1.done && (_a = text_1.return)) _a.call(text_1);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        normalizedName = normalizedName.replace(/_+/g, '_');
+        normalizedName = normalizedName.replace(/_?\/_?/g, '/');
+        normalizedName = normalizedName.replace(/^_/, '');
+        normalizedName = normalizedName.replace(/_$/, '');
+        return normalizedName;
+    }
+    /**
+     * TODO: Tests
+     *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: 'Moje tabule' })).toEqual('/VtG7sR9rRJqwNEdM2/Moje tabule');
+     *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: 'ěščřžžýáíúů' })).toEqual('/VtG7sR9rRJqwNEdM2/escrzyaieuu');
+     *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: '  ahoj  ' })).toEqual('/VtG7sR9rRJqwNEdM2/ahoj');
+     *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: '  ahoj_ahojAhoj    ahoj  ' })).toEqual('/VtG7sR9rRJqwNEdM2/ahoj-ahoj-ahoj-ahoj');
+     * TODO: [🌺] Use some intermediate util splitWords
+     */
+
+    /**
+     * @@@
+     *
+     * @param text @@@
+     * @returns @@@
+     * @example 'hello_world'
+     * @example 'i_love_promptbook'
+     * @public exported from `@promptbook/utils`
+     */
+    function normalizeTo_snake_case(text) {
+        return normalizeTo_SCREAMING_CASE(text).toLowerCase();
+    }
+
     /**
      * Register is @@@
      *
@@ -1990,9 +2088,9 @@
      * @private internal utility, exported are only signleton instances of this class
      */
     var $Register = /** @class */ (function () {
-        function $Register(storageName) {
-            this.storageName = storageName;
-            storageName = "_promptbook_".concat(storageName);
+        function $Register(registerName) {
+            this.registerName = registerName;
+            var storageName = "_promptbook_".concat(normalizeTo_snake_case(registerName));
             var globalScope = $getGlobalScope();
             if (globalScope[storageName] === undefined) {
                 globalScope[storageName] = [];
@@ -2003,11 +2101,10 @@
             this.storage = globalScope[storageName];
         }
         $Register.prototype.list = function () {
-            // <- TODO: ReadonlyDeep<Array<TRegistered>>
+            // <- TODO: ReadonlyDeep<ReadonlyArray<TRegistered>>
             return this.storage;
         };
         $Register.prototype.register = function (registered) {
-            //                                    <- TODO: What to return here
             var packageName = registered.packageName, className = registered.className;
             var existingRegistrationIndex = this.storage.findIndex(function (item) { return item.packageName === packageName && item.className === className; });
             var existingRegistration = this.storage[existingRegistrationIndex];
@@ -2017,6 +2114,17 @@
             else {
                 this.storage[existingRegistrationIndex] = registered;
             }
+            return {
+                registerName: this.registerName,
+                packageName: packageName,
+                className: className,
+                get isDestroyed() {
+                    return false;
+                },
+                destroy: function () {
+                    throw new NotYetImplementedError("Registration to ".concat(this.registerName, " is permanent in this version of Promptbook"));
+                },
+            };
         };
         return $Register;
     }());
@@ -2029,11 +2137,14 @@
      * @public exported from `@promptbook/core`
      */
     var $llmToolsRegister = new $Register('llm_execution_tools_constructors');
+    /**
+     * TODO: [®] DRY Register logic
+     */
 
     /**
-     * @@@ registration2
+     * Registration of LLM provider
      *
-     * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
+     * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
      *
      * @public exported from `@promptbook/openai`
      * @public exported from `@promptbook/cli`