@promptbook/openai 0.103.0-4 → 0.103.0-41

package/README.md

@@ -82,7 +82,7 @@ The package offers three main integration paths:
 ```typescript
 import { createPipelineExecutor } from '@promptbook/core';
 import {
-    createCollectionFromDirectory,
+    createPipelineCollectionFromDirectory,
     $provideExecutionToolsForNode,
     $provideFilesystemForNode,
     $provideScrapersForNode,
@@ -110,7 +110,7 @@ const tools = {
 };
 
 // ▶ Create whole pipeline collection
-const collection = await createCollectionFromDirectory('./books', tools);
+const collection = await createPipelineCollectionFromDirectory('./books', tools);
 
 // ▶ Get single Pipeline
 const pipeline = await collection.getPipelineByUrl(`https://promptbook.studio/my-collection/write-article.book`);
@@ -164,7 +164,7 @@ console.info(joke);
 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 } from '@promptbook/core';
+import { createPipelineExecutor, createPipelineCollectionFromDirectory } from '@promptbook/core';
 import { JavascriptExecutionTools } from '@promptbook/javascript';
 import { $provideExecutionToolsForNode } from '@promptbook/node';
 import { $provideFilesystemForNode } from '@promptbook/node';
@@ -174,7 +174,7 @@ import { $provideFilesystemForNode } from '@promptbook/node';
 const tools = await $provideExecutionToolsForNode();
 
 // ▶ Create whole pipeline collection
-const collection = await createCollectionFromDirectory('./books', tools);
+const collection = await createPipelineCollectionFromDirectory('./books', tools);
 
 // ▶ Get single Pipeline
 const pipeline = await collection.getPipelineByUrl(`https://promptbook.studio/my-collection/write-article.book`);
@@ -202,7 +202,7 @@ You can use multiple LLM providers in one Promptbook execution. The best model w
 ```typescript
 import { createPipelineExecutor } from '@promptbook/core';
 import {
-    createCollectionFromDirectory,
+    createPipelineCollectionFromDirectory,
     $provideExecutionToolsForNode,
     $provideFilesystemForNode,
 } from '@promptbook/node';
@@ -246,7 +246,7 @@ const tools = {
 };
 
 // ▶ Create whole pipeline collection
-const collection = await createCollectionFromDirectory('./books', tools);
+const collection = await createPipelineCollectionFromDirectory('./books', tools);
 
 // ▶ Get single Pipeline
 const pipeline = await collection.getPipelineByUrl(`https://promptbook.studio/my-collection/write-article.book`);
@@ -292,7 +292,7 @@ import { startRemoteServer } from '@promptbook/remote-server';
 // Start the server
 await startRemoteServer({
     port: 3000,
-    collection: await createCollectionFromDirectory('./books'),
+    collection: await createPipelineCollectionFromDirectory('./books'),
     isAnonymousModeAllowed: true,
     isApplicationModeAllowed: true,
 });
@@ -329,8 +329,6 @@ This allows you to:
 -   Integrate Promptbook into existing OpenAI-based applications
 -   Use Promptbook books as models in other AI frameworks
 
-
-
 ## 📦 Exported Entities
 
 ### Version Information
@@ -386,11 +384,15 @@ The main challenge is to narrow it down, constrain it, set the proper **context,
 
 Promptbook takes the best from both worlds. You are defining your AI behavior by simple **books**, which are very explicit. They are automatically enforced, but they are very easy to understand, very easy to write, and very reliable and portable.
 
+<table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
 
