@promptbook/azure-openai 0.69.0 → 0.69.2

package/README.md

@@ -2,7 +2,7 @@
 
 # ![Promptbook logo - cube with letters P and B](./other/design/logo-h1.png) Promptbook
 
-Supercharge your use of large language models
+Build responsible, controlled and transparent applications on top of LLM models!
 
 
 

package/esm/index.es.js

@@ -6,7 +6,7 @@ import spaceTrim$1, { spaceTrim } from 'spacetrim';
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.69.0-21';
+var PROMPTBOOK_VERSION = '0.69.1';
 // TODO: [main] !!!! List here all the versions and annotate + put into script
 
 /*! *****************************************************************************
@@ -129,20 +129,38 @@ function __spreadArray(to, from, pack) {
 }
 
 /**
- * This error indicates errors during the execution of the pipeline
+ * @@@
  *
- * @public exported from `@promptbook/core`
+ * Note: `$` is used to indicate that this function is not a pure function - it mutates given object
+ * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
+ *
+ * @returns The same object as the input, but deeply frozen
+ * @public exported from `@promptbook/utils`
  */
-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;
+function $deepFreeze(objectValue) {
+    var e_1, _a;
+    var propertyNames = Object.getOwnPropertyNames(objectValue);
+    try {
+        for (var propertyNames_1 = __values(propertyNames), propertyNames_1_1 = propertyNames_1.next(); !propertyNames_1_1.done; propertyNames_1_1 = propertyNames_1.next()) {
+            var propertyName = propertyNames_1_1.value;
+            var value = objectValue[propertyName];
+            if (value && typeof value === 'object') {
+                $deepFreeze(value);
+            }
+        }
     }
-    return PipelineExecutionError;
-}(Error));
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (propertyNames_1_1 && !propertyNames_1_1.done && (_a = propertyNames_1.return)) _a.call(propertyNames_1);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
+    return Object.freeze(objectValue);
+}
+/**
+ * TODO: [🧠] Is there a way how to meaningfully test this utility
+ */
 
 /**
  * This error type indicates that the error should not happen and its last check before crashing with some other error
@@ -160,6 +178,228 @@ var UnexpectedError = /** @class */ (function (_super) {
     return UnexpectedError;
 }(Error));
 
