@promptbook/core 0.92.0-19 → 0.92.0-21

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';
@@ -105,6 +107,7 @@ import { joinLlmExecutionTools } from '../llm-providers/multiple/joinLlmExecutio
 import { MultipleLlmExecutionTools } from '../llm-providers/multiple/MultipleLlmExecutionTools';
 import { _OpenAiMetadataRegistration } from '../llm-providers/openai/register-configuration';
 import { _OpenAiAssistantMetadataRegistration } from '../llm-providers/openai/register-configuration';
+import { migratePipeline } from '../migrations/migratePipeline';
 import { preparePersona } from '../personas/preparePersona';
 import { book } from '../pipeline/book-notation';
 import { isValidPipelineString } from '../pipeline/isValidPipelineString';
@@ -174,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 };
@@ -223,6 +227,7 @@ export { MANDATORY_CSV_SETTINGS };
 export { TextFormatParser };
 export { BoilerplateFormfactorDefinition };
 export { ChatbotFormfactorDefinition };
+export { CompletionFormfactorDefinition };
 export { GeneratorFormfactorDefinition };
 export { GenericFormfactorDefinition };
 export { ImageGeneratorFormfactorDefinition };
@@ -247,6 +252,7 @@ export { joinLlmExecutionTools };
 export { MultipleLlmExecutionTools };
 export { _OpenAiMetadataRegistration };
 export { _OpenAiAssistantMetadataRegistration };
+export { migratePipeline };
 export { preparePersona };
 export { book };
 export { isValidPipelineString };

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/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

@@ -0,0 +1,9 @@
+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/esm/typings/src/pipeline/PipelineJson/PipelineJson.d.ts

@@ -103,6 +103,7 @@ export type PipelineJson = {
     }>;
 };
 /**
+ * TODO: [🌪] Make type for deprecated pipelines
  * TODO: [🛳] Default PERSONA for the pipeline `defaultPersonaName` (same as `defaultModelRequirements`)
  * TODO: [🍙] Make some standard order of json properties
  * TODO: [🧠] Maybe wrap all {parameterNames} in brackets for example { "resultingParameterName": "{foo}" }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/core",
-    "version": "0.92.0-19",
+    "version": "0.92.0-21",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,

package/umd/index.umd.js

@@ -27,7 +27,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.92.0-19';
+    const PROMPTBOOK_ENGINE_VERSION = '0.92.0-21';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -462,6 +462,14 @@
      * @public exported from `@promptbook/core`
      */
     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`
+     */
+    const DEFAULT_RPM = 60;
     /**
      * @@@
      *
@@ -2185,15 +2193,12 @@
             }
             throw new Error(spaceTrim__default["default"]((block) => `
                     ${block(error.message)}
-            
+
                     The JSON text:
                     ${block(value)}
                 `));
         }
     }
-    /**
-     * TODO: !!!! Use in Promptbook.studio
-     */
 
     /**
      * Recursively converts JSON strings to JSON objects
@@ -7212,6 +7217,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 @@@
      *
@@ -7396,6 +7438,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
@@ -10888,6 +10932,7 @@
                 className: 'OpenAiExecutionTools',
                 options: {
                     apiKey: 'sk-',
+                    maxRequestsPerMinute: DEFAULT_RPM,
                 },
             };
         },
@@ -10957,6 +11002,52 @@
      * Note: [💞] Ignore a discrepancy between file name and entity name
      */
 
+    /**
+     * 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`
+     */
+    function migratePipeline(deprecatedPipeline) {
+        /* eslint-disable prefer-const */
+        let { pipelineUrl, sourceFile, title, bookVersion, description, formfactorName, parameters, tasks, knowledgeSources, knowledgePieces, personas, preparations, sources, } = deprecatedPipeline;
+        let isChanged = false;
+        personas = personas.map((persona) => {
+            const migratedPersona = { ...persona }; /* <- TODO: [🌪] */
+            if (migratedPersona.modelRequirements !== undefined) {
+                isChanged = true;
+                migratedPersona.modelsRequirements = [migratedPersona.modelRequirements];
+                delete migratedPersona.modelRequirements;
+            }
+            return migratedPersona;
+        });
+        if (!isChanged) {
+            // Note: If nothing to migrate, return the same pipeline
+            return deprecatedPipeline;
+        }
+        const migratedPipeline = {
+            pipelineUrl,
+            sourceFile,
+            title,
+            bookVersion,
+            description,
+            formfactorName,
+            parameters,
+            tasks,
+            knowledgeSources,
+            knowledgePieces,
+            personas,
+            preparations,
+            sources,
+            // <- TODO: [🍙] Make some standard order of json properties
+        };
+        console.info(`Book automatically migrated`, { deprecatedPipeline, migratedPipeline });
+        // console.info(`Book automatically migrated from ${} -> ${}`, {deprecatedPipeline,migratedPipeline})
+        // <- TODO: Report the versions of the migration, DO not migrate backwards, throw `CompatibilityError` when given newer version than current version of the engine and link the NPM + Docker packages
+        return migratedPipeline;
+    }
+
     /**
      * Function `isValidPipelineString` will validate the if the string is a valid pipeline string
      * It does not check if the string is fully logically correct, but if it is a string that can be a pipeline string or the string looks completely different.
@@ -11406,6 +11497,7 @@
     exports.CallbackInterfaceTools = CallbackInterfaceTools;
     exports.ChatbotFormfactorDefinition = ChatbotFormfactorDefinition;
     exports.CollectionError = CollectionError;
+    exports.CompletionFormfactorDefinition = CompletionFormfactorDefinition;
     exports.CsvFormatError = CsvFormatError;
     exports.CsvFormatParser = CsvFormatParser;
     exports.DEFAULT_BOOKS_DIRNAME = DEFAULT_BOOKS_DIRNAME;
@@ -11425,6 +11517,7 @@
     exports.DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME = DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME;
     exports.DEFAULT_PROMPT_TASK_TITLE = DEFAULT_PROMPT_TASK_TITLE;
     exports.DEFAULT_REMOTE_SERVER_URL = DEFAULT_REMOTE_SERVER_URL;
+    exports.DEFAULT_RPM = DEFAULT_RPM;
     exports.DEFAULT_SCRAPE_CACHE_DIRNAME = DEFAULT_SCRAPE_CACHE_DIRNAME;
     exports.DEFAULT_TASK_TITLE = DEFAULT_TASK_TITLE;
     exports.EXPECTATION_UNITS = EXPECTATION_UNITS;
@@ -11515,6 +11608,7 @@
     exports.joinLlmExecutionTools = joinLlmExecutionTools;
     exports.limitTotalUsage = limitTotalUsage;
     exports.makeKnowledgeSourceHandler = makeKnowledgeSourceHandler;
+    exports.migratePipeline = migratePipeline;
     exports.parsePipeline = parsePipeline;
     exports.pipelineJsonToString = pipelineJsonToString;
     exports.prepareKnowledgePieces = prepareKnowledgePieces;