-<img
-    alt="Paul Smith & Associés Book"
-    src="https://promptbook.studio/embed/book-preview.png?book=Paul%20Smith%20%26%20Associ%C3%A9s%0A%20%20%20%20%20%20%7C%20PERSONA%20You%20are%20a%20company%20lawyer.%0A%20%20%20%20%20%20%7C%20Your%20job%20is%20to%20provide%20legal%20advice%20and%20support%20to%20the%20company%20and%20its%20employees.%0A%20%20%20%20%20%20%7C%20You%20are%20knowledgeable%2C%20professional%2C%20and%20detail-oriented.&width=800&height=450&nonce=0"
-/>
+**<ins>Paul Smith & Associés</ins>**<br/>
+<br/>
+**PERSONA** You are a company lawyer.<br/>
+Your job is to provide legal advice and support to the company and its employees.<br/>
+You are knowledgeable, professional, and detail-oriented.<br/>
+
+</td></tr></table>
 
 <div style="page-break-after: always;"></div>
 
@@ -404,11 +406,15 @@ You can look at it as prompting (or writing a system message), but decorated by
 
 Personas define the character of your AI persona, its role, and how it should interact with users. It sets the tone and style of communication.
 
+<table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
+
+**<ins>Paul Smith & Associés</ins>**<br/>
+<br/>
+**PERSONA** You are a company lawyer.<br/>
+Your job is to provide legal advice and support to the company and its employees.<br/>
+You are knowledgeable, professional, and detail-oriented.<br/>
 
-<img
-    alt="Paul Smith & Associés Book"
-    src="https://promptbook.studio/embed/book-preview.png?book=Paul%20Smith%20%26%20Associ%C3%A9s%0A%20%20%20%20%20%20%7C%20PERSONA%20You%20are%20a%20company%20lawyer.%0A%20%20%20%20%20%20%7C%20Your%20job%20is%20to%20provide%20legal%20advice%20and%20support%20to%20the%20company%20and%20its%20employees.%0A%20%20%20%20%20%20%7C%20You%20are%20knowledgeable%2C%20professional%2C%20and%20detail-oriented.&width=800&height=450&nonce=0"
-/>
+</td></tr></table>
 
 #### `Knowledge` commitment
 
@@ -418,11 +424,18 @@ This can include domain-specific knowledge, company policies, or any other relev
 
 Promptbook Engine will automatically enforce this knowledge during interactions. When the knowledge is short enough, it will be included in the prompt. When it is too long, it will be stored in vector databases and RAG retrieved when needed. But you don't need to care about it.
 
+<table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
 
-<img
-    alt="Paul Smith & Associés Book"
-    src="https://promptbook.studio/embed/book-preview.png?book=Paul%20Smith%20%26%20Associ%C3%A9s%0A%20%20%20%20%20%20%7C%20PERSONA%20You%20are%20a%20company%20lawyer.%0A%20%20%20%20%20%20%7C%20Your%20job%20is%20to%20provide%20legal%20advice%20and%20support%20to%20the%20company%20and%20its%20employees.%0A%20%20%20%20%20%20%7C%20You%20are%20knowledgeable%2C%20professional%2C%20and%20detail-oriented.%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20%20https%3A%2F%2Fcompany.com%2Fcompany-policies.pdf%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20https%3A%2F%2Fcompany.com%2Finternal-documents%2Femployee-handbook.docx&width=800&height=450&nonce=0"
-/>
+**<ins>Paul Smith & Associés</ins>**<br/>
+<br/>
+**PERSONA** You are a company lawyer.<br/>
+Your job is to provide legal advice and support to the company and its employees.<br/>
+You are knowledgeable, professional, and detail-oriented.<br/>
+<br/>
+**KNOWLEDGE**  https://company.com/company-policies.pdf<br/>
+**KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
+
+</td></tr></table>
 
 #### `Rule` commitment
 
@@ -430,21 +443,42 @@ Rules will enforce specific behaviors or constraints on the AI's responses. This
 
 Depending on rule strictness, Promptbook will either propagate it to the prompt or use other techniques, like adversary agent, to enforce it.
 
