@promptbook/openai 0.92.0-8 → 0.92.0

package/umd/index.umd.js

@@ -1,13 +1,14 @@
 (function (global, factory) {
-    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('colors'), require('spacetrim'), require('crypto'), require('openai')) :
-    typeof define === 'function' && define.amd ? define(['exports', 'colors', 'spacetrim', 'crypto', 'openai'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-openai"] = {}, global.colors, global.spaceTrim, global.crypto, global.OpenAI));
-})(this, (function (exports, colors, spaceTrim, crypto, OpenAI) { 'use strict';
+    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('colors'), require('spacetrim'), require('crypto'), require('bottleneck'), require('openai')) :
+    typeof define === 'function' && define.amd ? define(['exports', 'colors', 'spacetrim', 'crypto', 'bottleneck', 'openai'], factory) :
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-openai"] = {}, global.colors, global.spaceTrim, global.crypto, global.Bottleneck, global.OpenAI));
+})(this, (function (exports, colors, spaceTrim, crypto, Bottleneck, OpenAI) { 'use strict';
 
     function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
     var colors__default = /*#__PURE__*/_interopDefaultLegacy(colors);
     var spaceTrim__default = /*#__PURE__*/_interopDefaultLegacy(spaceTrim);
+    var Bottleneck__default = /*#__PURE__*/_interopDefaultLegacy(Bottleneck);
     var OpenAI__default = /*#__PURE__*/_interopDefaultLegacy(OpenAI);
 
     // ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten
@@ -24,7 +25,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.92.0-8';
+    const PROMPTBOOK_ENGINE_VERSION = '0.92.0';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -119,7 +120,7 @@
             super(message);
             this.name = 'PipelineExecutionError';
             // TODO: [🐙] DRY - Maybe $randomId
-            this.id = `error-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid simmilar char conflicts   */)}`;
+            this.id = `error-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid similar char conflicts   */)}`;
             Object.setPrototypeOf(this, PipelineExecutionError.prototype);
         }
     }
@@ -284,7 +285,7 @@
     const SMALL_NUMBER = 0.001;
     // <- TODO: [🧜‍♂️]
     /**
-     * @@@
+     * Default settings for parsing and generating CSV files in Promptbook.
      *
      * @public exported from `@promptbook/core`
      */
@@ -294,6 +295,14 @@
         newline: '\n',
         skipEmptyLines: true,
     });
