@promptbook/anthropic-claude 0.72.0-8 → 0.72.0

package/README.md

@@ -2,7 +2,7 @@
 
 # ![Promptbook logo - cube with letters P and B](./other/design/logo-h1.png) Promptbook
 
-Supercharge your use of large language models
+Build responsible, controlled and transparent applications on top of LLM models!
 
 
 
@@ -20,10 +20,6 @@ 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/anthropic-claude`
@@ -47,31 +43,37 @@ npm install @promptbook/anthropic-claude
 
 ```typescript
 import { createPipelineExecutor, createCollectionFromDirectory, assertsExecutionSuccessful } from '@promptbook/core';
-import { createCollectionFromDirectory } from '@promptbook/node';
+import {
+    createCollectionFromDirectory,
+    $provideExecutionToolsForNode,
+    $provideFilesystemForNode,
+} from '@promptbook/node';
 import { JavascriptExecutionTools } from '@promptbook/execute-javascript';
 import { AnthropicClaudeExecutionTools } from '@promptbook/anthropic-claude';
 
+// ▶ Prepare tools
+const fs = $provideFilesystemForNode();
+const llm = new AnthropicClaudeExecutionTools(
+    //            <- TODO: [🧱] Implement in a functional (not new Class) way
+    {
+        isVerbose: true,
+        apiKey: process.env.ANTHROPIC_CLAUDE_API_KEY,
+    },
+);
+const executables = await $provideExecutablesForNode();
+const tools = {
+    llm,
+    fs,
+    scrapers: await $provideScrapersForNode({ fs, llm, executables }),
+    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 AnthropicClaudeExecutionTools(
-        //            <- TODO: [🧱] Implement in a functional (not new Class) way
-        {
-            isVerbose: true,
-            apiKey: process.env.ANTHROPIC_CLAUDE_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 });
 
@@ -91,29 +93,23 @@ console.info(outputParameters);
 
 ## 🧙‍♂️ Connect to LLM providers automatically
 
-You can just use `createLlmToolsFromEnv` function to create LLM tools from environment variables like `ANTHROPIC_CLAUDE_API_KEY` and `OPENAI_API_KEY` automatically.
+You can just use `$provideExecutionToolsForNode` function to create all required tools from environment variables like `ANTHROPIC_CLAUDE_API_KEY` and `OPENAI_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';
+import { $provideFilesystemForNode } 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 });
 
@@ -137,47 +133,51 @@ You can use multiple LLM providers in one Promptbook execution. The best model w
 
 ```typescript
 import { createPipelineExecutor, createCollectionFromDirectory, assertsExecutionSuccessful } from '@promptbook/core';
+import { $provideExecutionToolsForNode } from '@promptbook/node';
+import { $provideFilesystemForNode } from '@promptbook/node';
 import { JavascriptExecutionTools } from '@promptbook/execute-javascript';
 import { OpenAiExecutionTools } from '@promptbook/openai';
 
+// ▶ Prepare multiple tools
+const fs = $provideFilesystemForNode();
+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 AnthropicClaudeExecutionTools(
+        //            <- TODO: [🧱] Implement in a functional (not new Class) way
+        {
+            apiKey: process.env.ANTHROPIC_CLAUDE_API_KEY,
+        },
+    ),
+    new OpenAiExecutionTools(
+        //            <- TODO: [🧱] Implement in a functional (not new Class) way
+        {
+            apiKey: process.env.OPENAI_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 executables = await $provideExecutablesForNode();
+const tools = {
+    llm,
+    fs,
+    scrapers: await $provideScrapersForNode({ fs, llm, executables }),
+    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 AnthropicClaudeExecutionTools(
-            //            <- TODO: [🧱] Implement in a functional (not new Class) way
-            {
-                apiKey: process.env.ANTHROPIC_CLAUDE_API_KEY,
-            },
-        ),
-        new OpenAiExecutionTools(
-            //            <- TODO: [🧱] Implement in a functional (not new Class) way
-            {
-                apiKey: process.env.OPENAI_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 });
 
@@ -213,15 +213,15 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
 
 
 
-If you have a simple, single prompt for ChatGPT, GPT-4, Anthropic Claude, Google Gemini, Llama 2, or whatever, it doesn't matter how you integrate it. Whether it's calling a REST API directly, using the SDK, hardcoding the prompt into the source code, or importing a text file, the process remains the same.
+If you have a simple, single prompt for ChatGPT, GPT-4, Anthropic Claude, Google Gemini, Llama 3, or whatever, it doesn't matter how you integrate it. Whether it's calling a REST API directly, using the SDK, hardcoding the prompt into the source code, or importing a text file, the process remains the same.
 
-But often you will struggle with the limitations of LLMs, such as hallucinations, off-topic responses, poor quality output, language drift, word repetition repetition repetition repetition or misuse, lack of context, or just plain w𝒆𝐢rd responses. When this happens, you generally have three options:
+But often you will struggle with the **limitations of LLMs**, such as **hallucinations, off-topic responses, poor quality output, language and prompt drift, word repetition repetition repetition repetition or misuse, lack of context, or just plain w𝒆𝐢rd responses**. When this happens, you generally have three options:
 
 1. **Fine-tune** the model to your specifications or even train your own.
 2. **Prompt-engineer** the prompt to the best shape you can achieve.
 3. Orchestrate **multiple prompts** in a [pipeline](https://github.com/webgptorg/promptbook/discussions/64) to get the best result.
 
-In all of these situations, but especially in 3., the Promptbook library can make your life easier.
+In all of these situations, but especially in 3., the **✨ Promptbook can make your life waaaaaaaaaay easier**.
 
 -   [**Separates concerns**](https://github.com/webgptorg/promptbook/discussions/32) between prompt-engineer and programmer, between code files and prompt files, and between prompts and their execution logic.
 -   Establishes a [**common format `.ptbk.md`**](https://github.com/webgptorg/promptbook/discussions/85) that can be used to describe your prompt business logic without having to write code or deal with the technicalities of LLMs.
@@ -493,6 +493,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

@@ -7,7 +7,7 @@ import { io } from 'socket.io-client';
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.72.0-7';
+var PROMPTBOOK_VERSION = '0.72.0-34';
 // TODO: [main] !!!! List here all the versions and annotate + put into script
 
 /*! *****************************************************************************
@@ -442,6 +442,7 @@ var LOOP_LIMIT = 1000;
  * @private within the repository - too low-level in comparison with other `MAX_...`
  */
 var CONNECTION_TIMEOUT_MS = 7 * 1000;
+// <- TODO: [⏳] Standartize timeouts, Make DEFAULT_TIMEOUT_MS as global constant
 /**
  * How many times to retry the connections
  *
@@ -1448,6 +1449,7 @@ function deserializeError(error) {
  * @public exported from `@promptbook/remote-client`
  */
 var RemoteLlmExecutionTools = /** @class */ (function () {
+    /* <- TODO: [🍚] `, Destroyable` */
     function RemoteLlmExecutionTools(options) {
         this.options = options;
     }
@@ -1497,12 +1499,16 @@ var RemoteLlmExecutionTools = /** @class */ (function () {
                         if (this.options.isAnonymous) {
                             socket.emit('listModels-request', {
                                 isAnonymous: true,
+                                userId: this.options.userId,
                                 llmToolsConfiguration: this.options.llmToolsConfiguration,
                             } /* <- TODO: [🤛] */);
                         }
                         else {
                             socket.emit('listModels-request', {
                                 isAnonymous: false,
+                                appId: this.options.appId,
+                                userId: this.options.userId,
+                                customOptions: this.options.customOptions,
                             } /* <- TODO: [🤛] */);
                         }
                         return [4 /*yield*/, new Promise(function (resolve, reject) {
@@ -1528,9 +1534,7 @@ var RemoteLlmExecutionTools = /** @class */ (function () {
      */
     RemoteLlmExecutionTools.prototype.makeConnection = function () {
         var _this = this;
-        return new Promise(
-        //            <- TODO: [🧱] Implement in a functional (not new Class) way
-        function (resolve, reject) {
+        return new Promise(function (resolve, reject) {
             var socket = io(_this.options.remoteUrl, {
                 retries: CONNECTION_RETRIES_LIMIT,
                 timeout: CONNECTION_TIMEOUT_MS,
@@ -1598,7 +1602,9 @@ var RemoteLlmExecutionTools = /** @class */ (function () {
                         else {
                             socket.emit('prompt-request', {
                                 isAnonymous: false,
+                                appId: this.options.appId,
                                 userId: this.options.userId,
+                                customOptions: this.options.customOptions,
                                 prompt: prompt,
                             } /* <- TODO: [🤛] */);
                         }
@@ -1638,7 +1644,7 @@ var RemoteLlmExecutionTools = /** @class */ (function () {
  */
 var createAnthropicClaudeExecutionTools = Object.assign(function (options) {
     if (options.isProxied) {
-        return new RemoteLlmExecutionTools(__assign(__assign({}, options), { isAnonymous: true, llmToolsConfiguration: [
+        return new RemoteLlmExecutionTools(__assign(__assign({}, options), { userId: null, isAnonymous: true, llmToolsConfiguration: [
                 {
                     title: 'Anthropic Claude (proxied)',
                     packageName: '@promptbook/anthropic-claude',
@@ -1671,6 +1677,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 @@@
  *
@@ -1679,9 +1764,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] = [];
@@ -1692,11 +1777,10 @@ var $Register = /** @class */ (function () {
         this.storage = globalScope[storageName];
     }
     $Register.prototype.list = function () {
-        // <- TODO: ReadonlyDeep<Array<TRegistered>>
+        // <- TODO: ReadonlyDeep<ReadonlyArray<TRegistered>>
         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];
@@ -1706,6 +1790,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;
 }());
@@ -1718,11 +1813,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/anthropic-claude`
  * @public exported from `@promptbook/cli`