@promptbook/node 0.92.0-20 → 0.92.0-22

package/esm/typings/src/_packages/core.index.d.ts

@@ -32,6 +32,7 @@ import { DEFAULT_IS_VERBOSE } from '../config';
 import { SET_IS_VERBOSE } from '../config';
 import { DEFAULT_IS_AUTO_INSTALLED } from '../config';
 import { DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME } from '../config';
+import { DEFAULT_RPM } from '../config';
 import { ORDER_OF_PIPELINE_JSON } from '../constants';
 import { RESERVED_PARAMETER_NAMES } from '../constants';
 import { compilePipeline } from '../conversion/compilePipeline';
@@ -81,6 +82,7 @@ import { MANDATORY_CSV_SETTINGS } from '../formats/csv/CsvSettings';
 import { TextFormatParser } from '../formats/text/TextFormatParser';
 import { BoilerplateFormfactorDefinition } from '../formfactors/_boilerplate/BoilerplateFormfactorDefinition';
 import { ChatbotFormfactorDefinition } from '../formfactors/chatbot/ChatbotFormfactorDefinition';
+import { CompletionFormfactorDefinition } from '../formfactors/completion/CompletionFormfactorDefinition';
 import { GeneratorFormfactorDefinition } from '../formfactors/generator/GeneratorFormfactorDefinition';
 import { GenericFormfactorDefinition } from '../formfactors/generic/GenericFormfactorDefinition';
 import { ImageGeneratorFormfactorDefinition } from '../formfactors/image-generator/ImageGeneratorFormfactorDefinition';
@@ -175,6 +177,7 @@ export { DEFAULT_IS_VERBOSE };
 export { SET_IS_VERBOSE };
 export { DEFAULT_IS_AUTO_INSTALLED };
 export { DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME };
+export { DEFAULT_RPM };
 export { ORDER_OF_PIPELINE_JSON };
 export { RESERVED_PARAMETER_NAMES };
 export { compilePipeline };
@@ -224,6 +227,7 @@ export { MANDATORY_CSV_SETTINGS };
 export { TextFormatParser };
 export { BoilerplateFormfactorDefinition };
 export { ChatbotFormfactorDefinition };
+export { CompletionFormfactorDefinition };
 export { GeneratorFormfactorDefinition };
 export { GenericFormfactorDefinition };
 export { ImageGeneratorFormfactorDefinition };

package/esm/typings/src/_packages/types.index.d.ts

@@ -62,6 +62,7 @@ import type { UsageCounts } from '../execution/Usage';
 import type { UserInterfaceTools } from '../execution/UserInterfaceTools';
 import type { UserInterfaceToolsPromptDialogOptions } from '../execution/UserInterfaceTools';
 import type { FormatSubvalueParser } from '../formats/_common/FormatSubvalueParser';
+import type { FormatSubvalueParserMapValuesOptions } from '../formats/_common/FormatSubvalueParser';
 import type { CsvSettings } from '../formats/csv/CsvSettings';
 import type { AbstractFormfactorDefinition } from '../formfactors/_common/AbstractFormfactorDefinition';
 import type { FormfactorDefinition } from '../formfactors/_common/FormfactorDefinition';
@@ -358,6 +359,7 @@ export type { UsageCounts };
 export type { UserInterfaceTools };
 export type { UserInterfaceToolsPromptDialogOptions };
 export type { FormatSubvalueParser };
+export type { FormatSubvalueParserMapValuesOptions };
 export type { CsvSettings };
 export type { AbstractFormfactorDefinition };
 export type { FormfactorDefinition };

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

@@ -265,6 +265,14 @@ export declare const DEFAULT_IS_AUTO_INSTALLED = false;
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME = "getPipelineCollection";
+/**
+ * Default rate limits (requests per minute)
+ *
+ * Note: Adjust based on the provider tier you are have
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_RPM = 60;
 /**
  * @@@
  *

package/esm/typings/src/execution/createPipelineExecutor/30-executeFormatSubvalues.d.ts

@@ -1,11 +1,18 @@
+import type { PartialDeep, Promisable } from 'type-fest';
 import type { TODO_any } from '../../utils/organization/TODO_any';
+import type { PipelineExecutorResult } from '../PipelineExecutorResult';
 import type { ExecuteAttemptsOptions } from './40-executeAttempts';
 /**
  * @@@
  *
  * @private internal type of `executeFormatSubvalues`
  */