+<table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
+
+**<ins>Paul Smith & Associés</ins>**<br/>
+<br/>
+**PERSONA** You are a company lawyer.<br/>
+Your job is to provide legal advice and support to the company and its employees.<br/>
+You are knowledgeable, professional, and detail-oriented.<br/>
+<br/>
+**RULE** Always ensure compliance with laws and regulations.<br/>
+**RULE** Never provide legal advice outside your area of expertise.<br/>
+**RULE** Never provide legal advice about criminal law.<br/>
+**KNOWLEDGE**  https://company.com/company-policies.pdf<br/>
+**KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
 
-<img
-    alt="Paul Smith & Associés Book"
-    src="https://promptbook.studio/embed/book-preview.png?book=Paul%20Smith%20%26%20Associ%C3%A9s%0A%20%20%20%20%20%20%7C%20PERSONA%20You%20are%20a%20company%20lawyer.%0A%20%20%20%20%20%20%7C%20Your%20job%20is%20to%20provide%20legal%20advice%20and%20support%20to%20the%20company%20and%20its%20employees.%0A%20%20%20%20%20%20%7C%20You%20are%20knowledgeable%2C%20professional%2C%20and%20detail-oriented.%0A%20%20%20%20%20%20%7C%20RULE%20Always%20ensure%20compliance%20with%20laws%20and%20regulations.%0A%20%20%20%20%20%20%7C%20RULE%20Never%20provide%20legal%20advice%20outside%20your%20area%20of%20expertise.%0A%20%20%20%20%20%20%7C%20RULE%20Never%20provide%20legal%20advice%20about%20criminal%20law.%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20%20https%3A%2F%2Fcompany.com%2Fcompany-policies.pdf%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20https%3A%2F%2Fcompany.com%2Finternal-documents%2Femployee-handbook.docx&width=800&height=450&nonce=0"
-/>
+</td></tr></table>
 
 #### `Action` commitment
 
 Action Commitment allows you to define specific actions that the AI can take during interactions. This can include things like posting on a social media platform, sending emails, creating calendar events, or interacting with your internal systems.
 
-
-<img
-    alt="Paul Smith & Associés Book"
-    src="https://promptbook.studio/embed/book-preview.png?book=Paul%20Smith%20%26%20Associ%C3%A9s%0A%20%20%20%20%20%20%7C%20PERSONA%20You%20are%20a%20company%20lawyer.%0A%20%20%20%20%20%20%7C%20Your%20job%20is%20to%20provide%20legal%20advice%20and%20support%20to%20the%20company%20and%20its%20employees.%0A%20%20%20%20%20%20%7C%20You%20are%20knowledgeable%2C%20professional%2C%20and%20detail-oriented.%0A%20%20%20%20%20%20%7C%20RULE%20Always%20ensure%20compliance%20with%20laws%20and%20regulations.%0A%20%20%20%20%20%20%7C%20RULE%20Never%20provide%20legal%20advice%20outside%20your%20area%20of%20expertise.%0A%20%20%20%20%20%20%7C%20RULE%20Never%20provide%20legal%20advice%20about%20criminal%20law.%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20%20https%3A%2F%2Fcompany.com%2Fcompany-policies.pdf%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20https%3A%2F%2Fcompany.com%2Finternal-documents%2Femployee-handbook.docx%0A%20%20%20%20%20%20%7C%20ACTION%20When%20a%20user%20asks%20about%20an%20issue%20that%20could%20be%20treated%20as%20a%20crime%2C%20notify%20legal%40company.com.&width=800&height=450&nonce=0"
-/>
+<table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
+
+**<ins>Paul Smith & Associés</ins>**<br/>
+<br/>
+**PERSONA** You are a company lawyer.<br/>
+Your job is to provide legal advice and support to the company and its employees.<br/>
+You are knowledgeable, professional, and detail-oriented.<br/>
+<br/>
+**RULE** Always ensure compliance with laws and regulations.<br/>
+**RULE** Never provide legal advice outside your area of expertise.<br/>
+**RULE** Never provide legal advice about criminal law.<br/>
+**KNOWLEDGE**  https://company.com/company-policies.pdf<br/>
+**KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
+**ACTION** When a user asks about an issue that could be treated as a crime, notify legal@company.com.<br/>
+
+</td></tr></table>
 
 [Read more about the language](./BLUEPRINT.md)
 

