@promptbook/cli 0.95.0 → 0.98.0-3

package/README.md

@@ -25,6 +25,10 @@ Write AI applications using plain human language across multiple models and plat
 
 
 
+<blockquote style="color: #ff8811">
+    <b>⚠ Warning:</b> This is a pre-release version of the library. It is not yet ready for production use. Please look at <a href="https://www.npmjs.com/package/@promptbook/core?activeTab=versions">latest stable release</a>.
+</blockquote>
+
 ## 📦 Package `@promptbook/cli`
 
 - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -110,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.
@@ -235,6 +241,8 @@ Join our growing community of developers and users:
 
 _A concise, Markdown-based DSL for crafting AI workflows and automations._
 
+
+
 ### Introduction
 
 Book is a Markdown-based language that simplifies the creation of AI applications, workflows, and automations. With human-readable commands, you can define inputs, outputs, personas, knowledge sources, and actions—without needing model-specific details.
@@ -284,6 +292,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.
@@ -383,6 +393,8 @@ The following glossary is used to clarify certain concepts:
 
 _Note: This section is not a 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

@@ -47,7 +47,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.95.0';
+const PROMPTBOOK_ENGINE_VERSION = '0.98.0-3';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -2838,21 +2838,39 @@ function cacheLlmTools(llmTools, options = {}) {
         }
         // TODO: [🧠] !!5 How to do timing in mixed cache / non-cache situation
         // promptResult.timing: FromtoItems
-        await storage.setItem(key, {
-            date: $getCurrentDate(),
-            promptbookVersion: PROMPTBOOK_ENGINE_VERSION,
-            bookVersion: BOOK_LANGUAGE_VERSION,
-            prompt: {
-                ...prompt,
-                parameters: Object.entries(parameters).length === Object.entries(relevantParameters).length
-                    ? parameters
-                    : {
-                        ...relevantParameters,
-                        note: `<- Note: Only relevant parameters are stored in the cache`,
-                    },
-            },
-            promptResult,
-        });
+        // Check if the result is valid and should be cached
+        // A result is considered failed if:
+        // 1. It has a content property that is null or undefined
+        // 2. It has an error property that is truthy
+        // 3. It has a success property that is explicitly false
+        const isFailedResult = promptResult.content === null ||
+            promptResult.content === undefined ||
+            promptResult.error ||
+            promptResult.success === false;
+        if (!isFailedResult) {
+            await storage.setItem(key, {
+                date: $getCurrentDate(),
+                promptbookVersion: PROMPTBOOK_ENGINE_VERSION,
+                bookVersion: BOOK_LANGUAGE_VERSION,
+                prompt: {
+                    ...prompt,
+                    parameters: Object.entries(parameters).length === Object.entries(relevantParameters).length
+                        ? parameters
+                        : {
+                            ...relevantParameters,
+                            note: `<- Note: Only relevant parameters are stored in the cache`,
+                        },
+                },
+                promptResult,
+            });
+        }
+        else if (isVerbose) {
+            console.info('Not caching failed result for key:', key, {
+                content: promptResult.content,
+                error: promptResult.error,
+                success: promptResult.success,
+            });
+        }
         return promptResult;
     };
     if (llmTools.callChatModel !== undefined) {
@@ -14339,6 +14357,66 @@ function startRemoteServer(options) {
         response.setHeader('X-Powered-By', 'Promptbook engine');
         next();
     });