-type ExecuteFormatCellsOptions = ExecuteAttemptsOptions;
+type ExecuteFormatCellsOptions = ExecuteAttemptsOptions & {
+    /**
+     * @@@
+     */
+    readonly onProgress: (newOngoingResult: PartialDeep<PipelineExecutorResult>) => Promisable<void>;
+};
 /**
  * @@@
  *

package/esm/typings/src/formats/_common/FormatSubvalueParser.d.ts

@@ -24,7 +24,17 @@ export type FormatSubvalueParser<TValue extends string, TSettings extends empty_
      * For example, if you have a JSON object and you want to map all values to uppercase
      * Or iterate over all CSV cells @@@
      */
-    mapValues(value: TValue, outputParameterName: string_parameter_name, settings: TSettings, mapCallback: (subvalues: Parameters, index: number) => Promisable<string>): Promise<string>;
+    mapValues(options: FormatSubvalueParserMapValuesOptions<TValue, TSettings>): Promise<string>;
+};
+/**
+ * @@@
+ */
+export type FormatSubvalueParserMapValuesOptions<TValue extends string, TSettings extends empty_object> = {
+    readonly value: TValue;
+    readonly outputParameterName: string_parameter_name;
+    readonly settings: TSettings;
+    mapCallback: (subvalues: Parameters, index: number) => Promisable<TValue>;
+    onProgress(partialResultString: TValue): Promisable<void>;
 };
 /**
  * Note: [👩🏾‍🤝‍🧑🏽]

package/esm/typings/src/formats/json/utils/jsonParse.d.ts

@@ -6,6 +6,3 @@
  * @public exported from `@promptbook/utils`
  */
 export declare function jsonParse<T>(value: string): T;
-/**
- * TODO: !!!! Use in Promptbook.studio
- */

package/esm/typings/src/formfactors/completion/CompletionFormfactorDefinition.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Completion is formfactor that emulates completion models
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const CompletionFormfactorDefinition: {
+    readonly name: "COMPLETION";
+    readonly description: "@@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly pipelineInterface: {
+        readonly inputParameters: readonly [{
+            readonly name: "inputText";
+            readonly description: "Input text to be completed";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }, {
+            readonly name: "instructions";
+            readonly description: "Additional instructions for the model, for example the required length, empty by default";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }];
+        readonly outputParameters: readonly [{
+            readonly name: "followingText";
+            readonly description: "Text that follows the input text";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }];
+    };
+};

package/esm/typings/src/formfactors/index.d.ts

