@promptbook/openai 0.92.0-3 → 0.92.0-30

package/esm/typings/src/utils/organization/empty_object.d.ts

@@ -2,8 +2,8 @@
  * Organizational helper to better mark the place where to really use empty object `{}`
  *
  * Note: There are 2 similar types>
- * - `empty_object` @@@
- * - `just_empty_object` @@@
+ * - `empty_object` Type used for empty data objects allowing for potential future extensions
+ * - `just_empty_object` Type used when an object must remain permanently empty
  *
  * @private within the repository
  */

package/esm/typings/src/utils/organization/just_empty_object.d.ts

@@ -1,9 +1,9 @@
 /**
- * Organizational helper to better @@@@
+ * Organizational helper to better distinguish different empty object use cases.
  *
- * Note: There are 2 similar types>
- * - `empty_object` @@@
- * - `just_empty_object` @@@
+ * Note: There are 2 similar types:
+ * - `empty_object` Type used for empty data objects with potential extensions
+ * - `just_empty_object` Type used specifically for objects that must remain empty
  *
  * Note: In most cases, you should use `empty_object`
  *

package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.d.ts

@@ -1,26 +1,26 @@
 import type { string_parameter_name } from '../../types/typeAliases';
 import type { string_parameter_value } from '../../types/typeAliases';
 /**
- * @@@
+ * Options for mapping available parameters to expected parameters in a pipeline task.
  */
 type MakeapAvailableToExpectedParametersOptions = {
     /**
-     * @@@
+     * The set of expected parameter names (keys) for the task, all values are null.
      */
     readonly expectedParameters: Readonly<Record<string_parameter_name, null>>;
     /**
-     * @@@
+     * The set of available parameters (name-value pairs) to map to the expected parameters.
      */
     readonly availableParameters: Readonly<Record<string_parameter_name, string_parameter_value>>;
 };
 /**
- * Maps available parameters to expected parameters
+ * Maps available parameters to expected parameters for a pipeline task.
  *
  * The strategy is:
- * 1) @@@
- * 2) @@@
+ * 1) First, match parameters by name where both available and expected.
+ * 2) Then, if there are unmatched expected and available parameters, map them by order.
  *
- * @throws {PipelineExecutionError} @@@
+ * @throws {PipelineExecutionError} If the number of unmatched expected and available parameters does not match, or mapping is ambiguous.
  * @private within the repository used in `createPipelineExecutor`
  */
 export declare function mapAvailableToExpectedParameters(options: MakeapAvailableToExpectedParametersOptions): Readonly<Record<string_parameter_name, string_parameter_value>>;

package/esm/typings/src/utils/serialization/clonePipeline.d.ts

@@ -1,10 +1,11 @@
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 /**
- * @@@
+ * Creates a deep clone of a PipelineJson object, copying all properties explicitly.
  *
- * Note: It is usefull @@@
+ * Note: It is useful for ensuring that modifications to the returned pipeline do not affect the original.
  *
- * @param pipeline
+ * @param pipeline The pipeline to clone.
+ * @returns A new PipelineJson object with the same properties as the input.
  * @public exported from `@promptbook/utils`
  */
 export declare function clonePipeline(pipeline: PipelineJson): PipelineJson;

package/esm/typings/src/utils/serialization/deepClone.d.ts

@@ -1,7 +1,11 @@
 import type { WritableDeep } from 'type-fest';
 /**
- * @@@
+ * 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`
  */
 export declare function deepClone<TObject>(objectValue: TObject): WritableDeep<TObject>;

package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.d.ts

@@ -1,10 +1,10 @@
 import type { string_javascript_name } from '../../../types/typeAliases';
 import type { really_unknown } from '../../organization/really_unknown';
 /**
- * @@@
+ * Checks if the given value is a valid JavaScript identifier name.
  *
- * @param javascriptName @@@
- * @returns @@@
+ * @param javascriptName The value to check for JavaScript identifier validity.
+ * @returns `true` if the value is a valid JavaScript name, false otherwise.
  * @public exported from `@promptbook/utils`
  */
 export declare function isValidJavascriptName(javascriptName: really_unknown): javascriptName is string_javascript_name;

package/esm/typings/src/utils/validators/parameterName/validateParameterName.d.ts

@@ -1,10 +1,11 @@
 import type { string_parameter_name } from '../../../types/typeAliases';
 /**
- * Function `validateParameterName` will @@@
+ * Function `validateParameterName` will normalize and validate a parameter name for use in pipelines.
+ * It removes diacritics, emojis, and quotes, normalizes to camelCase, and checks for reserved names and invalid characters.
  *
- * @param parameterName @@@
- * @returns @@@
- * @throws {ParseError} @@@
+ * @param parameterName The parameter name to validate and normalize.
+ * @returns The validated and normalized parameter name.
+ * @throws {ParseError} If the parameter name is empty, reserved, or contains invalid characters.
  * @private within the repository
  */
 export declare function validateParameterName(parameterName: string): string_parameter_name;

package/esm/typings/src/version.d.ts

@@ -14,7 +14,8 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
  */
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
- * @@@
+ * Represents the version string of the Promptbook engine.
+ * It follows semantic versioning (e.g., `0.92.0-29`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.92.0-3",
+    "version": "0.92.0-30",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -51,9 +51,10 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.92.0-3"
+        "@promptbook/core": "0.92.0-30"
     },
     "dependencies": {
+        "bottleneck": "^2.19.5",
         "colors": "1.4.0",
         "crypto": "1.0.1",
         "openai": "4.63.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-3';
+    const PROMPTBOOK_ENGINE_VERSION = '0.92.0-30';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -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
@@ -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
      */
@@ -801,10 +820,12 @@
                 throw new PipelineExecutionError('Parameter is already opened or not closed');
             }
             if (parameters[parameterName] === undefined) {
+                console.log('!!! templateParameters 1', { parameterName, template, parameters });
                 throw new PipelineExecutionError(`Parameter \`{${parameterName}}\` is not defined`);
             }
             let parameterValue = parameters[parameterName];
             if (parameterValue === undefined) {
+                console.log('!!! templateParameters 2', { parameterName, template, parameters });
                 throw new PipelineExecutionError(`Parameter \`{${parameterName}}\` is not defined`);
             }
             parameterValue = valueToString(parameterValue);
