@promptbook/cli 0.92.0-29 → 0.92.0-30

package/esm/index.es.js

@@ -21,9 +21,9 @@ import { lookup, extension } from 'mime-types';
 import glob from 'glob-promise';
 import moment from 'moment';
 import express from 'express';
+import * as OpenApiValidator from 'express-openapi-validator';
 import http from 'http';
 import { Server } from 'socket.io';
-import * as OpenApiValidator from 'express-openapi-validator';
 import swaggerUi from 'swagger-ui-express';
 import Anthropic from '@anthropic-ai/sdk';
 import { OpenAIClient, AzureKeyCredential } from '@azure/openai';
@@ -47,7 +47,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.92.0-29';
+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
@@ -178,7 +178,6 @@ const BIG_DATASET_TRESHOLD = 50;
  * @public exported from `@promptbook/core`
  */
 const FAILED_VALUE_PLACEHOLDER = '!?';
-// <- TODO: !!!! Use
 /**
  * Warning message for the generated sections and files files
  *
@@ -370,7 +369,7 @@ const DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME = `getPipelineCollection`;
  *
  * @public exported from `@promptbook/core`
  */
-const DEFAULT_RPM$1 = 60;
+const DEFAULT_MAX_REQUESTS_PER_MINUTE = 60;
 /**
  * Indicates whether pipeline logic validation is enabled. When true, the pipeline logic is checked for consistency.
  *
@@ -5612,13 +5611,10 @@ const CsvFormatParser = {
                     if (onProgress) {
                         // Note: Report the CSV with all rows mapped so far
                         /*
-                        !!!!
-                         // Report progress with updated value
-                            const progressData = mappedData.map((row, i) =>
-                              i > index ? { ...row, [outputParameterName]: PENDING_VALUE_PLACEHOLDER } : row,
-                          );
-
-
+                        // TODO: [🛕] Report progress with all the rows including the pending ones
+                          const progressData = mappedData.map((row, i) =>
+                            i > index ? { ...row, [outputParameterName]: PENDING_VALUE_PLACEHOLDER } : row,
+                        );
                         */
                         await onProgress(unparse(mappedData, { ...settings, ...MANDATORY_CSV_SETTINGS }));
                     }
