@promptbook/core 0.104.0-11 → 0.104.0-12

package/esm/typings/src/_packages/types.index.d.ts

@@ -188,6 +188,7 @@ import type { BookTranspiler } from '../transpilers/_common/BookTranspiler';
 import type { BookTranspilerOptions } from '../transpilers/_common/BookTranspilerOptions';
 import type { IntermediateFilesStrategy } from '../types/IntermediateFilesStrategy';
 import type { LlmCall } from '../types/LlmCall';
+import type { LlmToolDefinition } from '../types/LlmToolDefinition';
 import type { Message } from '../types/Message';
 import type { ModelRequirements } from '../types/ModelRequirements';
 import type { CompletionModelRequirements } from '../types/ModelRequirements';
@@ -559,6 +560,7 @@ export type { BookTranspiler };
 export type { BookTranspilerOptions };
 export type { IntermediateFilesStrategy };
 export type { LlmCall };
+export type { LlmToolDefinition };
 export type { Message };
 export type { ModelRequirements };
 export type { CompletionModelRequirements };

package/esm/typings/src/book-2.0/agent-source/AgentBasicInformation.d.ts

@@ -73,6 +73,7 @@ export type AgentBasicInformation = {
      */
     meta: {
         fullname?: string;
+        description?: string;
         image?: string_url_image;
         font?: string_fonts;
         color?: string_color;

package/esm/typings/src/book-2.0/agent-source/AgentModelRequirements.d.ts

@@ -1,3 +1,4 @@
+import type { LlmToolDefinition } from '../../types/LlmToolDefinition';
 import type { string_knowledge_source_link } from '../../types/typeAliases';
 import type { TODO_any } from '../../utils/organization/TODO_any';
 /**
@@ -45,6 +46,10 @@ export type AgentModelRequirements = {
      * Top-k sampling value for the agent's responses
      */
     readonly topK?: number;
+    /**
+     * Tools available for the agent
+     */
+    readonly tools?: ReadonlyArray<LlmToolDefinition>;
     /**
      * Arbitrary metadata storage for commitments
      * Each commitment can store its own data here

package/esm/typings/src/book-2.0/agent-source/createAgentModelRequirements.tools.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/commitments/META/META_DESCRIPTION.d.ts

@@ -0,0 +1,41 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * META DESCRIPTION commitment definition
+ *
+ * The META DESCRIPTION commitment sets the agent's meta description for the profile page.
+ * This commitment is special because it doesn't affect the system message,
+ * but is handled separately in the parsing logic.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * META DESCRIPTION An AI assistant specialized in business tasks
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class MetaDescriptionCommitmentDefinition extends BaseCommitmentDefinition<'META DESCRIPTION'> {
+    constructor();
+    /**
+     * Short one-line description of META DESCRIPTION.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for META DESCRIPTION commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+    /**
+     * Extracts the meta description from the content
+     * This is used by the parsing logic
+     */
+    extractMetaDescription(content: string): string | null;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.d.ts

@@ -6,13 +6,13 @@ import { BaseCommitmentDefinition } from '../_base/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

package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts

@@ -21,7 +21,7 @@ export declare function $provideLlmToolsForTestingAndScriptsAndPlayground(option
 export {};
 /**
  * Note: [⚪] This should never be in any released package
- * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+ * TODO: [👷‍♂️] Write a comprehensive manual about the construction of LLM tools
  * TODO: This should be maybe not under `_common` but under `utils-internal` / `utils/internal`
  * TODO: [®] DRY Register logi
  */

package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForWizardOrCli.d.ts

@@ -51,7 +51,7 @@ export declare function $provideLlmToolsForWizardOrCli(options?: ProvideLlmTools
 export {};
 /**
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
- * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+ * TODO: [👷‍♂️] Write a comprehensive manual about the construction of LLM tools
  * TODO: [🥃] Allow `ptbk make` without llm tools
  * TODO: This should be maybe not under `_common` but under `utils-internal` / `utils/internal`
  * TODO: [®] DRY Register logic

package/esm/typings/src/llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage.d.ts

@@ -17,6 +17,6 @@ export type LlmExecutionToolsWithTotalUsage = LlmExecutionTools & {
     spending(): Observable<Usage>;
 };
 /**
- * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+ * TODO: [👷‍♂️] Write a comprehensive manual about the construction of LLM tools
  * Note: [🥫] Not using getter `get totalUsage` but `getTotalUsage` to allow this object to be proxied
  */

package/esm/typings/src/llm-providers/_common/utils/count-total-usage/limitTotalUsage.d.ts

@@ -32,5 +32,5 @@ export {};
  * 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
  */

package/esm/typings/src/llm-providers/_multiple/getSingleLlmExecutionTools.d.ts

@@ -8,5 +8,5 @@ import { MultipleLlmExecutionTools } from './MultipleLlmExecutionTools';
 export declare function getSingleLlmExecutionTools(oneOrMoreLlmExecutionTools: undefined | LlmExecutionTools | ReadonlyArray<LlmExecutionTools>): LlmExecutionTools | MultipleLlmExecutionTools;
 /**
  * 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
  */

package/esm/typings/src/llm-providers/_multiple/joinLlmExecutionTools.d.ts

@@ -19,5 +19,5 @@ import { MultipleLlmExecutionTools } from './MultipleLlmExecutionTools';
 export declare function joinLlmExecutionTools(title: string_title & string_markdown_text, ...llmExecutionTools: ReadonlyArray<LlmExecutionTools>): MultipleLlmExecutionTools;
 /**
  * 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
  */

package/esm/typings/src/llm-providers/openai/utils/mapToolsToOpenAi.d.ts

@@ -0,0 +1,8 @@
+import type OpenAI from 'openai';
+import type { LlmToolDefinition } from '../../../types/LlmToolDefinition';
+/**
+ * Maps Promptbook tools to OpenAI tools.
+ *
+ * @private
+ */
+export declare function mapToolsToOpenAi(tools: ReadonlyArray<LlmToolDefinition>): Array<OpenAI.Chat.Completions.ChatCompletionTool>;

package/esm/typings/src/search-engines/SearchResult.d.ts

@@ -1,18 +1,18 @@
 import type { string_url } from '../types/typeAliases';
 /**
- * @@@
+ * Represents a search result from a search engine.
  */
 export type SearchResult = {
     /**
-     * @@@
+     * The title of the search result.
      */
     title: string;
     /**
-     * @@@
+     * The URL of the search result.
      */
     url: string_url;
     /**
-     * @@@
+     * A short snippet or description of the search result.
      */
     snippet: string;
 };

package/esm/typings/src/search-engines/bing/BingSearchEngine.d.ts

@@ -3,7 +3,7 @@ import type { string_markdown, string_markdown_text, string_title } from '../../
 import type { SearchEngine } from '../SearchEngine';
 import type { SearchResult } from '../SearchResult';
 /**
- * @@@
+ * A search engine implementation that uses the Bing Web Search API.
  *
  * @private <- TODO: !!!! Export via some package
  */

package/esm/typings/src/search-engines/dummy/DummySearchEngine.d.ts

@@ -3,7 +3,7 @@ import type { string_markdown, string_markdown_text, string_title } from '../../
 import type { SearchEngine } from '../SearchEngine';
 import type { SearchResult } from '../SearchResult';
 /**
- * @@@
+ * A dummy implementation of SearchEngine for testing purposes.
  *
  * @private <- TODO: !!!! Export via some package, maybe `@promptbook/search-engines` or `@promptbook/fake-llm`
  */

package/esm/typings/src/types/LlmToolDefinition.d.ts

@@ -0,0 +1,20 @@
+import type { string_markdown_text, string_name } from './typeAliases';
+/**
+ * Definition of a tool that can be used by the model
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type LlmToolDefinition = {
+    /**
+     * Name of the tool
+     */
+    readonly name: string_name;
+    /**
+     * Description of the tool
+     */
+    readonly description: string_markdown_text;
+    /**
+     * Parameters of the tool in JSON Schema format
+     */
+    readonly parameters: Record<string, unknown>;
+};

package/esm/typings/src/types/ModelRequirements.d.ts

@@ -1,3 +1,4 @@
+import type { LlmToolDefinition } from './LlmToolDefinition';
 import type { ModelVariant } from './ModelVariant';
 import type { number_model_temperature, number_seed, string_model_name, string_system_message } from './typeAliases';
 /**
@@ -28,6 +29,12 @@ export type CompletionModelRequirements = CommonModelRequirements & {
      * Maximum number of tokens that can be generated by the model
      */
     readonly maxTokens?: number;
+    /**
+     * Tools available for the model
+     *
+     * Note: [🚉] This is fully serializable as JSON
+     */
+    readonly tools?: LlmToolDefinition[];
 };
 /**
  * Model requirements for the chat variant
@@ -53,6 +60,12 @@ export type ChatModelRequirements = CommonModelRequirements & {
      * Maximum number of tokens that can be generated by the model
      */
     readonly maxTokens?: number;
+    /**
+     * Tools available for the model
+     *
+     * Note: [🚉] This is fully serializable as JSON
+     */
+    readonly tools?: LlmToolDefinition[];
 };
 /**
  * Model requirements for the image generation variant

package/esm/typings/src/version.d.ts

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.104.0-10`).
+ * It follows semantic versioning (e.g., `0.104.0-11`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/core",
-    "version": "0.104.0-11",
+    "version": "0.104.0-12",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,

package/umd/index.umd.js

@@ -28,7 +28,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.104.0-11';
+    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
@@ -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,
                 },
             };
         }
@@ -11957,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;
@@ -17142,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
      */
 
     /**
@@ -18030,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
      *
@@ -18227,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) {
@@ -18371,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(),
             };
@@ -18625,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
             };
@@ -19028,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();
@@ -19551,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