@@ -1175,10 +1196,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 +1250,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 +1278,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/
@@ -1282,7 +1307,7 @@
                 modelDescription: 'Legacy completion model with strong performance on text generation tasks. Optimized for complex instructions and longer outputs.',
                 pricing: {
                     prompt: computeUsage(`$2.00 / 1M tokens`),
-                    output: computeUsage(`$2.00 / 1M tokens`), // <- not sure
+                    output: computeUsage(`$2.00 / 1M tokens`),
                 },
             },
             /**/
@@ -1424,8 +1449,8 @@
                 modelName: 'gpt-3.5-turbo',
                 modelDescription: 'Latest version of GPT-3.5 Turbo with improved performance and instruction following capabilities. Default 4K context window with options for 16K.',
                 pricing: {
-                    prompt: computeUsage(`$3.00 / 1M tokens`),
-                    output: computeUsage(`$6.00 / 1M tokens`), // <- Not sure, refer to gpt-3.5-turbo in Fine-tuning models
+                    prompt: computeUsage(`$0.50 / 1M tokens`),
+                    output: computeUsage(`$1.50 / 1M tokens`),
                 },
             },
             /**/
@@ -1449,7 +1474,7 @@
                 modelDescription: 'Efficient legacy completion model with a good balance of performance and speed. Suitable for straightforward text generation tasks.',
                 pricing: {
                     prompt: computeUsage(`$0.40 / 1M tokens`),
-                    output: computeUsage(`$0.40 / 1M tokens`), // <- Not sure
+                    output: computeUsage(`$0.40 / 1M tokens`),
                 },
             },
             /**/
@@ -1503,7 +1528,7 @@
                 modelDescription: 'Preview version of GPT-4 Turbo that points to the latest model version. Features improved instruction following, 128K token context window and lower latency.',
                 pricing: {
                     prompt: computeUsage(`$10.00 / 1M tokens`),
-                    output: computeUsage(`$30.00 / 1M tokens`), // <- Not sure, just for gpt-4-turbo
+                    output: computeUsage(`$30.00 / 1M tokens`),
                 },
             },
             /**/
@@ -1514,7 +1539,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 +1632,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`),
                 },
             },
             /**/
@@ -1654,10 +1679,10 @@
                 modelVariant: 'CHAT',
                 modelTitle: 'o1',
                 modelName: 'o1',
+                modelDescription: "OpenAI's advanced reasoning model focused on logic and problem-solving. Designed for complex analytical tasks with rigorous step-by-step reasoning. 128K context window.",
                 pricing: {
-                    prompt: computeUsage(`$3.00 / 1M tokens`),
-                    output: computeUsage(`$12.00 / 1M tokens`),
-                    // <- TODO: !! Unsure, check the pricing
+                    prompt: computeUsage(`$15.00 / 1M tokens`),
+                    output: computeUsage(`$60.00 / 1M tokens`),
                 },
             },
             /**/
@@ -1666,7 +1691,7 @@
                 modelVariant: 'CHAT',
                 modelTitle: 'o3-mini',
                 modelName: 'o3-mini',
-                modelDescription: 'Compact and efficient reasoning model specializing in problem-solving with a focus on research and analysis tasks.',
+                modelDescription: 'Cost-effective reasoning model optimized for academic and scientific problem-solving. Efficient performance on STEM tasks with deep mathematical and scientific knowledge. 128K context window.',
                 pricing: {
                     prompt: computeUsage(`$3.00 / 1M tokens`),
                     output: computeUsage(`$12.00 / 1M tokens`),
@@ -1729,20 +1754,39 @@
     resultContent, rawResponse) {
         var _a, _b;
         if (rawResponse.usage === undefined) {
+            console.log('!!! computeOpenAiUsage', 'The usage is not defined in the response from OpenAI');
             throw new PipelineExecutionError('The usage is not defined in the response from OpenAI');
         }
         if (((_a = rawResponse.usage) === null || _a === void 0 ? void 0 : _a.prompt_tokens) === undefined) {
+            console.log('!!! computeOpenAiUsage', 'In OpenAI response `usage.prompt_tokens` not defined');
             throw new PipelineExecutionError('In OpenAI response `usage.prompt_tokens` not defined');
         }
         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;
+            }
+        }
+        console.log('!!! computeOpenAiUsage', {
+            inputTokens,
+            outputTokens,
+            rawResponse,
+            'rawResponse.model': rawResponse.model,
+            OPENAI_MODELS,
+            resultContent,
+            modelInfo,
+        });
         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 +1821,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';
@@ -1880,7 +1928,9 @@
             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);
@@ -1957,7 +2007,9 @@
             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);
@@ -2021,7 +2073,9 @@
             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);
@@ -2119,6 +2173,7 @@
         constructor(options) {
             super(options);
             this.assistantId = options.assistantId;
+            // TODO: [👱] Make limiter same as in `OpenAiExecutionTools`
         }
         get title() {
             return 'OpenAI Assistant';
@@ -2310,7 +2365,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 +2377,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 +2432,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 +2445,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 +2493,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 +2515,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`