@@ -11463,24 +11459,25 @@ async function compilePipeline(pipelineString, tools, options) {
  */
 function renderPromptbookMermaid(pipelineJson, options) {
     const { linkTask = () => null } = options || {};
-    const MERMAID_PREFIX = 'mermaid_';
-    const KNOWLEDGE_NAME = MERMAID_PREFIX + 'knowledge';
-    const RESERVED_NAME = MERMAID_PREFIX + 'reserved';
+    const MERMAID_PREFIX = 'pipeline_';
+    const MERMAID_KNOWLEDGE_NAME = MERMAID_PREFIX + 'knowledge';
+    const MERMAID_RESERVED_NAME = MERMAID_PREFIX + 'reserved';
+    const MERMAID_INPUT_NAME = MERMAID_PREFIX + 'input';
+    const MERMAID_OUTPUT_NAME = MERMAID_PREFIX + 'output';
     const parameterNameToTaskName = (parameterName) => {
         if (parameterName === 'knowledge') {
-            return KNOWLEDGE_NAME;
-            // <- TODO: !!!! Check that this works
+            return MERMAID_KNOWLEDGE_NAME;
         }
         else if (RESERVED_PARAMETER_NAMES.includes(parameterName)) {
-            return RESERVED_NAME;
+            return MERMAID_RESERVED_NAME;
         }
         const parameter = pipelineJson.parameters.find((parameter) => parameter.name === parameterName);
         if (!parameter) {
             throw new UnexpectedError(`Could not find {${parameterName}}`);
-            // <- TODO: !!6 This causes problems when {knowledge} and other reserved parameters are used
+            // <- TODO: This causes problems when {knowledge} and other reserved parameters are used
         }
         if (parameter.isInput) {
-            return MERMAID_PREFIX + 'input';
+            return MERMAID_INPUT_NAME;
         }
         const task = pipelineJson.tasks.find((task) => task.resultingParameterName === parameterName);
         if (!task) {
@@ -11488,32 +11485,17 @@ function renderPromptbookMermaid(pipelineJson, options) {
         }
         return MERMAID_PREFIX + (task.name || normalizeTo_camelCase('task-' + titleToName(task.title)));
     };
-    const promptbookMermaid = spaceTrim$1((block) => `
-
-            %% 🔮 Tip: Open this on GitHub or in the VSCode website to see the Mermaid graph visually
-
-            flowchart LR
-              subgraph "${pipelineJson.title}"
-
-                  direction TB
-
-                  input((Input)):::input
-                  ${RESERVED_NAME}((Other)):::${RESERVED_NAME}
-                  ${KNOWLEDGE_NAME}((Knowledgebase)):::${KNOWLEDGE_NAME}
-                  ${block(pipelineJson.tasks
+    const inputAndIntermediateParametersMermaid = pipelineJson.tasks
         .flatMap(({ title, dependentParameterNames, resultingParameterName }) => [
         `${parameterNameToTaskName(resultingParameterName)}("${title}")`,
         ...dependentParameterNames.map((dependentParameterName) => `${parameterNameToTaskName(dependentParameterName)}--"{${dependentParameterName}}"-->${parameterNameToTaskName(resultingParameterName)}`),
     ])
-        .join('\n'))}
-
-                  ${block(pipelineJson.parameters
+        .join('\n');
+    const outputParametersMermaid = pipelineJson.parameters
         .filter(({ isOutput }) => isOutput)
-        .map(({ name }) => `${parameterNameToTaskName(name)}--"{${name}}"-->output`)
-        .join('\n'))}
-                  output((Output)):::output
-
-                  ${block(pipelineJson.tasks
+        .map(({ name }) => `${parameterNameToTaskName(name)}--"{${name}}"-->${MERMAID_OUTPUT_NAME}`)
+        .join('\n');
+    const linksMermaid = pipelineJson.tasks
         .map((task) => {
         const link = linkTask(task);
         if (link === null) {
@@ -11524,10 +11506,44 @@ function renderPromptbookMermaid(pipelineJson, options) {
         return `click ${taskName} href "${href}" "${title}";`;
     })
         .filter((line) => line !== '')
-        .join('\n'))}
+        .join('\n');
+    const interactionPointsMermaid = Object.entries({
+        [MERMAID_INPUT_NAME]: 'Input',
+        [MERMAID_OUTPUT_NAME]: 'Output',
+        [MERMAID_RESERVED_NAME]: 'Other',
+        [MERMAID_KNOWLEDGE_NAME]: 'Knowledge',
+    })
+        .filter(([MERMAID_NAME]) => (inputAndIntermediateParametersMermaid + outputParametersMermaid).includes(MERMAID_NAME))
+        .map(([MERMAID_NAME, title]) => `${MERMAID_NAME}((${title})):::${MERMAID_NAME}`)
+        .join('\n');
+    const promptbookMermaid = spaceTrim$1((block) => `
+
+            %% 🔮 Tip: Open this on GitHub or in the VSCode website to see the Mermaid graph visually
+
+            flowchart LR
+              subgraph "${pipelineJson.title}"
+
+                  %% Basic configuration
+                  direction TB
+
+                  %% Interaction points from pipeline to outside
+                  ${block(interactionPointsMermaid)}
+
+                  %% Input and intermediate parameters
+                  ${block(inputAndIntermediateParametersMermaid)}
+
+
+                  %% Output parameters
+                  ${block(outputParametersMermaid)}
+
+                  %% Links
+                  ${block(linksMermaid)}
 
-                  classDef input color: grey;
-                  classDef output color: grey;
+                  %% Styles
+                  classDef ${MERMAID_INPUT_NAME} color: grey;
+                  classDef ${MERMAID_OUTPUT_NAME} color: grey;
+                  classDef ${MERMAID_RESERVED_NAME} color: grey;
+                  classDef ${MERMAID_KNOWLEDGE_NAME} color: grey;
 
               end;
 
@@ -13611,15 +13627,15 @@ function $initializeRunCommand(program) {
  * TODO: [🖇] What about symlinks? Maybe flag --follow-symlinks
  */
 
-// TODO: !!!! List running services from REMOTE_SERVER_URLS
-// TODO: !!!! Import directly from YML
+// TODO: [🥺] List running services from REMOTE_SERVER_URLS
+// TODO: [🥺] Import directly from YML
 /**
- * @private !!!! Decide how to expose this
+ * @private [🥺] Decide how to expose this
  */
 const openapiJson = {
     openapi: '3.0.0',
     info: {
-        title: 'Promptbook Remote Server API (!!!! From YML)',
+        title: 'Promptbook Remote Server API ([🥺] From YML)',
         version: '1.0.0',
         description: 'API documentation for the Promptbook Remote Server',
     },
@@ -14277,7 +14293,7 @@ function startRemoteServer(options) {
         response.setHeader('X-Powered-By', 'Promptbook engine');
         next();
     });
-    // TODO: !!!! Expose openapiJson to consumer and also allow to add new routes
+    // TODO: [🥺] Expose openapiJson to consumer and also allow to add new routes
     app.use(OpenApiValidator.middleware({
         apiSpec: openapiJson,
         ignorePaths(path) {
@@ -14574,7 +14590,7 @@ function startRemoteServer(options) {
                         promptResult = await llm.callCompletionModel(prompt);
                         break;
                     case 'EMBEDDING':
-                        console.log('!!! llm');
+                        console.log('!!! llm (EMBEDDING)', llm);
                         if (llm.callEmbeddingModel === undefined) {
                             // Note: [0] This check should not be a thing
                             throw new PipelineExecutionError(`Embedding model is not available`);
@@ -16038,9 +16054,6 @@ const OPENAI_MODELS = exportJson({
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */
 
-// Default rate limits (requests per minute) - adjust as needed based on Azure OpenAI tier
-const DEFAULT_RPM = 60;
-// <- TODO: !!! Put in some better place
 /**
  * Execution Tools for calling Azure OpenAI API.
  *
@@ -16060,7 +16073,7 @@ class AzureOpenAiExecutionTools {
         this.client = null;
         // TODO: Allow configuring rate limits via options
         this.limiter = new Bottleneck({
-            minTime: 60000 / (this.options.maxRequestsPerMinute || DEFAULT_RPM),
+            minTime: 60000 / (this.options.maxRequestsPerMinute || DEFAULT_MAX_REQUESTS_PER_MINUTE),
         });
     }
     get title() {
@@ -16976,7 +16989,7 @@ const _OpenAiMetadataRegistration = $llmToolsMetadataRegister.register({
             className: 'OpenAiExecutionTools',
             options: {
                 apiKey: 'sk-',
-                maxRequestsPerMinute: DEFAULT_RPM$1,
+                maxRequestsPerMinute: DEFAULT_MAX_REQUESTS_PER_MINUTE,
             },
         };
     },
@@ -17128,7 +17141,7 @@ class OpenAiExecutionTools {
         this.client = null;
         // TODO: Allow configuring rate limits via options
         this.limiter = new Bottleneck({
-            minTime: 60000 / (this.options.maxRequestsPerMinute || DEFAULT_RPM$1),
+            minTime: 60000 / (this.options.maxRequestsPerMinute || DEFAULT_MAX_REQUESTS_PER_MINUTE),
         });
     }
     get title() {
@@ -17478,7 +17491,7 @@ class OpenAiAssistantExecutionTools extends OpenAiExecutionTools {
     constructor(options) {
         super(options);
         this.assistantId = options.assistantId;
-        // TODO: !!!! Make limiter same as in OpenAiExecutionTools
+        // TODO: [👱] Make limiter same as in `OpenAiExecutionTools`
     }
     get title() {
         return 'OpenAI Assistant';