@promptbook/core 0.104.0-10 → 0.104.0-12

package/umd/index.umd.js

@@ -28,7 +28,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.104.0-10';
+    const PROMPTBOOK_ENGINE_VERSION = '0.104.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
@@ -3764,7 +3764,7 @@
      * TODO: [🧠] Is there some meaningfull way how to test this util
      * TODO: [🧠][🌯] Maybe a way how to hide ability to `get totalUsage`
      *     > const [llmToolsWithUsage,getUsage] = countTotalUsage(llmTools);
-     * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+     * TODO: [👷‍♂️] Write a comprehensive manual explaining the construction and usage of LLM tools in the Promptbook ecosystem
      */
 
     /**
@@ -4004,7 +4004,7 @@
     }
     /**
      * TODO: [🙆] `getSingleLlmExecutionTools` vs `joinLlmExecutionTools` - explain difference or pick one
-     * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+     * TODO: [👷‍♂️] Write a comprehensive manual about how to construct and use LLM execution tools in Promptbook
      */
 
     /**
@@ -4021,7 +4021,7 @@
     }
     /**
      * TODO: [🙆] `getSingleLlmExecutionTools` vs `joinLlmExecutionTools` - explain difference or pick one
-     * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+     * TODO: [👷‍♂️] Write a comprehensive manual about how to construct and use LLM execution tools in Promptbook
      */
 
     /**
@@ -10606,19 +10606,37 @@
         `);
         }
         applyToAgentModelRequirements(requirements, content) {
-            // We simply mark that browser capability is enabled in metadata
-            // Get existing metadata
-            const existingMetadata = requirements.metadata || {};
             // Get existing tools array or create new one
-            const existingTools = existingMetadata.tools || [];
-            // Add 'browser' to tools if not already present
-            const updatedTools = existingTools.includes('browser') ? existingTools : [...existingTools, 'browser'];
-            // Return requirements with updated metadata
+            const existingTools = requirements.tools || [];
+            // Add 'web_browser' to tools if not already present
+            const updatedTools = existingTools.some((tool) => tool.name === 'web_browser')
+                ? existingTools
+                : [
+                    ...existingTools,
+                    {
+                        name: 'web_browser',
+                        description: spaceTrim$1.spaceTrim(`
+                        A tool that can browse the web.
+                        Use this tool when you need to access specific websites or browse the internet.
+                    `),
+                        parameters: {
+                            type: 'object',
+                            properties: {
+                                url: {
+                                    type: 'string',
+                                    description: 'The URL to browse',
+                                },
+                            },
+                            required: ['url'],
+                        },
+                    },
+                ];
+            // Return requirements with updated tools and metadata
             return {
                 ...requirements,
+                tools: updatedTools,
                 metadata: {
-                    ...existingMetadata,
-                    tools: updatedTools,
+                    ...requirements.metadata,
                     useBrowser: true,
                 },
             };
@@ -10711,13 +10729,13 @@
      * The `USE SEARCH ENGINE` commitment indicates that the agent should utilize a search engine tool
      * to access and retrieve up-to-date information from the internet when necessary.
      *
-     * The content following `USE SEARCH ENGINE` is ignored (similar to NOTE).
+     * The content following `USE SEARCH ENGINE` is an arbitrary text that the agent should know (e.g. search scope or instructions).
      *
      * Example usage in agent source:
      *
      * ```book
      * USE SEARCH ENGINE
-     * USE SEARCH ENGINE This will be ignored
+     * USE SEARCH ENGINE Hledej informace o Přemyslovcích
      * ```
      *
      * @private [🪔] Maybe export the commitments through some package
@@ -10749,7 +10767,7 @@
 
             ## Key aspects
 
-            - The content following \`USE SEARCH ENGINE\` is ignored (similar to NOTE)
+            - The content following \`USE SEARCH ENGINE\` is an arbitrary text that the agent should know (e.g. search scope or instructions).
             - The actual search engine tool usage is handled by the agent runtime
             - Allows the agent to search for current information from the web
             - Useful for research tasks, finding facts, and accessing dynamic content
@@ -10774,20 +10792,39 @@
         `);
         }
         applyToAgentModelRequirements(requirements, content) {
-            // We simply mark that search engine capability is enabled in metadata
-            // Get existing metadata
-            const existingMetadata = requirements.metadata || {};
             // Get existing tools array or create new one
-            const existingTools = existingMetadata.tools || [];
-            // Add 'search-engine' to tools if not already present
-            const updatedTools = existingTools.includes('search-engine') ? existingTools : [...existingTools, 'search-engine'];
-            // Return requirements with updated metadata
+            const existingTools = requirements.tools || [];
+            // Add 'web_search' to tools if not already present
+            const updatedTools = existingTools.some((tool) => tool.name === 'web_search')
+                ? existingTools
+                : [
+                    ...existingTools,
+                    {
+                        name: 'web_search',
+                        description: spaceTrim$1.spaceTrim(`
+                        Search the internet for information.
+                        Use this tool when you need to find up-to-date information or facts that you don't know.
+                        ${!content ? '' : `Search scope / instructions: ${content}`}
+                    `),
+                        parameters: {
+                            type: 'object',
+                            properties: {
+                                query: {
+                                    type: 'string',
+                                    description: 'The search query',
+                                },
+                            },
+                            required: ['query'],
+                        },
+                    },
+                ];
+            // Return requirements with updated tools and metadata
             return {
                 ...requirements,
+                tools: updatedTools,
                 metadata: {
-                    ...existingMetadata,
-                    tools: updatedTools,
-                    useSearchEngine: true,
+                    ...requirements.metadata,
+                    useSearchEngine: content || true,
                 },
             };
         }
@@ -11896,7 +11933,57 @@
         }
         const meta = {};
         const links = [];
+        const capabilities = [];
         for (const commitment of parseResult.commitments) {
+            if (commitment.type === 'USE BROWSER') {
+                capabilities.push({
+                    type: 'browser',
+                    label: 'Browser',
+                    iconName: 'Globe',
+                });
+                continue;
+            }
+            if (commitment.type === 'USE SEARCH ENGINE') {
+                capabilities.push({
+                    type: 'search-engine',
+                    label: 'Search Internet',
+                    iconName: 'Search',
+                });
+                continue;
+            }
+            if (commitment.type === 'KNOWLEDGE') {
+                const content = spaceTrim__default["default"](commitment.content).split('\n')[0] || '';
+                let label = content;
+                let iconName = 'Book';
+                if (content.startsWith('http://') || content.startsWith('https://')) {
+                    try {
+                        const url = new URL(content);
+                        if (url.pathname.endsWith('.pdf')) {
+                            label = url.pathname.split('/').pop() || 'Document.pdf';
+                            iconName = 'FileText';
+                        }
+                        else {
+                            label = url.hostname.replace(/^www\./, '');
+                        }
+                    }
+                    catch (e) {
+                        // Invalid URL, treat as text
+                    }
+                }
+                else {
+                    // Text content - take first few words
+                    const words = content.split(/\s+/);
+                    if (words.length > 4) {
+                        label = words.slice(0, 4).join(' ') + '...';
+                    }
+                }
+                capabilities.push({
+                    type: 'knowledge',
+                    label,
+                    iconName,
+                });
+                continue;
+            }
             if (commitment.type === 'META LINK') {
                 const linkValue = spaceTrim__default["default"](commitment.content);
                 links.push(linkValue);
@@ -11907,6 +11994,10 @@
                 meta.image = spaceTrim__default["default"](commitment.content);
                 continue;
             }
+            if (commitment.type === 'META DESCRIPTION') {
+                meta.description = spaceTrim__default["default"](commitment.content);
+                continue;
+            }
             if (commitment.type === 'META COLOR') {
                 meta.color = normalizeSeparator(commitment.content);
                 continue;
@@ -11943,6 +12034,7 @@
             meta,
             links,
             parameters,
+            capabilities,
         };
     }
     /**
@@ -12245,7 +12337,7 @@
             });
         }
         /**
-         * [🐱‍🚀]@@@
+         * Retrieves the permanent ID of an agent by its name or permanent ID.
          */
         async getAgentPermanentId(agentNameOrPermanentId) {
             const selectResult = await this.supabaseClient
@@ -12259,7 +12351,7 @@
             return selectResult.data.permanentId;
         }
         /**
-         * [🐱‍🚀]@@@
+         * Retrieves the source code of an agent by its name or permanent ID.
          */
         async getAgentSource(agentNameOrPermanentId) {
             const selectResult = await this.supabaseClient
@@ -12536,6 +12628,7 @@
         getTableName(tableName) {
             const { tablePrefix = '' } = this.options || {};
             return `${tablePrefix}${tableName}`;
+            // <- TODO: [🏧] DRY
         }
     }
     /**
@@ -17090,7 +17183,7 @@
      * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
      * TODO: [🧠] Is there some meaningfull way how to test this util
      * TODO: [🧠][🌯] Maybe a way how to hide ability to `get totalUsage`
-     * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+     * TODO: [👷‍♂️] Write a comprehensive manual about the construction of LLM tools
      */
 
     /**
@@ -17978,6 +18071,22 @@
      * TODO: [🤝] DRY Maybe some common abstraction between `computeOpenAiUsage` and `computeAnthropicClaudeUsage`
      */
 