@@ -36,9 +36,6 @@ export declare const FORMFACTOR_DEFINITIONS: readonly [{
         readonly outputParameters: readonly [{
             readonly name: "title";
             readonly description: "Title of the conversation";
-            /**
-             * Note: [💞] Ignore a discrepancy between file name and entity name
-             */
             readonly isInput: false;
             readonly isOutput: true;
         }, {
@@ -132,6 +129,11 @@ export declare const FORMFACTOR_DEFINITIONS: readonly [{
             readonly isInput: true;
             readonly isOutput: false;
         }];
+        /**
+         * All available formfactor definitions
+         *
+         * @public exported from `@promptbook/core`
+         */
         readonly outputParameters: readonly [{
             readonly name: "prompt";
             readonly description: "Prompt to be used for image generation";
@@ -139,6 +141,29 @@ export declare const FORMFACTOR_DEFINITIONS: readonly [{
             readonly isOutput: true;
         }];
     };
+}, {
+    readonly name: "COMPLETION";
+    readonly description: "@@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly pipelineInterface: {
+        readonly inputParameters: readonly [{
+            readonly name: "inputText";
+            readonly description: "Input text to be completed";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }, {
+            readonly name: "instructions";
+            readonly description: "Additional instructions for the model, for example the required length, empty by default";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }];
+        readonly outputParameters: readonly [{
+            readonly name: "followingText";
+            readonly description: "Text that follows the input text";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }];
+    };
 }];
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/high-level-abstractions/index.d.ts

@@ -23,7 +23,7 @@ export declare const HIGH_LEVEL_ABSTRACTIONS: readonly [{
             path: string | null;
             content: import("../pipeline/PipelineString").PipelineString;
         }[];
-        readonly formfactorName?: "CHATBOT" | "GENERATOR" | "GENERIC" | "IMAGE_GENERATOR" | "EXPERIMENTAL_MATCHER" | "SHEETS" | "TRANSLATOR" | undefined;
+        readonly formfactorName?: "CHATBOT" | "COMPLETION" | "GENERATOR" | "GENERIC" | "IMAGE_GENERATOR" | "EXPERIMENTAL_MATCHER" | "SHEETS" | "TRANSLATOR" | undefined;
     }>): void;
 }, {
     type: "SYNC";
@@ -45,7 +45,7 @@ export declare const HIGH_LEVEL_ABSTRACTIONS: readonly [{
             path: string | null;
             content: import("../pipeline/PipelineString").PipelineString;
         }[];
-        readonly formfactorName?: "CHATBOT" | "GENERATOR" | "GENERIC" | "IMAGE_GENERATOR" | "EXPERIMENTAL_MATCHER" | "SHEETS" | "TRANSLATOR" | undefined;
+        readonly formfactorName?: "CHATBOT" | "COMPLETION" | "GENERATOR" | "GENERIC" | "IMAGE_GENERATOR" | "EXPERIMENTAL_MATCHER" | "SHEETS" | "TRANSLATOR" | undefined;
     }>): void;
 }];
 /**

package/esm/typings/src/migrations/migratePipeline.d.ts

@@ -2,6 +2,8 @@ import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
 /**
  * Migrates the pipeline to the latest version
  *
+ * Note: Migration does not do heavy lifting like calling the LLMs, just lightweight changes of the structure
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function migratePipeline(deprecatedPipeline: PipelineJson): PipelineJson;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/node",
-    "version": "0.92.0-20",
+    "version": "0.92.0-22",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -51,7 +51,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/node.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.92.0-20"
+        "@promptbook/core": "0.92.0-22"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -46,7 +46,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.92.0-20';
+    const PROMPTBOOK_ENGINE_VERSION = '0.92.0-22';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -344,15 +344,12 @@
             }
             throw new Error(spaceTrim__default["default"]((block) => `
                     ${block(error.message)}
-            
+
                     The JSON text:
                     ${block(value)}
                 `));
         }
     }
-    /**
-     * TODO: !!!! Use in Promptbook.studio
-     */
 
     /**
      * Orders JSON object by keys
@@ -2604,7 +2601,8 @@
         subvalueParsers: [
             {
                 subvalueName: 'ROW',
-                async mapValues(value, outputParameterName, settings, mapCallback) {
+                async mapValues(options) {
+                    const { value, outputParameterName, settings, mapCallback, onProgress } = options;
                     const csv = csvParse(value, settings);
                     if (csv.errors.length !== 0) {
                         throw new CsvFormatError(spaceTrim__default["default"]((block) => `
@@ -2620,21 +2618,29 @@
                                 ${block(value)}
                             `));
                     }
-                    const mappedData = await Promise.all(csv.data.map(async (row, index) => {
+                    const mappedData = [];
+                    for (let index = 0; index < csv.data.length; index++) {
+                        const row = csv.data[index];
                         if (row[outputParameterName]) {
                             throw new CsvFormatError(`Can not overwrite existing column "${outputParameterName}" in CSV row`);
                         }
-                        return {
+                        const mappedRow = {
                             ...row,
                             [outputParameterName]: await mapCallback(row, index),
                         };
-                    }));
+                        mappedData.push(mappedRow);
+                        if (onProgress) {
+                            // Note: Report the CSV with all rows mapped so far
+                            await onProgress(papaparse.unparse(mappedData, { ...settings, ...MANDATORY_CSV_SETTINGS }));
+                        }
+                    }
                     return papaparse.unparse(mappedData, { ...settings, ...MANDATORY_CSV_SETTINGS });
                 },
             },
             {
                 subvalueName: 'CELL',
-                async mapValues(value, outputParameterName, settings, mapCallback) {
+                async mapValues(options) {
+                    const { value, settings, mapCallback, onProgress } = options;
                     const csv = csvParse(value, settings);
                     if (csv.errors.length !== 0) {
                         throw new CsvFormatError(spaceTrim__default["default"]((block) => `
@@ -2721,7 +2727,8 @@
         subvalueParsers: [
             {
                 subvalueName: 'LINE',
-                async mapValues(value, outputParameterName, settings, mapCallback) {
+                async mapValues(options) {
+                    const { value, mapCallback, onProgress } = options;
                     const lines = value.split('\n');
                     const mappedLines = await Promise.all(lines.map((lineContent, lineNumber) => 
                     // TODO: [🧠] Maybe option to skip empty line
@@ -4031,7 +4038,7 @@
      * @private internal utility of `createPipelineExecutor`
      */
     async function executeFormatSubvalues(options) {
-        const { task, jokerParameterNames, parameters, priority, csvSettings, pipelineIdentification } = options;
+        const { task, jokerParameterNames, parameters, priority, csvSettings, onProgress, pipelineIdentification } = options;
         if (task.foreach === undefined) {
             return /* not await */ executeAttempts(options);
         }
@@ -4085,21 +4092,32 @@
             formatSettings = csvSettings;
             // <- TODO: [🤹‍♂️] More universal, make simmilar pattern for other formats for example \n vs \r\n in text
         }