+    /**
+     * Default rate limits (requests per minute)
+     *
+     * Note: Adjust based on the provider tier you are have
+     *
+     * @public exported from `@promptbook/core`
+     */
+    const DEFAULT_MAX_REQUESTS_PER_MINUTE = 60;
     /**
      * Note: [💞] Ignore a discrepancy between file name and entity name
      * TODO: [🧠][🧜‍♂️] Maybe join remoteServerUrl and path into single value
@@ -369,7 +378,7 @@
                     ${block(message)}
 
                     Note: This error should not happen.
-                    It's probbably a bug in the pipeline collection
+                    It's probably a bug in the pipeline collection
 
                     Please report issue:
                     ${block(getErrorReportUrl(new Error(message)).href)}
@@ -569,8 +578,12 @@
      */
 
     /**
-     * @@@
+     * Creates a deep clone of the given object
+     *
+     * Note: This method only works for objects that are fully serializable to JSON and do not contain functions, Dates, or special types.
      *
+     * @param objectValue The object to clone.
+     * @returns A deep, writable clone of the input object.
      * @public exported from `@promptbook/utils`
      */
     function deepClone(objectValue) {
@@ -632,13 +645,19 @@
      */
     const REPLACING_NONCE = 'ptbkauk42kV2dzao34faw7FudQUHYPtW';
     /**
-     * @@@
+     * Nonce which is used as string which is not occurring in normal text
+     *
+     * @private within the repository
+     */
+    const SALT_NONCE = 'ptbkghhewbvruets21t54et5';
+    /**
+     * Placeholder value indicating a parameter is missing its value.
      *
      * @private within the repository
      */
     const RESERVED_PARAMETER_MISSING_VALUE = 'MISSING-' + REPLACING_NONCE;
     /**
-     * @@@
+     * Placeholder value indicating a parameter is restricted and cannot be used directly.
      *
      * @private within the repository
      */
@@ -1175,10 +1194,10 @@
     */
 
     /**
-     * @@@
+     * Removes diacritic marks (accents) from characters in a string.
      *
-     * @param input @@@
-     * @returns @@@
+     * @param input The string containing diacritics to be normalized.
+     * @returns The string with diacritics removed or normalized.
      * @public exported from `@promptbook/utils`
      */
     function removeDiacritics(input) {
@@ -1229,14 +1248,18 @@
     /**
      * Make UncertainNumber
      *
-     * @param value
+     * @param value value of the uncertain number, if `NaN` or `undefined`, it will be set to 0 and `isUncertain=true`
+     * @param isUncertain if `true`, the value is uncertain, otherwise depends on the value
      *
      * @private utility for initializating UncertainNumber
      */
-    function uncertainNumber(value) {
+    function uncertainNumber(value, isUncertain) {
         if (value === null || value === undefined || Number.isNaN(value)) {
             return UNCERTAIN_ZERO_VALUE;
         }
+        if (isUncertain === true) {
+            return { value, isUncertain };
+        }
         return { value };
     }
 
@@ -1253,7 +1276,7 @@
     /**
      * List of available OpenAI models with pricing
      *
-     * Note: Done at 2024-05-20
+     * Note: Done at 2025-05-06
      *
      * @see https://platform.openai.com/docs/models/
      * @see https://openai.com/api/pricing/
@@ -1514,7 +1537,7 @@
                 modelName: 'text-embedding-3-large',
                 modelDescription: "OpenAI's most capable text embedding model designed for high-quality embeddings for complex similarity tasks and information retrieval.",
                 pricing: {
-                    prompt: computeUsage(`$0.13  / 1M tokens`),
+                    prompt: computeUsage(`$0.13 / 1M tokens`),
                     // TODO: [🏏] Leverage the batch API @see https://platform.openai.com/docs/guides/batch
                     output: 0, // <- Note: [🆖] In Embedding models you dont pay for output
                 },
@@ -1607,8 +1630,8 @@
                 modelName: 'gpt-4o-mini',
                 modelDescription: 'Smaller, more cost-effective version of GPT-4o with good performance across text, vision, and audio tasks at reduced complexity.',
                 pricing: {
-                    prompt: computeUsage(`$3.00 / 1M tokens`),
-                    output: computeUsage(`$9.00 / 1M tokens`),
+                    prompt: computeUsage(`$0.15 / 1M tokens`),
+                    output: computeUsage(`$0.60 / 1M tokens`),
                 },
             },
             /**/
@@ -1630,7 +1653,7 @@
                 modelTitle: 'o1-preview-2024-09-12',
                 modelName: 'o1-preview-2024-09-12',
                 modelDescription: 'September 2024 version of O1 preview with specialized reasoning capabilities for complex tasks requiring precise analytical thinking.',
-                //             <- TODO: [💩] Some better system to organize theese date suffixes and versions
+                //             <- TODO: [💩] Some better system to organize these date suffixes and versions
                 pricing: {
                     prompt: computeUsage(`$15.00 / 1M tokens`),
                     output: computeUsage(`$60.00 / 1M tokens`),
@@ -1736,13 +1759,21 @@
         }
         const inputTokens = rawResponse.usage.prompt_tokens;
         const outputTokens = ((_b = rawResponse.usage) === null || _b === void 0 ? void 0 : _b.completion_tokens) || 0;
-        const modelInfo = OPENAI_MODELS.find((model) => model.modelName === rawResponse.model);
+        let isUncertain = false;
+        let modelInfo = OPENAI_MODELS.find((model) => model.modelName === rawResponse.model);
+        if (modelInfo === undefined) {
+            // Note: Model is not in the list of known models, fallback to the family of the models and mark price as uncertain
+            modelInfo = OPENAI_MODELS.find((model) => (rawResponse.model || SALT_NONCE).startsWith(model.modelName));
+            if (modelInfo !== undefined) {
+                isUncertain = true;
+            }
+        }
         let price;
         if (modelInfo === undefined || modelInfo.pricing === undefined) {
             price = uncertainNumber();
         }
         else {
-            price = uncertainNumber(inputTokens * modelInfo.pricing.prompt + outputTokens * modelInfo.pricing.output);
+            price = uncertainNumber(inputTokens * modelInfo.pricing.prompt + outputTokens * modelInfo.pricing.output, isUncertain);
         }
         return {
             price,
@@ -1777,6 +1808,10 @@
              * OpenAI API client.
              */
             this.client = null;
+            // TODO: Allow configuring rate limits via options
+            this.limiter = new Bottleneck__default["default"]({
+                minTime: 60000 / (this.options.maxRequestsPerMinute || DEFAULT_MAX_REQUESTS_PER_MINUTE),
+            });
         }
         get title() {
             return 'OpenAI';
@@ -1876,11 +1911,12 @@
                 user: (_a = this.options.userId) === null || _a === void 0 ? void 0 : _a.toString(),
             };
             const start = $getCurrentDate();
-            let complete;
             if (this.options.isVerbose) {
                 console.info(colors__default["default"].bgWhite('rawRequest'), JSON.stringify(rawRequest, null, 4));
             }
-            const rawResponse = await client.chat.completions.create(rawRequest).catch((error) => {
+            const rawResponse = await this.limiter
+                .schedule(() => client.chat.completions.create(rawRequest))
+                .catch((error) => {
                 assertsError(error);
                 if (this.options.isVerbose) {
                     console.info(colors__default["default"].bgRed('error'), error);
@@ -1890,6 +1926,7 @@
             if (this.options.isVerbose) {
                 console.info(colors__default["default"].bgWhite('rawResponse'), JSON.stringify(rawResponse, null, 4));
             }
+            const complete = $getCurrentDate();
             if (!rawResponse.choices[0]) {
                 throw new PipelineExecutionError('No choises from OpenAI');
             }
@@ -1898,8 +1935,6 @@
                 throw new PipelineExecutionError('More than one choise from OpenAI');
             }
             const resultContent = rawResponse.choices[0].message.content;
-            // eslint-disable-next-line prefer-const
-            complete = $getCurrentDate();
             const usage = computeOpenAiUsage(content || '', resultContent || '', rawResponse);
             if (resultContent === null) {
                 throw new PipelineExecutionError('No response message from OpenAI');
@@ -1953,11 +1988,12 @@
                 user: (_a = this.options.userId) === null || _a === void 0 ? void 0 : _a.toString(),
             };
             const start = $getCurrentDate();
-            let complete;
             if (this.options.isVerbose) {
                 console.info(colors__default["default"].bgWhite('rawRequest'), JSON.stringify(rawRequest, null, 4));
             }
-            const rawResponse = await client.completions.create(rawRequest).catch((error) => {
+            const rawResponse = await this.limiter
+                .schedule(() => client.completions.create(rawRequest))
+                .catch((error) => {
                 assertsError(error);
                 if (this.options.isVerbose) {
                     console.info(colors__default["default"].bgRed('error'), error);
@@ -1967,6 +2003,7 @@
             if (this.options.isVerbose) {
                 console.info(colors__default["default"].bgWhite('rawResponse'), JSON.stringify(rawResponse, null, 4));
             }
+            const complete = $getCurrentDate();
             if (!rawResponse.choices[0]) {
                 throw new PipelineExecutionError('No choises from OpenAI');
             }
@@ -1975,8 +2012,6 @@
                 throw new PipelineExecutionError('More than one choise from OpenAI');
             }
             const resultContent = rawResponse.choices[0].text;
-            // eslint-disable-next-line prefer-const
-            complete = $getCurrentDate();
             const usage = computeOpenAiUsage(content || '', resultContent || '', rawResponse);
             return exportJson({
                 name: 'promptResult',
@@ -2017,11 +2052,12 @@
                 model: modelName,
             };
             const start = $getCurrentDate();
-            let complete;
             if (this.options.isVerbose) {
                 console.info(colors__default["default"].bgWhite('rawRequest'), JSON.stringify(rawRequest, null, 4));
             }
-            const rawResponse = await client.embeddings.create(rawRequest).catch((error) => {
+            const rawResponse = await this.limiter
+                .schedule(() => client.embeddings.create(rawRequest))
+                .catch((error) => {
                 assertsError(error);
                 if (this.options.isVerbose) {
                     console.info(colors__default["default"].bgRed('error'), error);
@@ -2031,12 +2067,11 @@
             if (this.options.isVerbose) {
                 console.info(colors__default["default"].bgWhite('rawResponse'), JSON.stringify(rawResponse, null, 4));
             }
+            const complete = $getCurrentDate();
             if (rawResponse.data.length !== 1) {
                 throw new PipelineExecutionError(`Expected exactly 1 data item in response, got ${rawResponse.data.length}`);
             }
             const resultContent = rawResponse.data[0].embedding;
-            // eslint-disable-next-line prefer-const
-            complete = $getCurrentDate();
             const usage = computeOpenAiUsage(content || '', '', 
             // <- Note: Embedding does not have result content
             rawResponse);
@@ -2064,7 +2099,8 @@
          * Get the model that should be used as default
          */
         getDefaultModel(defaultModelName) {
-            const model = OPENAI_MODELS.find(({ modelName }) => modelName === defaultModelName);
+            // Note: Match exact or prefix for model families
+            const model = OPENAI_MODELS.find(({ modelName }) => modelName === defaultModelName || modelName.startsWith(defaultModelName));
             if (model === undefined) {
                 throw new UnexpectedError(spaceTrim__default["default"]((block) => `
                             Cannot find model in OpenAI models with name "${defaultModelName}" which should be used as default.
@@ -2106,7 +2142,7 @@
     /**
      * Execution Tools for calling OpenAI API Assistants
      *
-     * This is usefull for calling OpenAI API with a single assistant, for more wide usage use `OpenAiExecutionTools`.
+     * This is useful for calling OpenAI API with a single assistant, for more wide usage use `OpenAiExecutionTools`.
      *
      * @public exported from `@promptbook/openai`
      */
@@ -2119,6 +2155,7 @@
         constructor(options) {
             super(options);
             this.assistantId = options.assistantId;
+            // TODO: [👱] Make limiter same as in `OpenAiExecutionTools`
         }
         get title() {
             return 'OpenAI Assistant';
@@ -2310,7 +2347,8 @@
      */
 
     /**
-     * @@@
+     * Safely retrieves the global scope object (window in browser, global in Node.js)
+     * regardless of the JavaScript environment in which the code is running
      *
      * Note: `$` is used to indicate that this function is not a pure function - it access global scope
      *
@@ -2321,10 +2359,10 @@
     }
 
     /**
-     * @@@
+     * Normalizes a text string to SCREAMING_CASE (all uppercase with underscores).
      *
-     * @param text @@@
-     * @returns @@@
+     * @param text The text string to be converted to SCREAMING_CASE format.
+     * @returns The normalized text in SCREAMING_CASE format.
      * @example 'HELLO_WORLD'
      * @example 'I_LOVE_PROMPTBOOK'
      * @public exported from `@promptbook/utils`
@@ -2376,10 +2414,10 @@
      */
 
     /**
-     * @@@
+     * Normalizes a text string to snake_case format.
      *
-     * @param text @@@
-     * @returns @@@
+     * @param text The text string to be converted to snake_case format.
+     * @returns The normalized text in snake_case format.
      * @example 'hello_world'
      * @example 'i_love_promptbook'
      * @public exported from `@promptbook/utils`
@@ -2389,11 +2427,11 @@
     }
 
     /**
-     * Register is @@@
+     * Global registry for storing and managing registered entities of a given type.
      *
      * Note: `$` is used to indicate that this function is not a pure function - it accesses and adds variables in global scope.
      *
-     * @private internal utility, exported are only signleton instances of this class
+     * @private internal utility, exported are only singleton instances of this class
      */
     class $Register {
         constructor(registerName) {
@@ -2437,10 +2475,10 @@
     }
 
     /**
-     * @@@
+     * Register for LLM tools.
      *
      * Note: `$` is used to indicate that this interacts with the global scope
-     * @singleton Only one instance of each register is created per build, but thare can be more @@@
+     * @singleton Only one instance of each register is created per build, but there can be more instances across different builds or environments.
      * @public exported from `@promptbook/core`
      */
     const $llmToolsRegister = new $Register('llm_execution_tools_constructors');
@@ -2459,9 +2497,9 @@
      */
     const _OpenAiRegistration = $llmToolsRegister.register(createOpenAiExecutionTools);
     /**
-     * @@@ registration2
+     * Registration of the OpenAI Assistant provider
      *
-     * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
+     * Note: [🏐] Configurations registrations are done in register-constructor.ts BUT constructor register-constructor.ts
      *
      * @public exported from `@promptbook/openai`
      * @public exported from `@promptbook/wizzard`