@promptbook/cli 0.94.0-0 → 0.94.0-2

package/README.md

@@ -241,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
 
@@ -363,6 +355,7 @@ Or you can install them separately:
 -   **[@promptbook/vercel](https://www.npmjs.com/package/@promptbook/vercel)** - Adapter for Vercel functionalities
 -   **[@promptbook/google](https://www.npmjs.com/package/@promptbook/google)** - Integration with Google's Gemini API
 -   **[@promptbook/deepseek](https://www.npmjs.com/package/@promptbook/deepseek)** - Integration with [DeepSeek API](https://www.deepseek.com/)
+-   **[@promptbook/ollama](https://www.npmjs.com/package/@promptbook/ollama)** - Integration with [Ollama](https://ollama.com/) API
 -   **[@promptbook/azure-openai](https://www.npmjs.com/package/@promptbook/azure-openai)** - Execution tools for Azure OpenAI API
 
 -   **[@promptbook/fake-llm](https://www.npmjs.com/package/@promptbook/fake-llm)** - Mocked execution tools for testing the library and saving the tokens

package/esm/index.es.js

@@ -47,7 +47,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.94.0-0';
+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
@@ -6961,11 +6961,6 @@ async function executeTask(options) {
     const jokerParameterNames = currentTask.jokerParameterNames || [];
     const preparedContent = (currentTask.preparedContent || '{content}').split('{content}').join(currentTask.content);
     //    <- TODO: [🍵] Use here `templateParameters` to replace {websiteContent} with option to ignore missing parameters
-    await onProgress({
-        outputParameters: {
-            [currentTask.resultingParameterName]: '',
-        },
-    });
     const resultString = await executeFormatSubvalues({
         jokerParameterNames,
         priority,
@@ -7064,6 +7059,13 @@ async function executePipeline(options) {
      * Note: This is a flag to prevent `onProgress` call after the pipeline execution is finished
      */
     let isReturned = false;
+    // Note: Report all output parameters upfront as empty strings
+    if (onProgress) {
+        const emptyOutputParameters = Object.fromEntries(preparedPipeline.parameters.filter((param) => !param.isInput).map((param) => [param.name, '']));
+        onProgress({
+            outputParameters: emptyOutputParameters,
+        });
+    }
     // Note: Check that all input input parameters are defined
     for (const parameter of preparedPipeline.parameters.filter(({ isInput }) => isInput)) {
         if (inputParameters[parameter.name] === undefined) {
@@ -16998,85 +17000,39 @@ const _GoogleRegistration = $llmToolsRegister.register(createGoogleExecutionTool
  * @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',
+const _OllamaMetadataRegistration = $llmToolsMetadataRegister.register({
+    title: 'Ollama',
+    packageName: '@promptbook/ollama',
+    className: 'OllamaExecutionTools',
+    envVariables: ['OLLAMA_BASE_URL', 'OLLAMA_MODEL'],
+    trustLevel: 'CLOSED_LOCAL',
     order: MODEL_ORDERS.NORMAL,
     getBoilerplateConfiguration() {
         return {
-            title: 'Open AI Assistant',
-            packageName: '@promptbook/openai',
-            className: 'OpenAiAssistantExecutionTools',
+            title: 'Ollama',
+            packageName: '@promptbook/ollama',
+            className: 'OllamaExecutionTools',
             options: {
-                apiKey: 'sk-',
-                assistantId: 'asst_',
+                baseURL: 'http://localhost:11434',
+                model: 'llama2',
                 maxRequestsPerMinute: DEFAULT_MAX_REQUESTS_PER_MINUTE,
             },
         };
     },
     createConfigurationFromEnv(env) {
-        return null;
-        /*
-        if (typeof env.OPENAI_API_KEY === 'string' || typeof env.OPENAI_XXX === 'string') {
+        if (typeof env.OLLAMA_BASE_URL === 'string') {
             return {
-                title: 'Open AI Assistant (from env)',
-                packageName: '@promptbook/openai',
-                className: 'OpenAiAssistantExecutionTools',
+                title: 'Ollama (from env)',
+                packageName: '@promptbook/ollama',
+                className: 'OllamaExecutionTools',
                 options: {
-                    apiKey: env.OPENAI_API_KEY!,
-                    assistantId: env.OPENAI_XXX!
+                    baseURL: env.OLLAMA_BASE_URL,
+                    model: env.OLLAMA_MODEL || 'llama2',
+                    maxRequestsPerMinute: DEFAULT_MAX_REQUESTS_PER_MINUTE,
                 },
             };
         }
-
         return null;
-        */
     },
 });
 /**
@@ -17195,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({});
@@ -17203,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.
@@ -17483,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
  *
@@ -17670,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
  *
@@ -18947,5 +19059,5 @@ const _WebsiteScraperRegistration = $scrapersRegister.register(createWebsiteScra
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */
 
-export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION, _AnthropicClaudeMetadataRegistration, _AnthropicClaudeRegistration, _AzureOpenAiMetadataRegistration, _AzureOpenAiRegistration, _BoilerplateScraperMetadataRegistration, _BoilerplateScraperRegistration, _CLI, _DeepseekMetadataRegistration, _DeepseekRegistration, _DocumentScraperMetadataRegistration, _DocumentScraperRegistration, _GoogleMetadataRegistration, _GoogleRegistration, _LegacyDocumentScraperMetadataRegistration, _LegacyDocumentScraperRegistration, _MarkdownScraperMetadataRegistration, _MarkdownScraperRegistration, _MarkitdownScraperMetadataRegistration, _MarkitdownScraperRegistration, _OpenAiAssistantMetadataRegistration, _OpenAiAssistantRegistration, _OpenAiMetadataRegistration, _OpenAiRegistration, _PdfScraperMetadataRegistration, _PdfScraperRegistration, _WebsiteScraperMetadataRegistration, _WebsiteScraperRegistration };
+export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION, _AnthropicClaudeMetadataRegistration, _AnthropicClaudeRegistration, _AzureOpenAiMetadataRegistration, _AzureOpenAiRegistration, _BoilerplateScraperMetadataRegistration, _BoilerplateScraperRegistration, _CLI, _DeepseekMetadataRegistration, _DeepseekRegistration, _DocumentScraperMetadataRegistration, _DocumentScraperRegistration, _GoogleMetadataRegistration, _GoogleRegistration, _LegacyDocumentScraperMetadataRegistration, _LegacyDocumentScraperRegistration, _MarkdownScraperMetadataRegistration, _MarkdownScraperRegistration, _MarkitdownScraperMetadataRegistration, _MarkitdownScraperRegistration, _OllamaMetadataRegistration, _OllamaRegistration, _OpenAiAssistantMetadataRegistration, _OpenAiAssistantRegistration, _OpenAiMetadataRegistration, _OpenAiRegistration, _PdfScraperMetadataRegistration, _PdfScraperRegistration, _WebsiteScraperMetadataRegistration, _WebsiteScraperRegistration };
 //# sourceMappingURL=index.es.js.map