@promptbook/documents 0.104.0-12 → 0.104.0-14

package/umd/index.umd.js

@@ -25,7 +25,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.104.0-12';
+    const PROMPTBOOK_ENGINE_VERSION = '0.104.0-14';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -1755,8 +1755,8 @@
      */
     function removeDiacritics(input) {
         /*eslint no-control-regex: "off"*/
-        return input.replace(/[^\u0000-\u007E]/g, (a) => {
-            return DIACRITIC_VARIANTS_LETTERS[a] || a;
+        return input.replace(/[^\u0000-\u007E]/g, (character) => {
+            return DIACRITIC_VARIANTS_LETTERS[character] || character;
         });
     }
     /**
@@ -3927,7 +3927,7 @@
             tasks.push(task);
             runningTasks.push(task);
             /* not await */ Promise.resolve(task).then(() => {
-                runningTasks = runningTasks.filter((t) => t !== task);
+                runningTasks = runningTasks.filter((runningTask) => runningTask !== task);
             });
             if (maxParallelCount < runningTasks.length) {
                 await Promise.race(runningTasks);
@@ -3984,10 +3984,14 @@
     }
 
     /**
-     * Intercepts LLM tools and counts total usage of the tools
+     * Intercepts LLM tools and counts total usage of the tools.
      *
-     * @param llmTools LLM tools to be intercepted with usage counting
-     * @returns LLM tools with same functionality with added total cost counting
+     * This function wraps the provided `LlmExecutionTools` with a proxy that tracks the cumulative
+     * usage (tokens, cost, etc.) across all model calls. It provides a way to monitor spending
+     * in real-time through an observable.
+     *
+     * @param llmTools - The LLM tools to be intercepted and tracked
+     * @returns An augmented version of the tools that includes usage tracking capabilities
      * @public exported from `@promptbook/core`
      */
     function countUsage(llmTools) {
@@ -4252,17 +4256,21 @@
      */
 
     /**
-     * Joins multiple LLM Execution Tools into one
+     * Joins multiple LLM Execution Tools into one.
      *
-     * @returns {LlmExecutionTools} Single wrapper for multiple LlmExecutionTools
+     * This function takes a list of `LlmExecutionTools` and returns a single unified
+     * `MultipleLlmExecutionTools` object. It provides failover and aggregation logic:
      *
-     * 0) If there is no LlmExecutionTools, it warns and returns valid but empty LlmExecutionTools
-     * 1) If there is only one LlmExecutionTools, it returns it wrapped in a proxy object
-     * 2) If there are multiple LlmExecutionTools, first will be used first, second will be used if the first hasn`t defined model variant or fails, etc.
-     * 3) When all LlmExecutionTools fail, it throws an error with a list of all errors merged into one
+     * 1.  **Failover**: When a model call is made, it tries providers in the order they were provided.
+     *     If the first provider doesn't support the requested model or fails, it tries the next one.
+     * 2.  **Aggregation**: `listModels` returns a combined list of all models available from all providers.
+     * 3.  **Empty case**: If no tools are provided, it logs a warning (as Promptbook requires LLMs to function).
      *
+     * @param title - A descriptive title for this collection of joined tools
+     * @param llmExecutionTools - An array of execution tools to be joined
+     * @returns A single unified execution tool wrapper
      *
-     * Tip: You don't have to use this function directly, just pass an array of LlmExecutionTools to the `ExecutionTools`
+     * Tip: You don't have to use this function directly, just pass an array of LlmExecutionTools to the `ExecutionTools`.
      *
      * @public exported from `@promptbook/core`
      */
@@ -6786,7 +6794,7 @@
             const taskEmbeddingResult = await llmTools.callEmbeddingModel(taskEmbeddingPrompt);
             const knowledgePiecesWithRelevance = preparedPipeline.knowledgePieces.map((knowledgePiece) => {
                 const { index } = knowledgePiece;
-                const knowledgePieceIndex = index.find((i) => i.modelName === firstKnowledgeIndex.modelName);
+                const knowledgePieceIndex = index.find((knowledgePieceIndex) => knowledgePieceIndex.modelName === firstKnowledgeIndex.modelName);
                 // <- TODO: Do not use just first knowledge piece and first index to determine embedding model
                 if (knowledgePieceIndex === undefined) {
                     return {
@@ -7234,7 +7242,7 @@
                         resovedParameterNames = [...resovedParameterNames, currentTask.resultingParameterName];
                     })
                         .then(() => {
-                        resolving = resolving.filter((w) => w !== work);
+                        resolving = resolving.filter((workItem) => workItem !== work);
                     });
                     // <- Note: Errors are catched here [3]
                     //    TODO: BUT if in multiple tasks are errors, only the first one is catched so maybe we should catch errors here and save them to errors array here
@@ -7400,7 +7408,7 @@
                         // Calculate and update tldr based on pipeline progress
                         const cv = newOngoingResult;
                         // Calculate progress based on parameters resolved vs total parameters
-                        const totalParameters = pipeline.parameters.filter((p) => !p.isInput).length;
+                        const totalParameters = pipeline.parameters.filter((parameter) => !parameter.isInput).length;
                         let resolvedParameters = 0;
                         let currentTaskTitle = '';
                         // Get the resolved parameters from output parameters