+    // Note: OpenAI-compatible chat completions endpoint
+    app.post('/v1/chat/completions', async (request, response) => {
+        // TODO: !!!! Make more promptbook-native:
+        try {
+            const params = request.body;
+            const { model, messages } = params;
+            // Convert messages to a single prompt
+            const prompt = messages
+                .map((message) => `${message.role}: ${message.content}`)
+                .join('\n');
+            // Get pipeline for the book
+            if (!collection) {
+                throw new Error('No collection available');
+            }
+            const pipeline = await collection.getPipelineByUrl(model);
+            const pipelineExecutor = createPipelineExecutor({
+                pipeline,
+                tools: await getExecutionToolsFromIdentification({
+                    isAnonymous: true,
+                    llmToolsConfiguration: [],
+                }),
+            });
+            // Execute the pipeline with the prompt content as input
+            const result = await pipelineExecutor({ prompt }).asPromise({ isCrashedOnError: true });
+            if (!result.isSuccessful) {
+                throw new Error(`Failed to execute book: ${result.errors.join(', ')}`);
+            }
+            // Return the result in OpenAI-compatible format
+            response.json({
+                id: 'chatcmpl-' + Math.random().toString(36).substring(2),
+                object: 'chat.completion',
+                created: Math.floor(Date.now() / 1000),
+                model,
+                choices: [
+                    {
+                        index: 0,
+                        message: {
+                            role: 'assistant',
+                            content: result.outputParameters.response,
+                        },
+                        finish_reason: 'stop',
+                    },
+                ],
+                usage: {
+                    prompt_tokens: 0,
+                    completion_tokens: 0,
+                    total_tokens: 0,
+                },
+            });
+        }
+        catch (error) {
+            response.status(500).json({
+                error: {
+                    message: error instanceof Error ? error.message : 'Unknown error',
+                    type: 'server_error',
+                    code: 'internal_error',
+                },
+            });
+        }
+    });
     // TODO: [🥺] Expose openapiJson to consumer and also allow to add new routes
     app.use(OpenApiValidator.middleware({
         apiSpec: openapiJson,
@@ -17966,6 +18044,38 @@ const _OpenAiAssistantMetadataRegistration = $llmToolsMetadataRegister.register(
         */
     },
 });
+/**
+ * Registration of the OpenAI Compatible metadata
+ *
+ * Note: OpenAiCompatibleExecutionTools is an abstract class and cannot be instantiated directly.
+ * It serves as a base class for OpenAiExecutionTools and other compatible implementations.
+ *
+ * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizard`
+ * @public exported from `@promptbook/cli`
+ */
+const _OpenAiCompatibleMetadataRegistration = $llmToolsMetadataRegister.register({
+    title: 'Open AI Compatible',
+    packageName: '@promptbook/openai',
+    className: 'OpenAiCompatibleExecutionTools',
+    envVariables: ['OPENAI_API_KEY'],
+    trustLevel: 'CLOSED',
+    order: MODEL_ORDERS.TOP_TIER,
+    getBoilerplateConfiguration() {
+        return {
+            title: 'Open AI Compatible',
+            packageName: '@promptbook/openai',
+            className: 'OpenAiCompatibleExecutionTools',
+            options: {
+                apiKey: 'sk-',
+                maxRequestsPerMinute: DEFAULT_MAX_REQUESTS_PER_MINUTE,
+            },
+        };
+    },
+    createConfigurationFromEnv(env) {
+        return null;
+    },
+});
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */
@@ -18239,6 +18349,7 @@ const createOpenAiExecutionTools = Object.assign((options) => {
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  */
 
+// Note: OpenAiCompatibleExecutionTools is an abstract class and cannot be instantiated directly
 /**
  * Registration of LLM provider
  *
@@ -18259,6 +18370,10 @@ const _OpenAiRegistration = $llmToolsRegister.register(createOpenAiExecutionTool
  * @public exported from `@promptbook/cli`
  */
 const _OpenAiAssistantRegistration = $llmToolsRegister.register(createOpenAiAssistantExecutionTools);
+/**
+ * Note: OpenAiCompatibleExecutionTools is an abstract class and cannot be registered directly.
+ * It serves as a base class for OpenAiExecutionTools and other compatible implementations.
+ */
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -19496,5 +19611,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, _OllamaMetadataRegistration, _OllamaRegistration, _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, _OpenAiCompatibleMetadataRegistration, _OpenAiMetadataRegistration, _OpenAiRegistration, _PdfScraperMetadataRegistration, _PdfScraperRegistration, _WebsiteScraperMetadataRegistration, _WebsiteScraperRegistration };
 //# sourceMappingURL=index.es.js.map