-        const resultString = await subvalueParser.mapValues(parameterValue, task.foreach.outputSubparameterName, formatSettings, async (subparameters, index) => {
-            let mappedParameters;
-            // TODO: [🤹‍♂️][🪂] Limit to N concurrent executions
-            // TODO: When done [🐚] Report progress also for each subvalue here
-            try {
-                mappedParameters = mapAvailableToExpectedParameters({
-                    expectedParameters: Object.fromEntries(task.foreach.inputSubparameterNames.map((subparameterName) => [subparameterName, null])),
-                    availableParameters: subparameters,
-                });
-            }
-            catch (error) {
-                if (!(error instanceof PipelineExecutionError)) {
-                    throw error;
+        const resultString = await subvalueParser.mapValues({
+            value: parameterValue,
+            outputParameterName: task.foreach.outputSubparameterName,
+            settings: formatSettings,
+            onProgress(partialResultString) {
+                return onProgress(Object.freeze({
+                    [task.resultingParameterName]: 
+                    // <- Note: [👩‍👩‍👧] No need to detect parameter collision here because pipeline checks logic consistency during construction
+                    partialResultString,
+                }));
+            },
+            async mapCallback(subparameters, index) {
+                let mappedParameters;
+                // TODO: [🤹‍♂️][🪂] Limit to N concurrent executions
+                // TODO: When done [🐚] Report progress also for each subvalue here
+                try {
+                    mappedParameters = mapAvailableToExpectedParameters({
+                        expectedParameters: Object.fromEntries(task.foreach.inputSubparameterNames.map((subparameterName) => [subparameterName, null])),
+                        availableParameters: subparameters,
+                    });
                 }
-                throw new PipelineExecutionError(spaceTrim__default["default"]((block) => `
+                catch (error) {
+                    if (!(error instanceof PipelineExecutionError)) {
+                        throw error;
+                    }
+                    throw new PipelineExecutionError(spaceTrim__default["default"]((block) => `
                         ${error.message}
 
                         This is error in FOREACH command
@@ -4108,23 +4126,24 @@
                         ${block(pipelineIdentification)}
                         Subparameter index: ${index}
                     `));
-            }
-            const allSubparameters = {
-                ...parameters,
-                ...mappedParameters,
-            };
-            // Note: [👨‍👨‍👧] Now we can freeze `subparameters` because we are sure that all and only used parameters are defined and are not going to be changed
-            Object.freeze(allSubparameters);
-            const subresultString = await executeAttempts({
-                ...options,
-                priority: priority + index,
-                parameters: allSubparameters,
-                pipelineIdentification: spaceTrim__default["default"]((block) => `
+                }
+                const allSubparameters = {
+                    ...parameters,
+                    ...mappedParameters,
+                };
+                // Note: [👨‍👨‍👧] Now we can freeze `subparameters` because we are sure that all and only used parameters are defined and are not going to be changed
+                Object.freeze(allSubparameters);
+                const subresultString = await executeAttempts({
+                    ...options,
+                    priority: priority + index,
+                    parameters: allSubparameters,
+                    pipelineIdentification: spaceTrim__default["default"]((block) => `
                         ${block(pipelineIdentification)}
                         Subparameter index: ${index}
                     `),
-            });
-            return subresultString;
+                });
+                return subresultString;
+            },
         });
         return resultString;
     }
@@ -4298,11 +4317,6 @@
     async function executeTask(options) {
         const { currentTask, preparedPipeline, parametersToPass, tools, onProgress, $executionReport, pipelineIdentification, maxExecutionAttempts, maxParallelCount, csvSettings, isVerbose, rootDirname, cacheDirname, intermediateFilesStrategy, isAutoInstalled, isNotPreparedWarningSupressed, } = options;
         const priority = preparedPipeline.tasks.length - preparedPipeline.tasks.indexOf(currentTask);
-        await onProgress({
-            outputParameters: {
-                [currentTask.resultingParameterName]: '', // <- TODO: [🧠] What is the best value here?
-            },
-        });
         // Note: Check consistency of used and dependent parameters which was also done in `validatePipeline`, but it’s good to doublecheck
         const usedParameterNames = extractParameterNamesFromTask(currentTask);
         const dependentParameterNames = new Set(currentTask.dependentParameterNames);
@@ -4377,6 +4391,7 @@
             preparedPipeline,
             tools,
             $executionReport,
+            onProgress,
             pipelineIdentification,
             maxExecutionAttempts,
             maxParallelCount,
@@ -6971,6 +6986,43 @@
         },
     };
 
+    /**
+     * Completion is formfactor that emulates completion models
+     *
+     * @public exported from `@promptbook/core`
+     */
+    const CompletionFormfactorDefinition = {
+        name: 'COMPLETION',
+        description: `@@@`,
+        documentationUrl: `https://github.com/webgptorg/promptbook/discussions/@@`,
+        //                                                                     <- TODO: https://github.com/webgptorg/promptbook/discussions/new?category=concepts
+        //                                                                              "🔠 Completion Formfactor"
+        pipelineInterface: {
+            inputParameters: [
+                {
+                    name: 'inputText',
+                    description: `Input text to be completed`,
+                    isInput: true,
+                    isOutput: false,
+                },
+                {
+                    name: 'instructions',
+                    description: `Additional instructions for the model, for example the required length, empty by default`,
+                    isInput: true,
+                    isOutput: false,
+                },
+            ],
+            outputParameters: [
+                {
+                    name: 'followingText',
+                    description: `Text that follows the input text`,
+                    isInput: false,
+                    isOutput: true,
+                },
+            ],
+        },
+    };
+
     /**
      * Generator is form of app that @@@
      *
@@ -7155,6 +7207,8 @@
         MatcherFormfactorDefinition,
         GeneratorFormfactorDefinition,
         ImageGeneratorFormfactorDefinition,
+        CompletionFormfactorDefinition,
+        // <- [🛬] When making new formfactor, copy the _boilerplate and link it here
     ];
     /**
      * Note: [💞] Ignore a discrepancy between file name and entity name