@promptbook/azure-openai 0.61.0-9 → 0.61.0

package/README.md

@@ -39,13 +39,13 @@ npm i @promptbook/azure-openai
 import { createPipelineExecutor, assertsExecutionSuccessful } from '@promptbook/core';
 import { createCollectionFromDirectory } from '@promptbook/node';
 import { JavascriptExecutionTools } from '@promptbook/execute-javascript';
-import { OpenAiExecutionTools } from '@promptbook/openai';
+import { AzureOpenAiExecutionTools } from '@promptbook/azure-openai';
 
 // ▶ Create whole pipeline collection
 const collection = await createCollectionFromDirectory('./promptbook-collection');
 
 // ▶ Get single Pipeline
-const pipeline = await library.getPipelineByUrl(`https://promptbook.studio/my-collection/write-article.ptbk.md`);
+const pipeline = await collection.getPipelineByUrl(`https://promptbook.studio/my-collection/write-article.ptbk.md`);
 
 // ▶ Prepare tools
 const tools = {
@@ -83,13 +83,15 @@ You can use multiple LLM providers in one Promptbook execution. The best model w
 import { createPipelineExecutor, assertsExecutionSuccessful } from '@promptbook/core';
 import { createCollectionFromDirectory } from '@promptbook/node';
 import { JavascriptExecutionTools } from '@promptbook/execute-javascript';
+import { AzureOpenAiExecutionTools } from '@promptbook/azure-openai';
 import { OpenAiExecutionTools } from '@promptbook/openai';
+import { AnthropicClaudeExecutionTools } from '@promptbook/anthropic-claude';
 
 // ▶ Create whole pipeline collection
 const collection = await createCollectionFromDirectory('./promptbook-collection');
 
 // ▶ Get single Pipeline
-const pipeline = await library.getPipelineByUrl(`https://promptbook.studio/my-collection/write-article.ptbk.md`);
+const pipeline = await collection.getPipelineByUrl(`https://promptbook.studio/my-collection/write-article.ptbk.md`);
 
 // ▶ Prepare multiple tools
 const tools = {
@@ -188,7 +190,7 @@ File `write-website-content.ptbk.md`:
 > -   PROMPTBOOK VERSION 0.0.1
 > -   INPUT  PARAM `{rawTitle}` Automatically suggested a site name or empty text
 > -   INPUT  PARAM `{rawAssigment}` Automatically generated site entry from image recognition
-> -   OUTPUT PARAM `{content}` Web content
+> -   OUTPUT PARAM `{websiteContent}` Web content
 > -   OUTPUT PARAM `{keywords}` Keywords
 >
 > ## 👤 Specifying the assigment
@@ -347,7 +349,7 @@ File `write-website-content.ptbk.md`:
 > {contentBody}
 > ```
 >
-> `-> {content}`
+> `-> {websiteContent}`
 
 
 
@@ -387,7 +389,7 @@ flowchart LR
       templateCombineTheBeginning--"{contentBeginning}"-->templateCombineTheContent
       templateWriteTheContent--"{contentBody}"-->templateCombineTheContent
 
-      templateCombineTheContent--"{content}"-->output
+      templateCombineTheContent--"{websiteContent}"-->output
       output((Output)):::output
 
       classDef input color: grey;

package/esm/index.es.js

@@ -1,5 +1,6 @@
 import { OpenAIClient, AzureKeyCredential } from '@azure/openai';
 import colors from 'colors';
+import { spaceTrim } from 'spacetrim';
 
 /*! *****************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -81,6 +82,18 @@ function __generator(thisArg, body) {
     }
 }
 
+function __values(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+}
+
 function __read(o, n) {
     var m = typeof Symbol === "function" && o[Symbol.iterator];
     if (!m) return o;
@@ -96,6 +109,16 @@ function __read(o, n) {
         finally { if (e) throw e.error; }
     }
     return ar;
+}
+
+function __spreadArray(to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
 }
 
 /**
@@ -468,10 +491,186 @@ function getCurrentIsoDate() {
     return new Date().toISOString();
 }
 
+/**
+ * @@@
+ *
+ * @returns The same object as the input, but deeply frozen
+ *
+ * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
+ */
+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: [🔼] Export from `@promptbook/utils`
+ * TODO: [🧠] Is there a way how to meaningfully test this utility
+ */
+
+/**
+ * The maximum number of iterations for a loops
+ */
+var LOOP_LIMIT = 1000;
+/**
+ * Nonce which is used for replacing things in strings
+ */
+var REPLACING_NONCE = 'u$k42k%!V2zo34w7Fu#@QUHYPW';
+/**
+ * The names of the parameters that are reserved for special purposes
+ */
+deepFreeze([
+    'content',
+    'context',
+    'knowledge',
+    'samples',
+    'modelName',
+    'currentDate',
+    // <- TODO: Add more like 'date', 'modelName',...
+    // <- TODO: Add [emoji] + instructions ACRY when adding new reserved parameter
+]);
+/**
+ * @@@
+ */
+var RESERVED_PARAMETER_MISSING_VALUE = 'MISSING-' + REPLACING_NONCE;
+/**
+ * @@@
+ */
+var RESERVED_PARAMETER_RESTRICTED = 'RESTRICTED-' + REPLACING_NONCE;
+/*
+TODO: !!! Just testing false-negative detection of [🟡][🟢][🔵][⚪] leak
+*/
+// [🟡][🟢][🔵][⚪]
+/**
+ * TODO: [🔼] Export all to core
+ */
+
+/**
+ * This error type indicates that some limit was reached
+ */
+var LimitReachedError = /** @class */ (function (_super) {
+    __extends(LimitReachedError, _super);
+    function LimitReachedError(message) {
+        var _this = _super.call(this, message) || this;
+        _this.name = 'LimitReachedError';
+        Object.setPrototypeOf(_this, LimitReachedError.prototype);
+        return _this;
+    }
+    return LimitReachedError;
+}(Error));
+
+/**
+ * This error type indicates that the error should not happen and its last check before crashing with some other error
+ */
+var UnexpectedError = /** @class */ (function (_super) {
+    __extends(UnexpectedError, _super);
+    function UnexpectedError(message) {
+        var _this = _super.call(this, 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));
+
+/**
+ * Replaces parameters in template with values from parameters object
+ *
+ * @param template the template with parameters in {curly} braces
+ * @param parameters the object with parameters
+ * @returns the template with replaced parameters
+ * @throws {PipelineExecutionError} if parameter is not defined, not closed, or not opened
+ */
+function replaceParameters(template, parameters) {
+    var e_1, _a;
+    try {
+        for (var _b = __values(Object.entries(parameters)), _c = _b.next(); !_c.done; _c = _b.next()) {
+            var _d = __read(_c.value, 2), parameterName = _d[0], parameterValue = _d[1];
+            if (parameterValue === RESERVED_PARAMETER_MISSING_VALUE) {
+                throw new UnexpectedError("Parameter {".concat(parameterName, "} has missing value"));
+            }
+            else if (parameterValue === RESERVED_PARAMETER_RESTRICTED) {
+                // TODO: [🍵]
+                throw new UnexpectedError("Parameter {".concat(parameterName, "} is restricted to use"));
+            }
+        }
+    }
+    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; }
+    }
+    var replacedTemplate = template;
+    var match;
+    var loopLimit = LOOP_LIMIT;
+    var _loop_1 = function () {
+        if (loopLimit-- < 0) {
+            throw new LimitReachedError('Loop limit reached during parameters replacement in `replaceParameters`');
+        }
+        var precol = match.groups.precol;
+        var parameterName = match.groups.parameterName;
+        if (parameterName === '') {
+            return "continue";
+        }
+        if (parameterName.indexOf('{') !== -1 || parameterName.indexOf('}') !== -1) {
+            throw new PipelineExecutionError('Parameter is already opened or not closed');
+        }
+        if (parameters[parameterName] === undefined) {
+            throw new PipelineExecutionError("Parameter {".concat(parameterName, "} is not defined"));
+        }
+        var parameterValue = parameters[parameterName];
+        if (parameterValue === undefined) {
+            throw new PipelineExecutionError("Parameter {".concat(parameterName, "} is not defined"));
+        }
+        parameterValue = parameterValue.toString();
+        if (parameterValue.includes('\n') && /^\s*\W{0,3}\s*$/.test(precol)) {
+            parameterValue = parameterValue
+                .split('\n')
+                .map(function (line, index) { return (index === 0 ? line : "".concat(precol).concat(line)); })
+                .join('\n');
+        }
+        replacedTemplate =
+            replacedTemplate.substring(0, match.index + precol.length) +
+                parameterValue +
+                replacedTemplate.substring(match.index + precol.length + parameterName.length + 2);
+    };
+    while ((match = /^(?<precol>.*){(?<parameterName>\w+)}(.*)/m /* <- Not global */
+        .exec(replacedTemplate))) {
+        _loop_1();
+    }
+    // [💫] Check if there are parameters that are not closed properly
+    if (/{\w+$/.test(replacedTemplate)) {
+        throw new PipelineExecutionError('Parameter is not closed');
+    }
+    // [💫] Check if there are parameters that are not opened properly
+    if (/^\w+}/.test(replacedTemplate)) {
+        throw new PipelineExecutionError('Parameter is not opened');
+    }
+    return replacedTemplate;
+}
+
 /**
  * Function computeUsage will create price per one token based on the string value found on openai page
  *
- * @private within the package, used only as internal helper for `OPENAI_MODELS`
+ * @private within the repository, used only as internal helper for `OPENAI_MODELS`
  */
 function computeUsage(value) {
     var _a = __read(value.split(' / '), 2), price = _a[0], tokens = _a[1];
@@ -825,6 +1024,7 @@ var OPENAI_MODELS = [
  * @see /other/playground/playground.ts
  * TODO: [🍓] Make better
  * TODO: Change model titles to human eg: "gpt-4-turbo-2024-04-09" -> "GPT-4 Turbo (2024-04-09)"
+ * TODO: [🚸] Not all models are compatible with JSON mode, add this information here and use it
  */
 
 /**
@@ -860,41 +1060,54 @@ var AzureOpenAiExecutionTools = /** @class */ (function () {
     AzureOpenAiExecutionTools.prototype.callChatModel = function (prompt) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function () {
-            var content, modelRequirements, modelName, modelSettings, messages, start, complete, rawResponse, resultContent, usage, error_1;
-            return __generator(this, function (_c) {
-                switch (_c.label) {
+            var content, parameters, modelRequirements, modelName, modelSettings, rawPromptContent, messages, start, complete, rawRequest, rawResponse, resultContent, usage, error_1;
+            var _c;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
                     case 0:
                         if (this.options.isVerbose) {
                             console.info('💬 OpenAI callChatModel call');
                         }
-                        content = prompt.content, modelRequirements = prompt.modelRequirements;
+                        content = prompt.content, parameters = prompt.parameters, modelRequirements = prompt.modelRequirements;
                         // TODO: [☂] Use here more modelRequirements
                         if (modelRequirements.modelVariant !== 'CHAT') {
                             throw new PipelineExecutionError('Use callChatModel only for CHAT variant');
                         }
-                        _c.label = 1;
+                        _d.label = 1;
                     case 1:
-                        _c.trys.push([1, 3, , 4]);
+                        _d.trys.push([1, 3, , 4]);
                         modelName = prompt.modelRequirements.modelName || this.options.deploymentName;
                         modelSettings = {
                             maxTokens: modelRequirements.maxTokens,
-                            //                                      <- TODO: Make some global max cap for maxTokens
+                            //                                      <- TODO: [🌾] Make some global max cap for maxTokens
+                            temperature: modelRequirements.temperature,
                             user: this.options.user,
+                            // <- TODO: [🈁] Use `seed` here AND/OR use is `isDeterministic` for entire execution tools
+                            // <- Note: [🧆]
                         };
-                        messages = [
+                        rawPromptContent = replaceParameters(content, __assign(__assign({}, parameters), { modelName: modelName }));
+                        messages = __spreadArray(__spreadArray([], __read((modelRequirements.systemMessage === undefined
+                            ? []
+                            : [
+                                {
+                                    role: 'system',
+                                    content: modelRequirements.systemMessage,
+                                },
+                            ])), false), [
                             {
                                 role: 'user',
-                                content: content,
+                                content: rawPromptContent,
                             },
-                        ];
+                        ], false);
                         start = getCurrentIsoDate();
                         complete = void 0;
                         if (this.options.isVerbose) {
                             console.info(colors.bgWhite('messages'), JSON.stringify(messages, null, 4));
                         }
-                        return [4 /*yield*/, this.client.getChatCompletions(modelName, messages, modelSettings)];
+                        rawRequest = [modelName, messages, modelSettings];
+                        return [4 /*yield*/, (_c = this.client).getChatCompletions.apply(_c, __spreadArray([], __read(rawRequest), false))];
                     case 2:
-                        rawResponse = _c.sent();
+                        rawResponse = _d.sent();
                         if (this.options.isVerbose) {
                             console.info(colors.bgWhite('rawResponse'), JSON.stringify(rawResponse, null, 4));
                         }
@@ -924,11 +1137,13 @@ var AzureOpenAiExecutionTools = /** @class */ (function () {
                                     complete: complete,
                                 },
                                 usage: usage,
+                                rawPromptContent: rawPromptContent,
+                                rawRequest: rawRequest,
                                 rawResponse: rawResponse,
-                                // <- [🤹‍♂️]
+                                // <- [🗯]
                             }];
                     case 3:
-                        error_1 = _c.sent();
+                        error_1 = _d.sent();
                         throw this.transformAzureError(error_1);
                     case 4: return [2 /*return*/];
                 }
@@ -941,35 +1156,46 @@ var AzureOpenAiExecutionTools = /** @class */ (function () {
     AzureOpenAiExecutionTools.prototype.callCompletionModel = function (prompt) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function () {
-            var content, modelRequirements, modelName, modelSettings, start, complete, rawResponse, resultContent, usage, error_2;
-            return __generator(this, function (_c) {
-                switch (_c.label) {
+            var content, parameters, modelRequirements, modelName, modelSettings, start, complete, rawPromptContent, rawRequest, rawResponse, resultContent, usage, error_2;
+            var _c;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
                     case 0:
                         if (this.options.isVerbose) {
                             console.info('🖋 OpenAI callCompletionModel call');
                         }
-                        content = prompt.content, modelRequirements = prompt.modelRequirements;
+                        content = prompt.content, parameters = prompt.parameters, modelRequirements = prompt.modelRequirements;
                         // TODO: [☂] Use here more modelRequirements
                         if (modelRequirements.modelVariant !== 'COMPLETION') {
                             throw new PipelineExecutionError('Use callCompletionModel only for COMPLETION variant');
                         }
-                        _c.label = 1;
+                        _d.label = 1;
                     case 1:
-                        _c.trys.push([1, 3, , 4]);
+                        _d.trys.push([1, 3, , 4]);
                         modelName = prompt.modelRequirements.modelName || this.options.deploymentName;
                         modelSettings = {
                             maxTokens: modelRequirements.maxTokens || 2000,
-                            //                                                  <- TODO: Make some global max cap for maxTokens
+                            //                                                  <- TODO: [🌾] Make some global max cap for maxTokens
+                            temperature: modelRequirements.temperature,
                             user: this.options.user,
+                            // <- TODO: [🈁] Use `seed` here AND/OR use is `isDeterministic` for entire execution tools
+                            // <- Note: [🧆]
                         };
                         start = getCurrentIsoDate();
                         complete = void 0;
                         if (this.options.isVerbose) {
                             console.info(colors.bgWhite('content'), JSON.stringify(content, null, 4));
+                            console.info(colors.bgWhite('parameters'), JSON.stringify(parameters, null, 4));
                         }
-                        return [4 /*yield*/, this.client.getCompletions(modelName, [content], modelSettings)];
+                        rawPromptContent = replaceParameters(content, __assign(__assign({}, parameters), { modelName: modelName }));
+                        rawRequest = [
+                            modelName,
+                            [rawPromptContent],
+                            modelSettings,
+                        ];
+                        return [4 /*yield*/, (_c = this.client).getCompletions.apply(_c, __spreadArray([], __read(rawRequest), false))];
                     case 2:
-                        rawResponse = _c.sent();
+                        rawResponse = _d.sent();
                         if (this.options.isVerbose) {
                             console.info(colors.bgWhite('rawResponse'), JSON.stringify(rawResponse, null, 4));
                         }
@@ -996,11 +1222,13 @@ var AzureOpenAiExecutionTools = /** @class */ (function () {
                                     complete: complete,
                                 },
                                 usage: usage,
+                                rawPromptContent: rawPromptContent,
+                                rawRequest: rawRequest,
                                 rawResponse: rawResponse,
-                                // <- [🤹‍♂️]
+                                // <- [🗯]
                             }];
                     case 3:
-                        error_2 = _c.sent();
+                        error_2 = _d.sent();
                         throw this.transformAzureError(error_2);
                     case 4: return [2 /*return*/];
                 }
@@ -1042,12 +1270,13 @@ var AzureOpenAiExecutionTools = /** @class */ (function () {
 /**
  * TODO: Maybe Create some common util for callChatModel and callCompletionModel
  * TODO: Maybe make custom AzureOpenaiError
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
  */
 
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.61.0-8';
+var PROMPTBOOK_VERSION = '0.61.0-30';
 // TODO: !!!! List here all the versions and annotate + put into script
 
 export { AzureOpenAiExecutionTools, PROMPTBOOK_VERSION };