+    /**
+     * Maps Promptbook tools to OpenAI tools.
+     *
+     * @private
+     */
+    function mapToolsToOpenAi(tools) {
+        return tools.map((tool) => ({
+            type: 'function',
+            function: {
+                name: tool.name,
+                description: tool.description,
+                parameters: tool.parameters,
+            },
+        }));
+    }
+
     /**
      * Parses an OpenAI error message to identify which parameter is unsupported
      *
@@ -18175,6 +18284,9 @@
                     },
                 ],
                 user: (_a = this.options.userId) === null || _a === void 0 ? void 0 : _a.toString(),
+                tools: currentModelRequirements.tools === undefined
+                    ? undefined
+                    : mapToolsToOpenAi(currentModelRequirements.tools),
             };
             const start = $getCurrentDate();
             if (this.options.isVerbose) {
@@ -18319,6 +18431,7 @@
             const rawPromptContent = templateParameters(content, { ...parameters, modelName });
             const rawRequest = {
                 ...modelSettings,
+                model: modelName,
                 prompt: rawPromptContent,
                 user: (_a = this.options.userId) === null || _a === void 0 ? void 0 : _a.toString(),
             };
@@ -18573,8 +18686,8 @@
             const rawPromptContent = templateParameters(content, { ...parameters, modelName });
             const rawRequest = {
                 ...modelSettings,
-                size: modelSettings.size || '1024x1024',
                 prompt: rawPromptContent,
+                size: modelSettings.size || '1024x1024',
                 user: (_a = this.options.userId) === null || _a === void 0 ? void 0 : _a.toString(),
                 response_format: 'url', // TODO: [🧠] Maybe allow b64_json
             };
@@ -18976,6 +19089,7 @@
                 thread: {
                     messages: threadMessages,
                 },
+                tools: modelRequirements.tools === undefined ? undefined : mapToolsToOpenAi(modelRequirements.tools),
                 // <- TODO: Add user identification here> user: this.options.user,
             };
             const start = $getCurrentDate();
@@ -19499,6 +19613,8 @@
                     modelRequirements: {
                         ...chatPrompt.modelRequirements,
                         ...modelRequirements,
+                        // Spread tools to convert readonly array to mutable
+                        tools: modelRequirements.tools ? [...modelRequirements.tools] : chatPrompt.modelRequirements.tools,
                         // Prepend agent system message to existing system message
                         systemMessage: modelRequirements.systemMessage +
                             (chatPrompt.modelRequirements.systemMessage
@@ -19592,6 +19708,11 @@
              * Links found in the agent source
              */
             this.links = [];
+            /**
+             * Capabilities of the agent
+             * This is parsed from commitments like USE BROWSER, USE SEARCH ENGINE, KNOWLEDGE, etc.
+             */
+            this.capabilities = [];
             /**
              * Metadata like image or color
              */
@@ -19601,11 +19722,12 @@
             this.agentSource = agentSource;
             this.agentSource.subscribe((source) => {
                 this.updateAgentSource(source);
-                const { agentName, personaDescription, initialMessage, links, meta } = parseAgentSource(source);
+                const { agentName, personaDescription, initialMessage, links, meta, capabilities } = parseAgentSource(source);
                 this._agentName = agentName;
                 this.personaDescription = personaDescription;
                 this.initialMessage = initialMessage;
                 this.links = links;
+                this.capabilities = capabilities;
                 this.meta = { ...this.meta, ...meta };
             });
         }
@@ -21176,7 +21298,7 @@
         'Serious and focused AI consultant.',
     ];
     /**
-     * @@@@
+     * Generates a random agent persona description.
      *
      * @private internal helper function
      */