@promptbook/openai 0.71.0-0 → 0.71.0-13

package/README.md

@@ -20,6 +20,12 @@ Supercharge your use of large language models
 
 -   ✨ **Support of [OpenAI o1 model](https://openai.com/o1/)**
 
+<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/openai`
 
 - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -42,30 +48,30 @@ npm install @promptbook/openai
 ```typescript
 import { createPipelineExecutor, assertsExecutionSuccessful } from '@promptbook/core';
 import { createCollectionFromDirectory } from '@promptbook/node';
+import { $provideExecutionToolsForNode } from '@promptbook/node';
 import { JavascriptExecutionTools } from '@promptbook/execute-javascript';
 import { OpenAiExecutionTools } from '@promptbook/openai';
 
+// ▶ Prepare tools
+const llm = new OpenAiExecutionTools(
+    //            <- TODO: [🧱] Implement in a functional (not new Class) way
+    {
+        isVerbose: true,
+        apiKey: process.env.OPENAI_API_KEY,
+    },
+);
+const tools = {
+    llm,
+    scrapers: await $provideScrapersForNode({ llm }),
+    script: [new JavascriptExecutionTools()],
+};
+
 // ▶ Create whole pipeline collection
-const collection = await createCollectionFromDirectory('./promptbook-collection');
+const collection = await createCollectionFromDirectory('./promptbook-collection', tools);
 
 // ▶ Get single Pipeline
 const pipeline = await collection.getPipelineByUrl(`https://promptbook.studio/my-collection/write-article.ptbk.md`);
 
-// ▶ Prepare tools
-const tools = {
-    llm: new OpenAiExecutionTools(
-        //            <- TODO: [🧱] Implement in a functional (not new Class) way
-        {
-            isVerbose: true,
-            apiKey: process.env.OPENAI_API_KEY,
-        },
-    ),
-    script: [
-        new JavascriptExecutionTools(),
-        //            <- TODO: [🧱] Implement in a functional (not new Class) way
-    ],
-};
-
 // ▶ Create executor - the function that will execute the Pipeline
 const pipelineExecutor = createPipelineExecutor({ pipeline, tools });
 
@@ -85,29 +91,22 @@ console.info(outputParameters);
 
 ## 🧙‍♂️ Connect to LLM providers automatically
 
-You can just use `createLlmToolsFromEnv` function to create LLM tools from environment variables like `OPENAI_API_KEY` and `ANTHROPIC_CLAUDE_API_KEY` automatically.
+You can just use `$provideExecutionToolsForNode` function to create all required tools from environment variables like `OPENAI_API_KEY` and `ANTHROPIC_CLAUDE_API_KEY` automatically.
 
 ```typescript
 import { createPipelineExecutor, createCollectionFromDirectory, assertsExecutionSuccessful } from '@promptbook/core';
 import { JavascriptExecutionTools } from '@promptbook/execute-javascript';
-import { createLlmToolsFromEnv } from '@promptbook/node';
+import { $provideExecutionToolsForNode } from '@promptbook/node';
+
+// ▶ Prepare tools
+const tools = await $provideExecutionToolsForNode();
 
 // ▶ Create whole pipeline collection
-const collection = await createCollectionFromDirectory('./promptbook-collection');
+const collection = await createCollectionFromDirectory('./promptbook-collection', tools);
 
 // ▶ Get single Pipeline
 const pipeline = await collection.getPipelineByUrl(`https://promptbook.studio/my-collection/write-article.ptbk.md`);
 
-// ▶ Prepare multiple tools
-const tools = {
-    // Note: 🧙‍♂️ Just call `createLlmToolsFromEnv` to automatically connect to all configured providers
-    llm: createLlmToolsFromEnv(),
-    script: [
-        new JavascriptExecutionTools(),
-        //            <- TODO: [🧱] Implement in a functional (not new Class) way
-    ],
-};
-
 // ▶ Create executor - the function that will execute the Pipeline
 const pipelineExecutor = createPipelineExecutor({ pipeline, tools });
 
@@ -132,49 +131,49 @@ You can use multiple LLM providers in one Promptbook execution. The best model w
 ```typescript
 import { createPipelineExecutor, assertsExecutionSuccessful } from '@promptbook/core';
 import { createCollectionFromDirectory } from '@promptbook/node';
+import { $provideExecutionToolsForNode } from '@promptbook/node';
 import { JavascriptExecutionTools } from '@promptbook/execute-javascript';
 import { OpenAiExecutionTools } from '@promptbook/openai';
 import { AnthropicClaudeExecutionTools } from '@promptbook/anthropic-claude';
 import { AzureOpenAiExecutionTools } from '@promptbook/azure-openai';
 
+// ▶ Prepare multiple tools
+const llm = [
+    // Note: You can use multiple LLM providers in one Promptbook execution.
+    //       The best model will be chosen automatically according to the prompt and the model's capabilities.
+    new OpenAiExecutionTools(
+        //            <- TODO: [🧱] Implement in a functional (not new Class) way
+        {
+            apiKey: process.env.OPENAI_API_KEY,
+        },
+    ),
+    new AnthropicClaudeExecutionTools(
+        //            <- TODO: [🧱] Implement in a functional (not new Class) way
+        {
+            apiKey: process.env.ANTHROPIC_CLAUDE_API_KEY,
+        },
+    ),
+    new AzureOpenAiExecutionTools(
+        //            <- TODO: [🧱] Implement in a functional (not new Class) way
+        {
+            resourceName: process.env.AZUREOPENAI_RESOURCE_NAME,
+            deploymentName: process.env.AZUREOPENAI_DEPLOYMENT_NAME,
+            apiKey: process.env.AZUREOPENAI_API_KEY,
+        },
+    ),
+];
+const tools = {
+    llm,
+    scrapers: await $provideScrapersForNode({ llm }),
+    script: [new JavascriptExecutionTools()],
+};
+
 // ▶ Create whole pipeline collection
-const collection = await createCollectionFromDirectory('./promptbook-collection');
+const collection = await createCollectionFromDirectory('./promptbook-collection', tools);
 
 // ▶ Get single Pipeline
 const pipeline = await collection.getPipelineByUrl(`https://promptbook.studio/my-collection/write-article.ptbk.md`);
 
-// ▶ Prepare multiple tools
-const tools = {
-    llm: [
-        // Note: You can use multiple LLM providers in one Promptbook execution.
-        //       The best model will be chosen automatically according to the prompt and the model's capabilities.
-        new OpenAiExecutionTools(
-            //            <- TODO: [🧱] Implement in a functional (not new Class) way
-            {
-                apiKey: process.env.OPENAI_API_KEY,
-            },
-        ),
-        new AnthropicClaudeExecutionTools(
-            //            <- TODO: [🧱] Implement in a functional (not new Class) way
-            {
-                apiKey: process.env.ANTHROPIC_CLAUDE_API_KEY,
-            },
-        ),
-        new AzureOpenAiExecutionTools(
-            //            <- TODO: [🧱] Implement in a functional (not new Class) way
-            {
-                resourceName: process.env.AZUREOPENAI_RESOURCE_NAME,
-                deploymentName: process.env.AZUREOPENAI_DEPLOYMENT_NAME,
-                apiKey: process.env.AZUREOPENAI_API_KEY,
-            },
-        ),
-    ],
-    script: [
-        new JavascriptExecutionTools(),
-        //            <- TODO: [🧱] Implement in a functional (not new Class) way
-    ],
-};
-
 // ▶ Create executor - the function that will execute the Pipeline
 const pipelineExecutor = createPipelineExecutor({ pipeline, tools });
 
@@ -490,6 +489,10 @@ Or you can install them separately:
 -   **[@promptbook/fake-llm](https://www.npmjs.com/package/@promptbook/fake-llm)** - Mocked execution tools for testing the library and saving the tokens
 -   **[@promptbook/remote-client](https://www.npmjs.com/package/@promptbook/remote-client)** - Remote client for remote execution of promptbooks
 -   **[@promptbook/remote-server](https://www.npmjs.com/package/@promptbook/remote-server)** - Remote server for remote execution of promptbooks
+-   **[@promptbook/pdf](https://www.npmjs.com/package/@promptbook/pdf)** - Read knowledge from `.pdf` documents
+-   **[@promptbook/documents](https://www.npmjs.com/package/@promptbook/documents)** - Read knowledge from documents like `.docx`, `.odt`,…
+-   **[@promptbook/legacy-documents](https://www.npmjs.com/package/@promptbook/legacy-documents)** - Read knowledge from legacy documents like `.doc`, `.rtf`,…
+-   **[@promptbook/website-crawler](https://www.npmjs.com/package/@promptbook/website-crawler)** - Crawl knowledge from the web
 -   **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
 -   **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
 

package/esm/index.es.js

@@ -6,8 +6,8 @@ import spaceTrim$1, { spaceTrim } from 'spacetrim';
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.70.0-1';
-// TODO:[main] !!!! List here all the versions and annotate + put into script
+var PROMPTBOOK_VERSION = '0.71.0-12';
+// TODO: [main] !!!! List here all the versions and annotate + put into script
 
 /*! *****************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -1209,7 +1209,7 @@ var OPENAI_MODELS = $asDeeplyFrozenSerializableJson('OPENAI_MODELS', [
             prompt: computeUsage("$5.00 / 1M tokens"),
             output: computeUsage("$15.00 / 1M tokens"),
         },
-        //TODO:[main] !!!!!! Add gpt-4o-mini-2024-07-18 and all others to be up to date
+        //TODO: [main] !!! Add gpt-4o-mini-2024-07-18 and all others to be up to date
     },
     /**/
     /**/
@@ -1239,7 +1239,7 @@ var OPENAI_MODELS = $asDeeplyFrozenSerializableJson('OPENAI_MODELS', [
         modelVariant: 'CHAT',
         modelTitle: 'o1-preview-2024-09-12',
         modelName: 'o1-preview-2024-09-12',
-        //             <- TODO:[main] !!!!!! Some better system to organize theese date suffixes and versions
+        //             <- TODO: [main] !!! Some better system to organize theese date suffixes and versions
         pricing: {
             prompt: computeUsage("$15.00 / 1M tokens"),
             output: computeUsage("$60.00 / 1M tokens"),
@@ -1413,6 +1413,7 @@ var OpenAiExecutionTools = /** @class */ (function () {
     OpenAiExecutionTools.prototype.callChatModel = function (prompt) {
         return __awaiter(this, void 0, void 0, function () {
             var content, parameters, modelRequirements, format, client, modelName, modelSettings, rawPromptContent, rawRequest, start, complete, rawResponse, resultContent, usage;
+            var _this = this;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -1459,7 +1460,12 @@ var OpenAiExecutionTools = /** @class */ (function () {
                         if (this.options.isVerbose) {
                             console.info(colors.bgWhite('rawRequest'), JSON.stringify(rawRequest, null, 4));
                         }
-                        return [4 /*yield*/, client.chat.completions.create(rawRequest)];
+                        return [4 /*yield*/, client.chat.completions.create(rawRequest).catch(function (error) {
+                                if (_this.options.isVerbose) {
+                                    console.info(colors.bgRed('error'), error);
+                                }
+                                throw error;
+                            })];
                     case 2:
                         rawResponse = _a.sent();
                         if (this.options.isVerbose) {
@@ -1502,6 +1508,7 @@ var OpenAiExecutionTools = /** @class */ (function () {
     OpenAiExecutionTools.prototype.callCompletionModel = function (prompt) {
         return __awaiter(this, void 0, void 0, function () {
             var content, parameters, modelRequirements, client, modelName, modelSettings, rawPromptContent, rawRequest, start, complete, rawResponse, resultContent, usage;
+            var _this = this;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -1531,7 +1538,12 @@ var OpenAiExecutionTools = /** @class */ (function () {
                         if (this.options.isVerbose) {
                             console.info(colors.bgWhite('rawRequest'), JSON.stringify(rawRequest, null, 4));
                         }
-                        return [4 /*yield*/, client.completions.create(rawRequest)];
+                        return [4 /*yield*/, client.completions.create(rawRequest).catch(function (error) {
+                                if (_this.options.isVerbose) {
+                                    console.info(colors.bgRed('error'), error);
+                                }
+                                throw error;
+                            })];
                     case 2:
                         rawResponse = _a.sent();
                         if (this.options.isVerbose) {
@@ -1571,6 +1583,7 @@ var OpenAiExecutionTools = /** @class */ (function () {
     OpenAiExecutionTools.prototype.callEmbeddingModel = function (prompt) {
         return __awaiter(this, void 0, void 0, function () {
             var content, parameters, modelRequirements, client, modelName, rawPromptContent, rawRequest, start, complete, rawResponse, resultContent, usage;
+            var _this = this;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -1595,7 +1608,12 @@ var OpenAiExecutionTools = /** @class */ (function () {
                         if (this.options.isVerbose) {
                             console.info(colors.bgWhite('rawRequest'), JSON.stringify(rawRequest, null, 4));
                         }
-                        return [4 /*yield*/, client.embeddings.create(rawRequest)];
+                        return [4 /*yield*/, client.embeddings.create(rawRequest).catch(function (error) {
+                                if (_this.options.isVerbose) {
+                                    console.info(colors.bgRed('error'), error);
+                                }
+                                throw error;
+                            })];
                     case 2:
                         rawResponse = _a.sent();
                         if (this.options.isVerbose) {
@@ -1694,6 +1712,22 @@ var createOpenAiExecutionTools = Object.assign(function (options) {
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  */
 
+/**
+ * This error type indicates that some part of the code is not implemented yet
+ *
+ * @public exported from `@promptbook/core`
+ */
+var NotYetImplementedError = /** @class */ (function (_super) {
+    __extends(NotYetImplementedError, _super);
+    function NotYetImplementedError(message) {
+        var _this = _super.call(this, spaceTrim(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: This feature is not implemented yet but it will be soon.\n\n                    If you want speed up the implementation or just read more, look here:\n                    https://github.com/webgptorg/promptbook\n\n                    Or contact us on me@pavolhejny.com\n\n                "); })) || this;
+        _this.name = 'NotYetImplementedError';
+        Object.setPrototypeOf(_this, NotYetImplementedError.prototype);
+        return _this;
+    }
+    return NotYetImplementedError;
+}(Error));
+
 /**
  * @@@
  *
@@ -1705,6 +1739,85 @@ function $getGlobalScope() {
     return Function('return this')();
 }
 
+/**
+ * @@@
+ *
+ * @param text @@@
+ * @returns @@@
+ * @example 'HELLO_WORLD'
+ * @example 'I_LOVE_PROMPTBOOK'
+ * @public exported from `@promptbook/utils`
+ */
+function normalizeTo_SCREAMING_CASE(text) {
+    var e_1, _a;
+    var charType;
+    var lastCharType = 'OTHER';
+    var normalizedName = '';
+    try {
+        for (var text_1 = __values(text), text_1_1 = text_1.next(); !text_1_1.done; text_1_1 = text_1.next()) {
+            var char = text_1_1.value;
+            var normalizedChar = void 0;
+            if (/^[a-z]$/.test(char)) {
+                charType = 'LOWERCASE';
+                normalizedChar = char.toUpperCase();
+            }
+            else if (/^[A-Z]$/.test(char)) {
+                charType = 'UPPERCASE';
+                normalizedChar = char;
+            }
+            else if (/^[0-9]$/.test(char)) {
+                charType = 'NUMBER';
+                normalizedChar = char;
+            }
+            else {
+                charType = 'OTHER';
+                normalizedChar = '_';
+            }
+            if (charType !== lastCharType &&
+                !(lastCharType === 'UPPERCASE' && charType === 'LOWERCASE') &&
+                !(lastCharType === 'NUMBER') &&
+                !(charType === 'NUMBER')) {
+                normalizedName += '_';
+            }
+            normalizedName += normalizedChar;
+            lastCharType = charType;
+        }
+    }
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (text_1_1 && !text_1_1.done && (_a = text_1.return)) _a.call(text_1);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
+    normalizedName = normalizedName.replace(/_+/g, '_');
+    normalizedName = normalizedName.replace(/_?\/_?/g, '/');
+    normalizedName = normalizedName.replace(/^_/, '');
+    normalizedName = normalizedName.replace(/_$/, '');
+    return normalizedName;
+}
+/**
+ * TODO: Tests
+ *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: 'Moje tabule' })).toEqual('/VtG7sR9rRJqwNEdM2/Moje tabule');
+ *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: 'ěščřžžýáíúů' })).toEqual('/VtG7sR9rRJqwNEdM2/escrzyaieuu');
+ *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: '  ahoj  ' })).toEqual('/VtG7sR9rRJqwNEdM2/ahoj');
+ *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: '  ahoj_ahojAhoj    ahoj  ' })).toEqual('/VtG7sR9rRJqwNEdM2/ahoj-ahoj-ahoj-ahoj');
+ * TODO: [🌺] Use some intermediate util splitWords
+ */
+
+/**
+ * @@@
+ *
+ * @param text @@@
+ * @returns @@@
+ * @example 'hello_world'
+ * @example 'i_love_promptbook'
+ * @public exported from `@promptbook/utils`
+ */
+function normalizeTo_snake_case(text) {
+    return normalizeTo_SCREAMING_CASE(text).toLowerCase();
+}
+
 /**
  * Register is @@@
  *
@@ -1713,9 +1826,9 @@ function $getGlobalScope() {
  * @private internal utility, exported are only signleton instances of this class
  */
 var $Register = /** @class */ (function () {
-    function $Register(storageName) {
-        this.storageName = storageName;
-        storageName = "_promptbook_".concat(storageName);
+    function $Register(registerName) {
+        this.registerName = registerName;
+        var storageName = "_promptbook_".concat(normalizeTo_snake_case(registerName));
         var globalScope = $getGlobalScope();
         if (globalScope[storageName] === undefined) {
             globalScope[storageName] = [];
@@ -1730,7 +1843,6 @@ var $Register = /** @class */ (function () {
         return this.storage;
     };
     $Register.prototype.register = function (registered) {
-        //                                    <- TODO: What to return here
         var packageName = registered.packageName, className = registered.className;
         var existingRegistrationIndex = this.storage.findIndex(function (item) { return item.packageName === packageName && item.className === className; });
         var existingRegistration = this.storage[existingRegistrationIndex];
@@ -1740,6 +1852,17 @@ var $Register = /** @class */ (function () {
         else {
             this.storage[existingRegistrationIndex] = registered;
         }
+        return {
+            registerName: this.registerName,
+            packageName: packageName,
+            className: className,
+            get isDestroyed() {
+                return false;
+            },
+            destroy: function () {
+                throw new NotYetImplementedError("Registration to ".concat(this.registerName, " is permanent in this version of Promptbook"));
+            },
+        };
     };
     return $Register;
 }());
@@ -1752,11 +1875,14 @@ var $Register = /** @class */ (function () {
  * @public exported from `@promptbook/core`
  */
 var $llmToolsRegister = new $Register('llm_execution_tools_constructors');
+/**
+ * TODO: [®] DRY Register logic
+ */
 
 /**
- * @@@ registration2
+ * Registration of LLM provider
  *
- * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
+ * 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/openai`
  * @public exported from `@promptbook/cli`