package/esm/index.es.js

@@ -1,4 +1,5 @@
 import colors from 'colors';
+import { forEver } from 'waitasecond';
 import spaceTrim$1, { spaceTrim } from 'spacetrim';
 import { randomBytes } from 'crypto';
 import Bottleneck from 'bottleneck';
@@ -19,7 +20,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.103.0-4';
+const PROMPTBOOK_ENGINE_VERSION = '0.103.0-41';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -65,6 +66,19 @@ const $isRunningInWebWorker = new Function(`
  * TODO: [🎺]
  */
 
+/**
+ * This error indicates that promptbook operation is not allowed
+ *
+ * @public exported from `@promptbook/core`
+ */
+class NotAllowed extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'NotAllowed';
+        Object.setPrototypeOf(this, NotAllowed.prototype);
+    }
+}
+
 /**
  * This error type indicates that some part of the code is not implemented yet
  *
@@ -1147,15 +1161,30 @@ const ADMIN_GITHUB_NAME = 'hejny';
  * @public exported from `@promptbook/core`
  */
 const PROMPTBOOK_COLOR = Color.fromHex('#79EAFD');
-// <- TODO: [🧠] Using `Color` here increases the package size approx 3kb, maybe remove it
+// <- TODO: [🧠][🈵] Using `Color` here increases the package size approx 3kb, maybe remove it
+/**
+ * Colors for syntax highlighting in the `<BookEditor/>`
+ *
+ * TODO: [🗽] Unite branding and make single place for it
+ *
+ * @public exported from `@promptbook/core`
+ */
+({
+    TITLE: Color.fromHex('#244EA8'),
+    LINE: Color.fromHex('#eeeeee'),
+    COMMITMENT: Color.fromHex('#DA0F78'),
+    PARAMETER: Color.fromHex('#8e44ad'),
+});
+// <- TODO: [🧠][🈵] Using `Color` here increases the package size approx 3kb, maybe remove it
 /**
- * Dark color of the Promptbook
+ * Chat color of the Promptbook (in chat)
  *
  * TODO: [🗽] Unite branding and make single place for it
  *
  * @public exported from `@promptbook/core`
  */
 PROMPTBOOK_COLOR.then(lighten(0.1)).then(saturate(0.9)).then(grayscale(0.9));
+// <- TODO: [🧠][🈵] Using `Color` and `lighten`, `saturate`,... here increases the package size approx 3kb, maybe remove it
 /**
  * Color of the user (in chat)
  *
@@ -1825,10 +1854,13 @@ const LINES_PER_STANDARD_PAGE = 44;
  * @public exported from `@promptbook/utils`
  */
 function countLines(text) {
+    if (text === '') {
+        return 0;
+    }
     text = text.replace('\r\n', '\n');
     text = text.replace('\r', '\n');
     const lines = text.split('\n');
-    return lines.reduce((count, line) => count + Math.ceil(line.length / CHARACTERS_PER_STANDARD_LINE), 0);
+    return lines.reduce((count, line) => count + Math.max(Math.ceil(line.length / CHARACTERS_PER_STANDARD_LINE), 1), 0);
 }
 /**
  * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
@@ -3595,6 +3627,12 @@ class OpenAiExecutionTools extends OpenAiCompatibleExecutionTools {
  *
  * This is useful for calling OpenAI API with a single assistant, for more wide usage use `OpenAiExecutionTools`.
  *
+ * Note: [🦖] There are several different things in Promptbook:
+ * - `Agent` - which represents an AI Agent with its source, memories, actions, etc. Agent is a higher-level abstraction which is internally using:
+ * - `LlmExecutionTools` - which wraps one or more LLM models and provides an interface to execute them
+ * - `AgentLlmExecutionTools` - which is a specific implementation of `LlmExecutionTools` that wraps another LlmExecutionTools and applies agent-specific system prompts and requirements
+ * - `OpenAiAssistantExecutionTools` - which is a specific implementation of `LlmExecutionTools` for OpenAI models with assistant capabilities, recommended for usage in `Agent` or `AgentLlmExecutionTools`
+ *
  * @public exported from `@promptbook/openai`
  */
 class OpenAiAssistantExecutionTools extends OpenAiExecutionTools {
@@ -3604,11 +3642,18 @@ class OpenAiAssistantExecutionTools extends OpenAiExecutionTools {
      * @param options which are relevant are directly passed to the OpenAI client
      */
     constructor(options) {
+        var _a;
         if (options.isProxied) {
             throw new NotYetImplementedError(`Proxy mode is not yet implemented for OpenAI assistants`);
         }
         super(options);
+        this.isCreatingNewAssistantsAllowed = false;
         this.assistantId = options.assistantId;
+        this.isCreatingNewAssistantsAllowed = (_a = options.isCreatingNewAssistantsAllowed) !== null && _a !== void 0 ? _a : false;
+        if (this.assistantId === null && !this.isCreatingNewAssistantsAllowed) {
+            throw new NotAllowed(`Assistant ID is null and creating new assistants is not allowed - this configuration does not make sense`);
+        }
+        // <- TODO: !!! `OpenAiAssistantExecutionToolsOptions` - Allow `assistantId: null` together with `isCreatingNewAssistantsAllowed: true`
         // TODO: [👱] Make limiter same as in `OpenAiExecutionTools`
     }
     get title() {
@@ -3667,14 +3712,13 @@ class OpenAiAssistantExecutionTools extends OpenAiExecutionTools {
             // TODO: [👨‍👨‍👧‍👧][🧠] What about system message for assistants, does it make sense - combination of OpenAI assistants with Promptbook Personas
             assistant_id: this.assistantId,
             thread: {
-                messages: 'thread' in prompt && Array.isArray(prompt.thread)
+                messages: 'thread' in prompt &&
+                    Array.isArray(prompt.thread)
                     ? prompt.thread.map((msg) => ({
                         role: msg.role === 'assistant' ? 'assistant' : 'user',
                         content: msg.content,
                     }))
-                    : [
-                        { role: 'user', content: rawPromptContent },
-                    ],
+                    : [{ role: 'user', content: rawPromptContent }],
             },
             // <- TODO: Add user identification here> user: this.options.user,
         };
@@ -3754,7 +3798,120 @@ class OpenAiAssistantExecutionTools extends OpenAiExecutionTools {
             },
         });
     }
+    async playground() {
+        const client = await this.getClient();
+        // List all assistants
+        const assistants = await client.beta.assistants.list();
+        console.log('!!! Assistants:', assistants);
+        // Get details of a specific assistant
+        const assistantId = 'asst_MO8fhZf4dGloCfXSHeLcIik0';
+        const assistant = await client.beta.assistants.retrieve(assistantId);
+        console.log('!!! Assistant Details:', assistant);
+        // Update an assistant
+        const updatedAssistant = await client.beta.assistants.update(assistantId, {
+            name: assistant.name + '(M)',
+            description: 'Updated description via Promptbook',
+            metadata: {
+                [Math.random().toString(36).substring(2, 15)]: new Date().toISOString(),
+            },
+        });
+        console.log('!!! Updated Assistant:', updatedAssistant);
+        await forEver();
+    }
+    async createNewAssistant(options) {
+        if (!this.isCreatingNewAssistantsAllowed) {
+            throw new NotAllowed(`Creating new assistants is not allowed. Set \`isCreatingNewAssistantsAllowed: true\` in options to enable this feature.`);
+        }
+        await this.playground();
+        const { name, instructions } = options;
+        const client = await this.getClient();
+        /*
+        TODO: !!!
+        async function downloadFile(url: string, folder = './tmp'): Promise<string> {
+            const filename = path.basename(url.split('?')[0]);
+            const filepath = path.join(folder, filename);
+
+            if (!fs.existsSync(folder)) fs.mkdirSync(folder);
+
+            const res = await fetch(url);
+            if (!res.ok) throw new Error(`Download error: ${url}`);
+            const buffer = await res.arrayBuffer();
+            fs.writeFileSync(filepath, Buffer.from(buffer));
+            console.log(`📥 File downloaded: ${filename}`);
+
+            return filepath;
+        }
+
+        async function uploadFileToOpenAI(filepath: string) {
+            const file = await client.files.create({
+                file: fs.createReadStream(filepath),
+                purpose: 'assistants',
+            });
+            console.log(`⬆️  File uploaded to OpenAI: ${file.filename} (${file.id})`);
+            return file;
+        }
+
+        // 🌐 URL addresses of files to upload
+        const fileUrls = [
+            'https://raw.githubusercontent.com/vercel/next.js/canary/packages/next/README.md',
+            'https://raw.githubusercontent.com/openai/openai-cookbook/main/examples/How_to_call_the_Assistants_API_with_Node.js.ipynb',
+        ];
+
+        // 1️⃣ Download files from URL
+        const localFiles = [];
+        for (const url of fileUrls) {
+            const filepath = await downloadFile(url);
+            localFiles.push(filepath);
+        }
+
+        // 2️⃣ Upload files to OpenAI
+        const uploadedFiles = [];
+        for (const filepath of localFiles) {
+            const file = await uploadFileToOpenAI(filepath);
+            uploadedFiles.push(file.id);
+        }
+        */
+        alert('!!!! Creating new OpenAI assistant');
+        // 3️⃣ Create assistant with uploaded files
+        const assistant = await client.beta.assistants.create({
+            name,
+            description: 'Assistant created via Promptbook',
+            model: 'gpt-4o',
+            instructions,
+            tools: [/* TODO: [🧠] Maybe add { type: 'code_interpreter' }, */ { type: 'file_search' }],
+            // !!!! file_ids: uploadedFiles,
+        });
+        console.log(`✅ Assistant created: ${assistant.id}`);
+        // TODO: !!!! Try listing existing assistants
+        // TODO: !!!! Try marking existing assistants by DISCRIMINANT
+        // TODO: !!!! Allow to update and reconnect to existing assistants
+        return new OpenAiAssistantExecutionTools({
+            ...this.options,
+            isCreatingNewAssistantsAllowed: false,
+            assistantId: assistant.id,
+        });
+    }
+    /**
+     * Discriminant for type guards
+     */
+    get discriminant() {
+        return DISCRIMINANT;
+    }
+    /**
+     * Type guard to check if given `LlmExecutionTools` are instanceof `OpenAiAssistantExecutionTools`
+     *
+     * Note: This is useful when you can possibly have multiple versions of `@promptbook/openai` installed
+     */
+    static isOpenAiAssistantExecutionTools(llmExecutionTools) {
+        return llmExecutionTools.discriminant === DISCRIMINANT;
+    }
 }
+/**
+ * Discriminant for type guards
+ *
+ * @private const of `OpenAiAssistantExecutionTools`
+ */
+const DISCRIMINANT = 'OPEN_AI_ASSISTANT_V1';
 /**
  * TODO: [🧠][🧙‍♂️] Maybe there can be some wizard for those who want to use just OpenAI
  * TODO: Maybe make custom OpenAiError
@@ -3990,6 +4147,7 @@ const PROMPTBOOK_ERRORS = {
     PromptbookFetchError,
     UnexpectedError,
     WrappedError,
+    NotAllowed,
     // TODO: [🪑]> VersionMismatchError,
 };
 /**