@promptbook/core 0.104.0-11 → 0.104.0-13

package/esm/index.es.js

@@ -27,7 +27,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.104.0-11';
+const PROMPTBOOK_ENGINE_VERSION = '0.104.0-13';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -4003,7 +4003,7 @@ function joinLlmExecutionTools(title, ...llmExecutionTools) {
 }
 /**
  * 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
  */
 
 /**
@@ -4020,7 +4020,7 @@ function getSingleLlmExecutionTools(oneOrMoreLlmExecutionTools) {
 }
 /**
  * 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
  */
 
 /**
@@ -8074,9 +8074,7 @@ class DictionaryCommitmentDefinition extends BaseCommitmentDefinition {
         // Get existing dictionary entries from metadata
         const existingDictionary = ((_a = requirements.metadata) === null || _a === void 0 ? void 0 : _a.DICTIONARY) || '';
         // Merge the new dictionary entry with existing entries
-        const mergedDictionary = existingDictionary
-            ? `${existingDictionary}\n${trimmedContent}`
-            : trimmedContent;
+        const mergedDictionary = existingDictionary ? `${existingDictionary}\n${trimmedContent}` : trimmedContent;
         // Store the merged dictionary in metadata for debugging and inspection
         const updatedMetadata = {
             ...requirements.metadata,
@@ -10605,19 +10603,37 @@ class UseBrowserCommitmentDefinition extends BaseCommitmentDefinition {
         `);
     }
     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(`
+                        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,
             },
         };
@@ -10710,13 +10726,13 @@ class UseMcpCommitmentDefinition extends BaseCommitmentDefinition {
  * 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
@@ -10748,7 +10764,7 @@ class UseSearchEngineCommitmentDefinition extends BaseCommitmentDefinition {
 
             ## 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
@@ -10773,20 +10789,39 @@ class UseSearchEngineCommitmentDefinition extends BaseCommitmentDefinition {
         `);
     }
     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(`
+                        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,
             },
         };
     }
@@ -11956,6 +11991,10 @@ function parseAgentSource(agentSource) {
             meta.image = spaceTrim$2(commitment.content);
             continue;
         }
+        if (commitment.type === 'META DESCRIPTION') {
+            meta.description = spaceTrim$2(commitment.content);
+            continue;
+        }
         if (commitment.type === 'META COLOR') {
             meta.color = normalizeSeparator(commitment.content);
             continue;
@@ -14134,7 +14173,12 @@ const jokerCommandParser = {
  * @see {@link ModelVariant}
  * @public exported from `@promptbook/core`
  */
-const MODEL_VARIANTS = ['COMPLETION', 'CHAT', 'IMAGE_GENERATION', 'EMBEDDING' /* <- TODO [🏳] */ /* <- [🤖] */];
+const MODEL_VARIANTS = [
+    'COMPLETION',
+    'CHAT',
+    'IMAGE_GENERATION',
+    'EMBEDDING' /* <- TODO [🏳] */ /* <- [🤖] */,
+];
 
 /**
  * Parses the model command
@@ -17141,7 +17185,7 @@ function limitTotalUsage(llmTools, options = {}) {
  * 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
  */
 
 /**
@@ -18029,6 +18073,22 @@ resultContent, rawResponse) {
  * 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
  *
@@ -18226,6 +18286,9 @@ class OpenAiCompatibleExecutionTools {
                 },
             ],
             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) {
@@ -18370,6 +18433,7 @@ class OpenAiCompatibleExecutionTools {
         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(),
         };
@@ -18624,8 +18688,8 @@ class OpenAiCompatibleExecutionTools {
         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
         };
@@ -19027,6 +19091,7 @@ class OpenAiAssistantExecutionTools extends OpenAiExecutionTools {
             thread: {
                 messages: threadMessages,
             },
+            tools: modelRequirements.tools === undefined ? undefined : mapToolsToOpenAi(modelRequirements.tools),
             // <- TODO: Add user identification here> user: this.options.user,
         };
         const start = $getCurrentDate();
@@ -19550,6 +19615,8 @@ class AgentLlmExecutionTools {
                 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