@promptbook/cli 0.94.0-1 → 0.94.0-2

package/README.md

@@ -114,6 +114,8 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
 
 During the computer revolution, we have seen [multiple generations of computer languages](https://github.com/webgptorg/promptbook/discussions/180), from the physical rewiring of the vacuum tubes through low-level machine code to the high-level languages like Python or JavaScript. And now, we're on the edge of the **next revolution**!
 
+
+
 It's a revolution of writing software in **plain human language** that is understandable and executable by both humans and machines – and it's going to change everything!
 
 The incredible growth in power of microprocessors and the Moore's Law have been the driving force behind the ever-more powerful languages, and it's been an amazing journey! Similarly, the large language models (like GPT or Claude) are the next big thing in language technology, and they're set to transform the way we interact with computers.
@@ -239,16 +241,8 @@ Join our growing community of developers and users:
 
 _A concise, Markdown-based DSL for crafting AI workflows and automations._
 
----
 
-### 📑 Table of Contents
 
--   [Introduction](#introduction)
--   [Example](#example)
--   [1. What: Workflows, Tasks & Parameters](#1-what-workflows-tasks--parameters)
--   [2. Who: Personas](#2-who-personas)
--   [3. How: Knowledge, Instruments & Actions](#3-how-knowledge-instruments-and-actions)
--   [General Principles](#general-principles)
 
 ### Introduction
 
@@ -299,6 +293,8 @@ Personas can have access to different knowledge, tools and actions. They can als
 
 -   [PERSONA](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PERSONA.md)
 
+
+
 ### **3. How:** Knowledge, Instruments and Actions
 
 The resources used by the personas are used to do the work.
@@ -398,6 +394,8 @@ The following glossary is used to clarify certain concepts:
 
 _Note: This section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
 
+
+
 ### 💯 Core concepts
 
 -   [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)

package/esm/index.es.js

@@ -28,7 +28,6 @@ import swaggerUi from 'swagger-ui-express';
 import Anthropic from '@anthropic-ai/sdk';
 import Bottleneck from 'bottleneck';
 import { OpenAIClient, AzureKeyCredential } from '@azure/openai';
-import fetch$1 from 'node-fetch';
 import OpenAI from 'openai';
 import { Readability } from '@mozilla/readability';
 import { JSDOM } from 'jsdom';
@@ -48,7 +47,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.94.0-1';
+const PROMPTBOOK_ENGINE_VERSION = '0.94.0-2';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -17014,7 +17013,7 @@ const _OllamaMetadataRegistration = $llmToolsMetadataRegister.register({
             packageName: '@promptbook/ollama',
             className: 'OllamaExecutionTools',
             options: {
-                baseUrl: 'http://localhost:11434',
+                baseURL: 'http://localhost:11434',
                 model: 'llama2',
                 maxRequestsPerMinute: DEFAULT_MAX_REQUESTS_PER_MINUTE,
             },
@@ -17027,7 +17026,7 @@ const _OllamaMetadataRegistration = $llmToolsMetadataRegister.register({
                 packageName: '@promptbook/ollama',
                 className: 'OllamaExecutionTools',
                 options: {
-                    baseUrl: env.OLLAMA_BASE_URL,
+                    baseURL: env.OLLAMA_BASE_URL,
                     model: env.OLLAMA_MODEL || 'llama2',
                     maxRequestsPerMinute: DEFAULT_MAX_REQUESTS_PER_MINUTE,
                 },
@@ -17040,203 +17039,6 @@ const _OllamaMetadataRegistration = $llmToolsMetadataRegister.register({
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */
 
-/**
- * Execution Tools for calling a local Ollama model via HTTP API
- *
- * @public exported from `@promptbook/ollama`
- */
-class OllamaExecutionTools {
-    constructor(options) {
-        this.options = options;
-        this.limiter = new Bottleneck({
-            minTime: 60000 / (options.maxRequestsPerMinute || DEFAULT_MAX_REQUESTS_PER_MINUTE),
-        });
-    }
-    get title() {
-        return 'Ollama';
-    }
-    get description() {
-        return 'Local Ollama LLM via HTTP';
-    }
-    async checkConfiguration() {
-        const res = await fetch$1(`${this.options.baseUrl}/models`);
-        if (!res.ok)
-            throw new UnexpectedError(`Failed to reach Ollama API at ${this.options.baseUrl}`);
-    }
-    async listModels() {
-        const res = await fetch$1(`${this.options.baseUrl}/models`);
-        if (!res.ok)
-            throw new UnexpectedError(`Error listing Ollama models: ${res.statusText}`);
-        const data = (await res.json());
-        return data.map((m) => ({ modelName: m.name, modelVariant: 'CHAT' }));
-    }
-    async callChatModel(prompt) {
-        const { content, parameters, modelRequirements } = prompt;
-        if (modelRequirements.modelVariant !== 'CHAT') {
-            throw new PipelineExecutionError('Use callChatModel only for CHAT variant');
-        }
-        const modelName = modelRequirements.modelName || this.options.model;
-        const body = {
-            model: modelName,
-            messages: [
-                ...(modelRequirements.systemMessage
-                    ? [{ role: 'system', content: modelRequirements.systemMessage }]
-                    : []),
-                { role: 'user', content: content },
-            ],
-            parameters: parameters,
-        };
-        const start = $getCurrentDate();
-        const res = await this.limiter.schedule(() => fetch$1(`${this.options.baseUrl}/chat/completions`, {
-            method: 'POST',
-            headers: { 'Content-Type': 'application/json' },
-            body: JSON.stringify(body),
-        }));
-        if (!res.ok)
-            throw new PipelineExecutionError(`Ollama API error: ${res.statusText}`);
-        const json = await res.json();
-        const complete = $getCurrentDate();
-        if (!json.choices || !json.choices[0]) {
-            throw new PipelineExecutionError('No choices from Ollama');
-        }
-        const resultContent = json.choices[0].message.content;
-        const usage = { price: { value: 0, isUncertain: true }, input: {}, output: {} }; /* <- !!! */
-        return exportJson({
-            name: 'promptResult',
-            message: 'Result of Ollama',
-            order: [],
-            value: {
-                content: resultContent,
-                modelName,
-                timing: { start, complete },
-                usage,
-                rawPromptContent: content,
-                rawRequest: body,
-                rawResponse: json,
-            },
-        });
-    }
-}
-
-/**
- * Execution Tools for calling Ollama API
- *
- * @public exported from `@promptbook/ollama`
- */
-const createOllamaExecutionTools = Object.assign((options) => new OllamaExecutionTools(options), {
-    packageName: '@promptbook/ollama',
-    className: 'OllamaExecutionTools',
-});
-
-/**
- * Registration of LLM provider
- *
- * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
- *
- * @public exported from `@promptbook/ollama`
- * @public exported from `@promptbook/wizzard`
- * @public exported from `@promptbook/cli`
- */
-const _OllamaRegistration = $llmToolsRegister.register(createOllamaExecutionTools);
-/**
- * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */
-
-/**
- * Registration of LLM provider metadata
- *
- * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
- *
- * @public exported from `@promptbook/core`
- * @public exported from `@promptbook/wizzard`
- * @public exported from `@promptbook/cli`
- */
-const _OpenAiMetadataRegistration = $llmToolsMetadataRegister.register({
-    title: 'Open AI',
-    packageName: '@promptbook/openai',
-    className: 'OpenAiExecutionTools',
-    envVariables: ['OPENAI_API_KEY'],
-    trustLevel: 'CLOSED',
-    order: MODEL_ORDERS.TOP_TIER,
-    getBoilerplateConfiguration() {
-        return {
-            title: 'Open AI',
-            packageName: '@promptbook/openai',
-            className: 'OpenAiExecutionTools',
-            options: {
-                apiKey: 'sk-',
-                maxRequestsPerMinute: DEFAULT_MAX_REQUESTS_PER_MINUTE,
-            },
-        };
-    },
-    createConfigurationFromEnv(env) {
-        // Note: Note using `process.env` BUT `env` to pass in the environment variables dynamically
-        if (typeof env.OPENAI_API_KEY === 'string') {
-            return {
-                title: 'Open AI (from env)',
-                packageName: '@promptbook/openai',
-                className: 'OpenAiExecutionTools',
-                options: {
-                    apiKey: env.OPENAI_API_KEY,
-                },
-            };
-        }
-        return null;
-    },
-});
-/**
- * Registration of the OpenAI Assistant metadata
- *
- * Note: [🏐] Configurations registrations are done in the metadata registration section, but the constructor registration is handled separately.
- *
- * @public exported from `@promptbook/core`
- * @public exported from `@promptbook/wizzard`
- * @public exported from `@promptbook/cli`
- */
-const _OpenAiAssistantMetadataRegistration = $llmToolsMetadataRegister.register({
-    title: 'Open AI Assistant',
-    packageName: '@promptbook/openai',
-    className: 'OpenAiAssistantExecutionTools',
-    envVariables: null,
-    //            <- TODO: ['OPENAI_API_KEY', 'OPENAI_ASSISTANT_ID']
-    trustLevel: 'CLOSED',
-    order: MODEL_ORDERS.NORMAL,
-    getBoilerplateConfiguration() {
-        return {
-            title: 'Open AI Assistant',
-            packageName: '@promptbook/openai',
-            className: 'OpenAiAssistantExecutionTools',
-            options: {
-                apiKey: 'sk-',
-                assistantId: 'asst_',
-                maxRequestsPerMinute: DEFAULT_MAX_REQUESTS_PER_MINUTE,
-            },
-        };
-    },
-    createConfigurationFromEnv(env) {
-        return null;
-        /*
-        if (typeof env.OPENAI_API_KEY === 'string' || typeof env.OPENAI_XXX === 'string') {
-            return {
-                title: 'Open AI Assistant (from env)',
-                packageName: '@promptbook/openai',
-                className: 'OpenAiAssistantExecutionTools',
-                options: {
-                    apiKey: env.OPENAI_API_KEY!,
-                    assistantId: env.OPENAI_XXX!
-                },
-            };
-        }
-
-        return null;
-        */
-    },
-});
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */
-
 /**
  * Computes the usage of the OpenAI API based on the response from OpenAI
  *
@@ -17349,7 +17151,7 @@ class OpenAiExecutionTools {
     /**
      * List all available OpenAI models that can be used
      */
-    listModels() {
+    async listModels() {
         /*
         Note: Dynamic lising of the models
         const models = await this.openai.models.list({});
@@ -17357,7 +17159,26 @@ class OpenAiExecutionTools {
         console.log({ models });
         console.log(models.data);
         */
-        return OPENAI_MODELS;
+        const client = await this.getClient();
+        const rawModelsList = await client.models.list();
+        const availableModels = rawModelsList.data
+            .sort((a, b) => (a.created > b.created ? 1 : -1))
+            .map((modelFromApi) => {
+            // TODO: !!!! What about other model compatibilities?
+            const modelFromList = OPENAI_MODELS.find(({ modelName }) => modelName === modelFromApi.id ||
+                modelName.startsWith(modelFromApi.id) ||
+                modelFromApi.id.startsWith(modelName));
+            if (modelFromList !== undefined) {
+                return modelFromList;
+            }
+            return {
+                modelVariant: 'CHAT',
+                modelTitle: modelFromApi.id,
+                modelName: modelFromApi.id,
+                modelDescription: '',
+            };
+        });
+        return availableModels;
     }
     /**
      * Calls OpenAI API to use a chat model.
@@ -17637,6 +17458,163 @@ class OpenAiExecutionTools {
  * TODO: [🧠][🌰] Allow to pass `title` for tracking purposes
  */
 
+/**
+ * Execution Tools for calling OpenAI API
+ *
+ * Note: This can be also used for other OpenAI compatible APIs, like Ollama
+ *
+ * @public exported from `@promptbook/openai`
+ */
+const createOpenAiExecutionTools = Object.assign((options) => {
+    // TODO: [🧠][main] !!4 If browser, auto add `dangerouslyAllowBrowser`
+    if (($isRunningInBrowser() || $isRunningInWebWorker()) && !options.dangerouslyAllowBrowser) {
+        options = { ...options, dangerouslyAllowBrowser: true };
+    }
+    return new OpenAiExecutionTools(options);
+}, {
+    packageName: '@promptbook/openai',
+    className: 'OpenAiExecutionTools',
+});
+/**
+ * TODO: [🦺] Is there some way how to put `packageName` and `className` on top and function definition on bottom?
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */
+
+/**
+ * Default base URL for Ollama API
+ *
+ * @public exported from `@promptbook/ollama`
+ */
+const DEFAULT_OLLAMA_BASE_URL = 'http://localhost:11434'; // <- TODO: !!!! What is the correct base URL? /v1?
+
+/**
+ * Execution Tools for calling Ollama API
+ *
+ * @public exported from `@promptbook/ollama`
+ */
+const createOllamaExecutionTools = Object.assign((ollamaOptions) => {
+    const openAiCompatibleOptions = {
+        baseURL: DEFAULT_OLLAMA_BASE_URL,
+        ...ollamaOptions,
+        userId: 'ollama',
+    };
+    // TODO: !!!! Listing the models - do it dynamically in OpenAiExecutionTools
+    // TODO: !!!! Do not allow to create Assistant from OpenAi compatible tools
+    return createOpenAiExecutionTools(openAiCompatibleOptions);
+}, {
+    packageName: '@promptbook/ollama',
+    className: 'OllamaExecutionTools',
+});
+
+/**
+ * Registration of LLM provider
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
+ *
+ * @public exported from `@promptbook/ollama`
+ * @public exported from `@promptbook/wizzard`
+ * @public exported from `@promptbook/cli`
+ */
+const _OllamaRegistration = $llmToolsRegister.register(createOllamaExecutionTools);
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */
+
+/**
+ * Registration of LLM provider metadata
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
+ *
+ * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizzard`
+ * @public exported from `@promptbook/cli`
+ */
+const _OpenAiMetadataRegistration = $llmToolsMetadataRegister.register({
+    title: 'Open AI',
+    packageName: '@promptbook/openai',
+    className: 'OpenAiExecutionTools',
+    envVariables: ['OPENAI_API_KEY'],
+    trustLevel: 'CLOSED',
+    order: MODEL_ORDERS.TOP_TIER,
+    getBoilerplateConfiguration() {
+        return {
+            title: 'Open AI',
+            packageName: '@promptbook/openai',
+            className: 'OpenAiExecutionTools',
+            options: {
+                apiKey: 'sk-',
+                maxRequestsPerMinute: DEFAULT_MAX_REQUESTS_PER_MINUTE,
+            },
+        };
+    },
+    createConfigurationFromEnv(env) {
+        // Note: Note using `process.env` BUT `env` to pass in the environment variables dynamically
+        if (typeof env.OPENAI_API_KEY === 'string') {
+            return {
+                title: 'Open AI (from env)',
+                packageName: '@promptbook/openai',
+                className: 'OpenAiExecutionTools',
+                options: {
+                    apiKey: env.OPENAI_API_KEY,
+                },
+            };
+        }
+        return null;
+    },
+});
+/**
+ * Registration of the OpenAI Assistant metadata
+ *
+ * Note: [🏐] Configurations registrations are done in the metadata registration section, but the constructor registration is handled separately.
+ *
+ * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizzard`
+ * @public exported from `@promptbook/cli`
+ */
+const _OpenAiAssistantMetadataRegistration = $llmToolsMetadataRegister.register({
+    title: 'Open AI Assistant',
+    packageName: '@promptbook/openai',
+    className: 'OpenAiAssistantExecutionTools',
+    envVariables: null,
+    //            <- TODO: ['OPENAI_API_KEY', 'OPENAI_ASSISTANT_ID']
+    trustLevel: 'CLOSED',
+    order: MODEL_ORDERS.NORMAL,
+    getBoilerplateConfiguration() {
+        return {
+            title: 'Open AI Assistant',
+            packageName: '@promptbook/openai',
+            className: 'OpenAiAssistantExecutionTools',
+            options: {
+                apiKey: 'sk-',
+                assistantId: 'asst_',
+                maxRequestsPerMinute: DEFAULT_MAX_REQUESTS_PER_MINUTE,
+            },
+        };
+    },
+    createConfigurationFromEnv(env) {
+        return null;
+        /*
+        if (typeof env.OPENAI_API_KEY === 'string' || typeof env.OPENAI_XXX === 'string') {
+            return {
+                title: 'Open AI Assistant (from env)',
+                packageName: '@promptbook/openai',
+                className: 'OpenAiAssistantExecutionTools',
+                options: {
+                    apiKey: env.OPENAI_API_KEY!,
+                    assistantId: env.OPENAI_XXX!
+                },
+            };
+        }
+
+        return null;
+        */
+    },
+});
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */
+
 /**
  * Execution Tools for calling OpenAI API Assistants
  *
@@ -17824,26 +17802,6 @@ const createOpenAiAssistantExecutionTools = Object.assign((options) => {
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  */
 
-/**
- * Execution Tools for calling OpenAI API
- *
- * @public exported from `@promptbook/openai`
- */
-const createOpenAiExecutionTools = Object.assign((options) => {
-    // TODO: [🧠][main] !!4 If browser, auto add `dangerouslyAllowBrowser`
-    if (($isRunningInBrowser() || $isRunningInWebWorker()) && !options.dangerouslyAllowBrowser) {
-        options = { ...options, dangerouslyAllowBrowser: true };
-    }
-    return new OpenAiExecutionTools(options);
-}, {
-    packageName: '@promptbook/openai',
-    className: 'OpenAiExecutionTools',
-});
-/**
- * TODO: [🦺] Is there some way how to put `packageName` and `className` on top and function definition on bottom?
- * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
- */
-
 /**
  * Registration of LLM provider
  *