@promptbook/javascript 0.105.0-10 → 0.105.0-12

package/esm/index.es.js

@@ -18,7 +18,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.105.0-10';
+const PROMPTBOOK_ENGINE_VERSION = '0.105.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
@@ -5576,6 +5576,148 @@ class UseBrowserCommitmentDefinition extends BaseCommitmentDefinition {
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */
 
+/**
+ * USE IMAGE GENERATOR commitment definition
+ *
+ * The `USE IMAGE GENERATOR` commitment indicates that the agent should utilize an image generation tool
+ * to create images based on text prompts.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * USE IMAGE GENERATOR
+ * USE IMAGE GENERATOR Create realistic images of nature
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+class UseImageGeneratorCommitmentDefinition extends BaseCommitmentDefinition {
+    constructor(type = 'USE IMAGE GENERATOR') {
+        super(type, ['USE IMAGE GENERATION', 'IMAGE GENERATOR', 'IMAGE GENERATION', 'USE IMAGE']);
+    }
+    /**
+     * Short one-line description of USE IMAGE GENERATOR.
+     */
+    get description() {
+        return 'Enable the agent to use an image generation tool for creating images from text prompts.';
+    }
+    /**
+     * Icon for this commitment.
+     */
+    get icon() {
+        return '🖼️';
+    }
+    /**
+     * Markdown documentation for USE IMAGE GENERATOR commitment.
+     */
+    get documentation() {
+        return spaceTrim$1(`
+            # USE IMAGE GENERATOR
+
+            Enables the agent to use an image generation tool to create images based on text prompts.
+
+            ## Key aspects
+
+            - The content following \`USE IMAGE GENERATOR\` is an arbitrary text that the agent should know (e.g. style instructions or safety guidelines).
+            - The actual image generation is handled by the agent runtime using LLM execution tools.
+            - Allows the agent to generate visual content based on user requests.
+            - Returns the URL of the generated image.
+
+            ## Examples
+
+            \`\`\`book
+            Visual Artist
+
+            PERSONA You are a creative visual artist who can generate images.
+            USE IMAGE GENERATOR
+            RULE Always describe the generated image to the user.
+            \`\`\`
+
+            \`\`\`book
+            Interior Designer
+
+            PERSONA You are an interior designer who helps users visualize their space.
+            USE IMAGE GENERATOR Professional interior design renders.
+            ACTION Generate a preview of the designed room.
+            \`\`\`
+        `);
+    }
+    applyToAgentModelRequirements(requirements, content) {
+        // Get existing tools array or create new one
+        const existingTools = requirements.tools || [];
+        // Add 'generate_image' to tools if not already present
+        const updatedTools = existingTools.some((tool) => tool.name === 'generate_image')
+            ? existingTools
+            : [
+                ...existingTools,
+                {
+                    name: 'generate_image',
+                    description: spaceTrim$1(`
+                        Generate an image from a text prompt.
+                        Use this tool when the user asks to create, draw, or generate an image.
+                        ${!content ? '' : `Style instructions / guidelines: ${content}`}
+                    `),
+                    parameters: {
+                        type: 'object',
+                        properties: {
+                            prompt: {
+                                type: 'string',
+                                description: 'The detailed description of the image to generate',
+                            },
+                        },
+                        required: ['prompt'],
+                    },
+                },
+            ];
+        // Return requirements with updated tools and metadata
+        return this.appendToSystemMessage({
+            ...requirements,
+            tools: updatedTools,
+            metadata: {
+                ...requirements.metadata,
+                useImageGenerator: content || true,
+            },
+        }, spaceTrim$1(`
+                You have access to an image generator. Use it to create images based on user requests.
+                When you generate an image, you will receive a URL of the generated image.
+            `));
+    }
+    /**
+     * Gets human-readable titles for tool functions provided by this commitment.
+     */
+    getToolTitles() {
+        return {
+            generate_image: 'Generate image',
+        };
+    }
+    /**
+     * Gets the `generate_image` tool function implementation.
+     */
+    getToolFunctions() {
+        return {
+            async generate_image(args, ...extra) {
+                console.log('!!!! [Tool] generate_image called', { args });
+                const { prompt } = args;
+                if (!prompt) {
+                    throw new Error('Image prompt is required');
+                }
+                const { llmTools } = extra[0] || {};
+                if (!llmTools || !llmTools.callImageGenerationModel) {
+                    throw new Error('Image generation is not supported by the current model provider');
+                }
+                const result = await llmTools.callImageGenerationModel({
+                    content: prompt,
+                    modelName: 'dall-e-3', // Defaulting to dall-e-3, but this could be configurable
+                });
+                return result.content;
+            },
+        };
+    }
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */
+
 /**
  * USE MCP commitment definition
  *
@@ -5824,8 +5966,12 @@ class UseSearchEngineCommitmentDefinition extends BaseCommitmentDefinition {
                 useSearchEngine: content || true,
             },
         }, spaceTrim$1(`
-                You have access to the web search engine. Use it to find up-to-date information or facts that you don't know.
+                Tools:
+                You have access to the web search engine via the tool "web_search".
+                Use it to find up-to-date information or facts that you don't know.
                 When you need to know some information from the internet, use the tool provided to you.
+                Do not make up information when you can search for it.
+                Do not tell the user you cannot search for information, YOU CAN.
             `));
     }
     /**
@@ -5850,9 +5996,7 @@ class UseSearchEngineCommitmentDefinition extends BaseCommitmentDefinition {
                 const searchEngine = new SerpSearchEngine();
                 const results = await searchEngine.search(query, options);
                 return spaceTrim$1((block) => `
-                        Search results for "${query}"${Object.keys(options).length === 0
-                    ? ''
-                    : ` with options ${JSON.stringify(options)}`}:
+                        Search results for "${query}"${Object.keys(options).length === 0 ? '' : ` with options ${JSON.stringify(options)}`}:
 
                         ${block(results
                     .map((result) => spaceTrim$1(`
@@ -5956,8 +6100,11 @@ class UseTimeCommitmentDefinition extends BaseCommitmentDefinition {
                 ...requirements.metadata,
             },
         }, spaceTrim$1(`
-                You have access to the current date and time. Use it to answer questions about the current date and time.
+                Tool:
+                You have access to the current date and time via the tool "get_current_time".
+                Use it to answer questions about the current date and time.
                 When you need to know the current date or time, use the tool provided to you.
+                Do not make up the current date or time; always use the tool to get accurate information.
             `));
     }
     /**
@@ -6139,6 +6286,15 @@ const COMMITMENT_REGISTRY = [
     new UseBrowserCommitmentDefinition(),
     new UseSearchEngineCommitmentDefinition(),
     new UseTimeCommitmentDefinition(),
+    new UseImageGeneratorCommitmentDefinition('USE IMAGE GENERATOR'),
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    new UseImageGeneratorCommitmentDefinition('USE IMAGE GENERATION'),
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    new UseImageGeneratorCommitmentDefinition('IMAGE GENERATOR'),
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    new UseImageGeneratorCommitmentDefinition('IMAGE GENERATION'),
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    new UseImageGeneratorCommitmentDefinition('USE IMAGE'),
     new UseMcpCommitmentDefinition(),
     new UseCommitmentDefinition(),
     // Not yet implemented commitments (using placeholder)