+/**
+ * Checks if the value is [🚉] serializable as JSON
+ * If not, throws an UnexpectedError with a rich error message and tracking
+ *
+ * - Almost all primitives are serializable BUT:
+ * - `undefined` is not serializable
+ * - `NaN` is not serializable
+ * - Objects and arrays are serializable if all their properties are serializable
+ * - Functions are not serializable
+ * - Circular references are not serializable
+ * - `Date` objects are not serializable
+ * - `Map` and `Set` objects are not serializable
+ * - `RegExp` objects are not serializable
+ * - `Error` objects are not serializable
+ * - `Symbol` objects are not serializable
+ * - And much more...
+ *
+ * @throws UnexpectedError if the value is not serializable as JSON
+ * @public exported from `@promptbook/utils`
+ */
+function checkSerializableAsJson(name, value) {
+    var e_1, _a;
+    if (value === undefined) {
+        throw new UnexpectedError("".concat(name, " is undefined"));
+    }
+    else if (value === null) {
+        return;
+    }
+    else if (typeof value === 'boolean') {
+        return;
+    }
+    else if (typeof value === 'number' && !isNaN(value)) {
+        return;
+    }
+    else if (typeof value === 'string') {
+        return;
+    }
+    else if (typeof value === 'symbol') {
+        throw new UnexpectedError("".concat(name, " is symbol"));
+    }
+    else if (typeof value === 'function') {
+        throw new UnexpectedError("".concat(name, " is function"));
+    }
+    else if (typeof value === 'object' && Array.isArray(value)) {
+        for (var i = 0; i < value.length; i++) {
+            checkSerializableAsJson("".concat(name, "[").concat(i, "]"), value[i]);
+        }
+    }
+    else if (typeof value === 'object') {
+        if (value instanceof Date) {
+            throw new UnexpectedError(spaceTrim$1("\n                    ".concat(name, " is Date\n\n                    Use `string_date_iso8601` instead\n                ")));
+        }
+        else if (value instanceof Map) {
+            throw new UnexpectedError("".concat(name, " is Map"));
+        }
+        else if (value instanceof Set) {
+            throw new UnexpectedError("".concat(name, " is Set"));
+        }
+        else if (value instanceof RegExp) {
+            throw new UnexpectedError("".concat(name, " is RegExp"));
+        }
+        else if (value instanceof Error) {
+            throw new UnexpectedError(spaceTrim$1("\n                    ".concat(name, " is unserialized Error\n\n                    Use function `serializeError`\n                ")));
+        }
+        else {
+            try {
+                for (var _b = __values(Object.entries(value)), _c = _b.next(); !_c.done; _c = _b.next()) {
+                    var _d = __read(_c.value, 2), subName = _d[0], subValue = _d[1];
+                    if (subValue === undefined) {
+                        // Note: undefined in object is serializable - it is just omited
+                        continue;
+                    }
+                    checkSerializableAsJson("".concat(name, ".").concat(subName), subValue);
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+            try {
+                JSON.stringify(value); // <- TODO: [0]
+            }
+            catch (error) {
+                if (!(error instanceof Error)) {
+                    throw error;
+                }
+                throw new UnexpectedError(spaceTrim$1(function (block) { return "\n                            ".concat(name, " is not serializable\n\n                            ").concat(block(error.toString()), "\n                        "); }));
+            }
+            /*
+            TODO: [0] Is there some more elegant way to check circular references?
+            const seen = new Set();
+            const stack = [{ value }];
+            while (stack.length > 0) {
+                const { value } = stack.pop()!;
+                if (typeof value === 'object' && value !== null) {
+                    if (seen.has(value)) {
+                        throw new UnexpectedError(`${name} has circular reference`);
+                    }
+                    seen.add(value);
+                    if (Array.isArray(value)) {
+                        stack.push(...value.map((value) => ({ value })));
+                    } else {
+                        stack.push(...Object.values(value).map((value) => ({ value })));
+                    }
+                }
+            }
+            */
+            return;
+        }
+    }
+    else {
+        throw new UnexpectedError("".concat(name, " is unknown"));
+    }
+}
+/**
+ * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
+ * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
+ * Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
+ */
+
+/**
+ * @@@
+ * @@@
+ *
+ * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
+ *
+ * @param name - Name of the object for debugging purposes
+ * @param objectValue - Object to be deeply frozen
+ * @returns The same object as the input, but deeply frozen
+ * @private this is in comparison to `deepFreeze` a more specific utility and maybe not very good practice to use without specific reason and considerations
+ */
+function $asDeeplyFrozenSerializableJson(name, objectValue) {
+    checkSerializableAsJson(name, objectValue);
+    return $deepFreeze(objectValue);
+}
+/**
+ * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
+ * TODO: [🧠] Is there a way how to meaningfully test this utility
+ */
+
+// <- TODO: [🧠] Better system for generator warnings - not always "code" and "by `@promptbook/cli`"
+/**
+ * The maximum number of iterations for a loops
+ *
+ * @private within the repository - too low-level in comparison with other `MAX_...`
+ */
+var LOOP_LIMIT = 1000;
+/**
+ * Timeout for the connections in milliseconds
+ *
+ * @private within the repository - too low-level in comparison with other `MAX_...`
+ */
+var CONNECTION_TIMEOUT_MS = 7 * 1000;
+/**
+ * Nonce which is used for replacing things in strings
+ *
+ * @private within the repository
+ */
+var REPLACING_NONCE = 'u$k42k%!V2zo34w7Fu#@QUHYPW';
+/**
+ * The names of the parameters that are reserved for special purposes
+ *
+ * @public exported from `@promptbook/core`
+ */
+$asDeeplyFrozenSerializableJson('RESERVED_PARAMETER_NAMES', [
+    'content',
+    'context',
+    'knowledge',
+    '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
+]);
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+var RESERVED_PARAMETER_MISSING_VALUE = 'MISSING-' + REPLACING_NONCE;
+/**
+ * @@@
+ *
+ * @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
+ */
+
+/**
+ * This error indicates errors during the execution of the pipeline
+ *
+ * @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);
+        return _this;
+    }
+    return PipelineExecutionError;
+}(Error));
+
 /**
  * Counts number of characters in the text
  *
@@ -539,240 +779,6 @@ function getCurrentIsoDate() {
     return new Date().toISOString();
 }
 
-/**
- * @@@
- *
- * Note: `$` is used to indicate that this function is not a pure function - it mutates given object
- * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
- *
- * @returns The same object as the input, but deeply frozen
- * @public exported from `@promptbook/utils`
- */
-function $deepFreeze(objectValue) {
-    var e_1, _a;
-    var propertyNames = Object.getOwnPropertyNames(objectValue);
-    try {
-        for (var propertyNames_1 = __values(propertyNames), propertyNames_1_1 = propertyNames_1.next(); !propertyNames_1_1.done; propertyNames_1_1 = propertyNames_1.next()) {
-            var propertyName = propertyNames_1_1.value;
-            var value = objectValue[propertyName];
-            if (value && typeof value === 'object') {
-                $deepFreeze(value);
-            }
-        }
-    }
-    catch (e_1_1) { e_1 = { error: e_1_1 }; }
-    finally {
-        try {
-            if (propertyNames_1_1 && !propertyNames_1_1.done && (_a = propertyNames_1.return)) _a.call(propertyNames_1);
-        }
-        finally { if (e_1) throw e_1.error; }
-    }
-    return Object.freeze(objectValue);
-}
-/**
- * TODO: [🧠] Is there a way how to meaningfully test this utility
- */
-
-/**
- * Checks if the value is [🚉] serializable as JSON
- * If not, throws an UnexpectedError with a rich error message and tracking
- *
- * - Almost all primitives are serializable BUT:
- * - `undefined` is not serializable
- * - `NaN` is not serializable
- * - Objects and arrays are serializable if all their properties are serializable
- * - Functions are not serializable
- * - Circular references are not serializable
- * - `Date` objects are not serializable
- * - `Map` and `Set` objects are not serializable
- * - `RegExp` objects are not serializable
- * - `Error` objects are not serializable
- * - `Symbol` objects are not serializable
- * - And much more...
- *
- * @throws UnexpectedError if the value is not serializable as JSON
- * @public exported from `@promptbook/utils`
- */
-function checkSerializableAsJson(name, value) {
-    var e_1, _a;
-    if (value === undefined) {
-        throw new UnexpectedError("".concat(name, " is undefined"));
-    }
-    else if (value === null) {
-        return;
-    }
-    else if (typeof value === 'boolean') {
-        return;
-    }
-    else if (typeof value === 'number' && !isNaN(value)) {
-        return;
-    }
-    else if (typeof value === 'string') {
-        return;
-    }
-    else if (typeof value === 'symbol') {
-        throw new UnexpectedError("".concat(name, " is symbol"));
-    }
-    else if (typeof value === 'function') {
-        throw new UnexpectedError("".concat(name, " is function"));
-    }
-    else if (typeof value === 'object' && Array.isArray(value)) {
-        for (var i = 0; i < value.length; i++) {
-            checkSerializableAsJson("".concat(name, "[").concat(i, "]"), value[i]);
-        }
-    }
-    else if (typeof value === 'object') {
-        if (value instanceof Date) {
-            throw new UnexpectedError(spaceTrim$1("\n                    ".concat(name, " is Date\n\n                    Use `string_date_iso8601` instead\n                ")));
-        }
-        else if (value instanceof Map) {
-            throw new UnexpectedError("".concat(name, " is Map"));
-        }
-        else if (value instanceof Set) {
-            throw new UnexpectedError("".concat(name, " is Set"));
-        }
-        else if (value instanceof RegExp) {
-            throw new UnexpectedError("".concat(name, " is RegExp"));
-        }
-        else if (value instanceof Error) {
-            throw new UnexpectedError(spaceTrim$1("\n                    ".concat(name, " is unserialized Error\n\n                    Use function `serializeError`\n                ")));
-        }
-        else {
-            try {
-                for (var _b = __values(Object.entries(value)), _c = _b.next(); !_c.done; _c = _b.next()) {
-                    var _d = __read(_c.value, 2), subName = _d[0], subValue = _d[1];
-                    if (subValue === undefined) {
-                        // Note: undefined in object is serializable - it is just omited
-                        continue;
-                    }
-                    checkSerializableAsJson("".concat(name, ".").concat(subName), subValue);
-                }
-            }
-            catch (e_1_1) { e_1 = { error: e_1_1 }; }
-            finally {
-                try {
-                    if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
-                }
-                finally { if (e_1) throw e_1.error; }
-            }
-            try {
-                JSON.stringify(value); // <- TODO: [0]
-            }
-            catch (error) {
-                if (!(error instanceof Error)) {
-                    throw error;
-                }
-                throw new UnexpectedError(spaceTrim$1(function (block) { return "\n                            ".concat(name, " is not serializable\n\n                            ").concat(block(error.toString()), "\n                        "); }));
-            }
-            /*
-            TODO: [0] Is there some more elegant way to check circular references?
-            const seen = new Set();
-            const stack = [{ value }];
-            while (stack.length > 0) {
-                const { value } = stack.pop()!;
-                if (typeof value === 'object' && value !== null) {
-                    if (seen.has(value)) {
-                        throw new UnexpectedError(`${name} has circular reference`);
-                    }
-                    seen.add(value);
-                    if (Array.isArray(value)) {
-                        stack.push(...value.map((value) => ({ value })));
-                    } else {
-                        stack.push(...Object.values(value).map((value) => ({ value })));
-                    }
-                }
-            }
-            */
-            return;
-        }
-    }
-    else {
-        throw new UnexpectedError("".concat(name, " is unknown"));
-    }
-}
-/**
- * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
- * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
- * Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
- */
-
-/**
- * @@@
- * @@@
- *
- * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
- *
- * @param name - Name of the object for debugging purposes
- * @param objectValue - Object to be deeply frozen
- * @returns The same object as the input, but deeply frozen
- * @private this is in comparison to `deepFreeze` a more specific utility and maybe not very good practice to use without specific reason and considerations
- */
-function $asDeeplyFrozenSerializableJson(name, objectValue) {
-    checkSerializableAsJson(name, objectValue);
-    return $deepFreeze(objectValue);
-}
-/**
- * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
- * TODO: [🧠] Is there a way how to meaningfully test this utility
- */
-
-// <- TODO: [🧠] Better system for generator warnings - not always "code" and "by `@promptbook/cli`"
-/**
- * The maximum number of iterations for a loops
- *
- * @private within the repository - too low-level in comparison with other `MAX_...`
- */
-var LOOP_LIMIT = 1000;
-/**
- * Nonce which is used for replacing things in strings
- *
- * @private within the repository
- */
-var REPLACING_NONCE = 'u$k42k%!V2zo34w7Fu#@QUHYPW';
-/**
- * The names of the parameters that are reserved for special purposes
- *
- * @public exported from `@promptbook/core`
- */
-$asDeeplyFrozenSerializableJson('RESERVED_PARAMETER_NAMES', [
-    'content',
-    'context',
-    'knowledge',
-    '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
-]);
-/**
- * @@@
- *
- * @private within the repository
- */
-var RESERVED_PARAMETER_MISSING_VALUE = 'MISSING-' + REPLACING_NONCE;
-/**
- * @@@
- *
- * @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
- */
-
 /**
  * This error type indicates that some limit was reached
  *
@@ -1359,6 +1365,7 @@ var AzureOpenAiExecutionTools = /** @class */ (function () {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function () {
             var content, parameters, modelRequirements, client, modelName, modelSettings, rawPromptContent, messages, start, complete, rawRequest, rawResponse, resultContent, usage, error_1;
+            var _this = this;
             return __generator(this, function (_c) {
                 switch (_c.label) {
                     case 0:
@@ -1405,7 +1412,12 @@ var AzureOpenAiExecutionTools = /** @class */ (function () {
                             console.info(colors.bgWhite('messages'), JSON.stringify(messages, null, 4));
                         }
                         rawRequest = [modelName, messages, modelSettings];
-                        return [4 /*yield*/, client.getChatCompletions.apply(client, __spreadArray([], __read(rawRequest), false))];
+                        return [4 /*yield*/, this.withTimeout(client.getChatCompletions.apply(client, __spreadArray([], __read(rawRequest), false))).catch(function (error) {
+                                if (_this.options.isVerbose) {
+                                    console.info(colors.bgRed('error'), error);
+                                }
+                                throw error;
+                            })];
                     case 3:
                         rawResponse = _c.sent();
                         if (this.options.isVerbose) {
@@ -1457,6 +1469,7 @@ var AzureOpenAiExecutionTools = /** @class */ (function () {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function () {
             var content, parameters, modelRequirements, client, modelName, modelSettings, start, complete, rawPromptContent, rawRequest, rawResponse, resultContent, usage, error_2;
+            var _this = this;
             return __generator(this, function (_c) {
                 switch (_c.label) {
                     case 0:
@@ -1495,7 +1508,12 @@ var AzureOpenAiExecutionTools = /** @class */ (function () {
                             [rawPromptContent],
                             modelSettings,
                         ];
-                        return [4 /*yield*/, client.getCompletions.apply(client, __spreadArray([], __read(rawRequest), false))];
+                        return [4 /*yield*/, this.withTimeout(client.getCompletions.apply(client, __spreadArray([], __read(rawRequest), false))).catch(function (error) {
+                                if (_this.options.isVerbose) {
+                                    console.info(colors.bgRed('error'), error);
+                                }
+                                throw error;
+                            })];
                     case 3:
                         rawResponse = _c.sent();
                         if (this.options.isVerbose) {
@@ -1538,6 +1556,22 @@ var AzureOpenAiExecutionTools = /** @class */ (function () {
         });
     };
     // <- Note: [🤖] callXxxModel
+    /**
+     * Library `@azure/openai` has bug/weird behavior that it does not throw error but hangs forever
+     *
+     * This method wraps the promise with timeout
+     */
+    AzureOpenAiExecutionTools.prototype.withTimeout = function (promise) {
+        return new Promise(function (resolve, reject) {
+            var timeout = setTimeout(function () {
+                reject(new PipelineExecutionError('Timeout'));
+            }, CONNECTION_TIMEOUT_MS);
+            promise.then(function (result) {
+                clearTimeout(timeout);
+                resolve(result);
+            }, reject);
+        });
+    };
     /**
      * Changes Azure error (which is not propper Error but object) to propper Error
      */