@promptbook/core 0.94.0-0 → 0.94.0-12

package/README.md

@@ -191,16 +191,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
 
@@ -313,6 +305,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

@@ -27,7 +27,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-12';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -4751,11 +4751,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,
@@ -4854,6 +4849,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) {
@@ -10298,7 +10300,10 @@ function usageToWorktime(usage) {
 function usageToHuman(usage) {
     const reportItems = [];
     const uncertainNumberToHuman = ({ value, isUncertain }) => `${isUncertain ? 'approximately ' : ''}${Math.round(value * 100) / 100}`;
-    if (usage.price.value > 0.01
+    if (usage.price.value === 0) {
+        reportItems.push(`Zero cost`);
+    }
+    else if (usage.price.value > 0.01
     // <- TODO: [🍓][🧞‍♂️][👩🏽‍🤝‍🧑🏻] Configure negligible value - default value to config + value to `UsageToHumanSettings`
     ) {
         reportItems.push(`Cost ${uncertainNumberToHuman(usage.price)} USD`);
@@ -10363,12 +10368,12 @@ const BoilerplateFormfactorDefinition = {
  * Creates a wrapper around LlmExecutionTools that only exposes models matching the filter function
  *
  * @param llmTools The original LLM execution tools to wrap
- * @param modelFilter Function that determines whether a model should be included
+ * @param predicate Function that determines whether a model should be included
  * @returns A new LlmExecutionTools instance with filtered models
  *
  * @public exported from `@promptbook/core`
  */
-function filterModels(llmTools, modelFilter) {
+function filterModels(llmTools, predicate) {
     const filteredTools = {
         // Keep all properties from the original llmTools
         ...llmTools,
@@ -10385,10 +10390,10 @@ function filterModels(llmTools, modelFilter) {
             const originalModels = await llmTools.listModels();
             // Handle both synchronous and Promise return types
             if (originalModels instanceof Promise) {
-                return originalModels.then((models) => models.filter(modelFilter));
+                return originalModels.then((models) => models.filter(predicate));
             }
             else {
-                return originalModels.filter(modelFilter);
+                return originalModels.filter(predicate);
             }
         },
     };
@@ -10955,7 +10960,7 @@ const _AzureOpenAiMetadataRegistration = $llmToolsMetadataRegister.register({
             packageName: '@promptbook/azure-openai',
             className: 'AzureOpenAiExecutionTools',
             options: {
-                apiKey: 'sk-',
+                apiKey: '',
                 resourceName: 'my-resource-name',
                 deploymentName: 'my-deployment-name',
                 maxRequestsPerMinute: DEFAULT_MAX_REQUESTS_PER_MINUTE,
@@ -11126,6 +11131,58 @@ const _GoogleMetadataRegistration = $llmToolsMetadataRegister.register({
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */
 
+/**
+ * Default base URL for Ollama API
+ *
+ * @public exported from `@promptbook/ollama`
+ */
+const DEFAULT_OLLAMA_BASE_URL = 'http://localhost:11434/v1';
+
+/**
+ * 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 _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: 'Ollama',
+            packageName: '@promptbook/ollama',
+            className: 'OllamaExecutionTools',
+            options: {
+                baseURL: DEFAULT_OLLAMA_BASE_URL,
+                maxRequestsPerMinute: DEFAULT_MAX_REQUESTS_PER_MINUTE,
+            },
+        };
+    },
+    createConfigurationFromEnv(env) {
+        if (typeof env.OLLAMA_BASE_URL === 'string') {
+            return {
+                title: 'Ollama (from env)',
+                packageName: '@promptbook/ollama',
+                className: 'OllamaExecutionTools',
+                options: {
+                    baseURL: env.OLLAMA_BASE_URL,
+                },
+            };
+        }
+        return null;
+    },
+});
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */
+
 /**
  * Registration of LLM provider metadata
  *
@@ -11208,7 +11265,7 @@ const _OpenAiAssistantMetadataRegistration = $llmToolsMetadataRegister.register(
                 options: {
                     apiKey: env.OPENAI_API_KEY!,
                     assistantId: env.OPENAI_XXX!
-                },
+                } satisfies OpenAiAssistantExecutionToolsOptions,
             };
         }
 
@@ -11698,5 +11755,5 @@ class PrefixStorage {
     }
 }
 
-export { $llmToolsMetadataRegister, $llmToolsRegister, $scrapersMetadataRegister, $scrapersRegister, ADMIN_EMAIL, ADMIN_GITHUB_NAME, AbstractFormatError, AuthenticationError, BIG_DATASET_TRESHOLD, BOOK_LANGUAGE_VERSION, BlackholeStorage, BoilerplateError, BoilerplateFormfactorDefinition, CLAIM, CLI_APP_ID, CallbackInterfaceTools, ChatbotFormfactorDefinition, CollectionError, CompletionFormfactorDefinition, CsvFormatError, CsvFormatParser, DEFAULT_BOOKS_DIRNAME, DEFAULT_BOOK_OUTPUT_PARAMETER_NAME, DEFAULT_BOOK_TITLE, DEFAULT_CSV_SETTINGS, DEFAULT_DOWNLOAD_CACHE_DIRNAME, DEFAULT_EXECUTION_CACHE_DIRNAME, DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME, DEFAULT_INTERMEDIATE_FILES_STRATEGY, DEFAULT_IS_AUTO_INSTALLED, DEFAULT_IS_VERBOSE, DEFAULT_MAX_EXECUTION_ATTEMPTS, DEFAULT_MAX_FILE_SIZE, DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH, DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL, DEFAULT_MAX_PARALLEL_COUNT, DEFAULT_MAX_REQUESTS_PER_MINUTE, DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME, DEFAULT_PROMPT_TASK_TITLE, DEFAULT_REMOTE_SERVER_URL, DEFAULT_SCRAPE_CACHE_DIRNAME, DEFAULT_TASK_TITLE, EXPECTATION_UNITS, EnvironmentMismatchError, ExecutionReportStringOptionsDefaults, ExpectError, FAILED_VALUE_PLACEHOLDER, FORMFACTOR_DEFINITIONS, GENERIC_PIPELINE_INTERFACE, GeneratorFormfactorDefinition, GenericFormfactorDefinition, ImageGeneratorFormfactorDefinition, KnowledgeScrapeError, LimitReachedError, MANDATORY_CSV_SETTINGS, MAX_FILENAME_LENGTH, MODEL_ORDERS, MODEL_TRUST_LEVELS, MODEL_VARIANTS, MatcherFormfactorDefinition, MemoryStorage, MissingToolsError, MultipleLlmExecutionTools, NAME, NonTaskSectionTypes, NotFoundError, NotYetImplementedError, ORDER_OF_PIPELINE_JSON, PENDING_VALUE_PLACEHOLDER, PLAYGROUND_APP_ID, PROMPTBOOK_ENGINE_VERSION, PROMPTBOOK_ERRORS, ParseError, PipelineExecutionError, PipelineLogicError, PipelineUrlError, PrefixStorage, PromptbookFetchError, REMOTE_SERVER_URLS, RESERVED_PARAMETER_NAMES, SET_IS_VERBOSE, SectionTypes, SheetsFormfactorDefinition, TaskTypes, TextFormatParser, TranslatorFormfactorDefinition, UNCERTAIN_USAGE, UNCERTAIN_ZERO_VALUE, UnexpectedError, WrappedError, ZERO_USAGE, ZERO_VALUE, _AnthropicClaudeMetadataRegistration, _AzureOpenAiMetadataRegistration, _BoilerplateScraperMetadataRegistration, _DeepseekMetadataRegistration, _DocumentScraperMetadataRegistration, _GoogleMetadataRegistration, _LegacyDocumentScraperMetadataRegistration, _MarkdownScraperMetadataRegistration, _MarkitdownScraperMetadataRegistration, _OpenAiAssistantMetadataRegistration, _OpenAiMetadataRegistration, _PdfScraperMetadataRegistration, _WebsiteScraperMetadataRegistration, addUsage, book, cacheLlmTools, collectionToJson, compilePipeline, computeCosineSimilarity, countUsage, createCollectionFromJson, createCollectionFromPromise, createCollectionFromUrl, createLlmToolsFromConfiguration, createPipelineExecutor, createSubcollection, embeddingVectorToString, executionReportJsonToString, extractParameterNamesFromTask, filterModels, getPipelineInterface, identificationToPromptbookToken, isPassingExpectations, isPipelineImplementingInterface, isPipelineInterfacesEqual, isPipelinePrepared, isValidPipelineString, joinLlmExecutionTools, limitTotalUsage, makeKnowledgeSourceHandler, migratePipeline, parsePipeline, pipelineJsonToString, prepareKnowledgePieces, preparePersona, preparePipeline, prettifyPipelineString, promptbookFetch, promptbookTokenToIdentification, unpreparePipeline, usageToHuman, usageToWorktime, validatePipeline, validatePipelineString };
+export { $llmToolsMetadataRegister, $llmToolsRegister, $scrapersMetadataRegister, $scrapersRegister, ADMIN_EMAIL, ADMIN_GITHUB_NAME, AbstractFormatError, AuthenticationError, BIG_DATASET_TRESHOLD, BOOK_LANGUAGE_VERSION, BlackholeStorage, BoilerplateError, BoilerplateFormfactorDefinition, CLAIM, CLI_APP_ID, CallbackInterfaceTools, ChatbotFormfactorDefinition, CollectionError, CompletionFormfactorDefinition, CsvFormatError, CsvFormatParser, DEFAULT_BOOKS_DIRNAME, DEFAULT_BOOK_OUTPUT_PARAMETER_NAME, DEFAULT_BOOK_TITLE, DEFAULT_CSV_SETTINGS, DEFAULT_DOWNLOAD_CACHE_DIRNAME, DEFAULT_EXECUTION_CACHE_DIRNAME, DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME, DEFAULT_INTERMEDIATE_FILES_STRATEGY, DEFAULT_IS_AUTO_INSTALLED, DEFAULT_IS_VERBOSE, DEFAULT_MAX_EXECUTION_ATTEMPTS, DEFAULT_MAX_FILE_SIZE, DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH, DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL, DEFAULT_MAX_PARALLEL_COUNT, DEFAULT_MAX_REQUESTS_PER_MINUTE, DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME, DEFAULT_PROMPT_TASK_TITLE, DEFAULT_REMOTE_SERVER_URL, DEFAULT_SCRAPE_CACHE_DIRNAME, DEFAULT_TASK_TITLE, EXPECTATION_UNITS, EnvironmentMismatchError, ExecutionReportStringOptionsDefaults, ExpectError, FAILED_VALUE_PLACEHOLDER, FORMFACTOR_DEFINITIONS, GENERIC_PIPELINE_INTERFACE, GeneratorFormfactorDefinition, GenericFormfactorDefinition, ImageGeneratorFormfactorDefinition, KnowledgeScrapeError, LimitReachedError, MANDATORY_CSV_SETTINGS, MAX_FILENAME_LENGTH, MODEL_ORDERS, MODEL_TRUST_LEVELS, MODEL_VARIANTS, MatcherFormfactorDefinition, MemoryStorage, MissingToolsError, MultipleLlmExecutionTools, NAME, NonTaskSectionTypes, NotFoundError, NotYetImplementedError, ORDER_OF_PIPELINE_JSON, PENDING_VALUE_PLACEHOLDER, PLAYGROUND_APP_ID, PROMPTBOOK_ENGINE_VERSION, PROMPTBOOK_ERRORS, ParseError, PipelineExecutionError, PipelineLogicError, PipelineUrlError, PrefixStorage, PromptbookFetchError, REMOTE_SERVER_URLS, RESERVED_PARAMETER_NAMES, SET_IS_VERBOSE, SectionTypes, SheetsFormfactorDefinition, TaskTypes, TextFormatParser, TranslatorFormfactorDefinition, UNCERTAIN_USAGE, UNCERTAIN_ZERO_VALUE, UnexpectedError, WrappedError, ZERO_USAGE, ZERO_VALUE, _AnthropicClaudeMetadataRegistration, _AzureOpenAiMetadataRegistration, _BoilerplateScraperMetadataRegistration, _DeepseekMetadataRegistration, _DocumentScraperMetadataRegistration, _GoogleMetadataRegistration, _LegacyDocumentScraperMetadataRegistration, _MarkdownScraperMetadataRegistration, _MarkitdownScraperMetadataRegistration, _OllamaMetadataRegistration, _OpenAiAssistantMetadataRegistration, _OpenAiMetadataRegistration, _PdfScraperMetadataRegistration, _WebsiteScraperMetadataRegistration, addUsage, book, cacheLlmTools, collectionToJson, compilePipeline, computeCosineSimilarity, countUsage, createCollectionFromJson, createCollectionFromPromise, createCollectionFromUrl, createLlmToolsFromConfiguration, createPipelineExecutor, createSubcollection, embeddingVectorToString, executionReportJsonToString, extractParameterNamesFromTask, filterModels, getPipelineInterface, identificationToPromptbookToken, isPassingExpectations, isPipelineImplementingInterface, isPipelineInterfacesEqual, isPipelinePrepared, isValidPipelineString, joinLlmExecutionTools, limitTotalUsage, makeKnowledgeSourceHandler, migratePipeline, parsePipeline, pipelineJsonToString, prepareKnowledgePieces, preparePersona, preparePipeline, prettifyPipelineString, promptbookFetch, promptbookTokenToIdentification, unpreparePipeline, usageToHuman, usageToWorktime, validatePipeline, validatePipelineString };
 //# sourceMappingURL=index.es.js.map