@promptbook/ollama 0.104.0-10 → 0.104.0-12

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

@@ -23,6 +23,24 @@ export type BookParameter = {
      */
     description?: string;
 };
+/**
+ * Capability of the agent
+ * This is parsed from commitments like USE BROWSER, USE SEARCH ENGINE, KNOWLEDGE, etc.
+ */
+export type AgentCapability = {
+    /**
+     * The type of the capability
+     */
+    type: 'browser' | 'search-engine' | 'knowledge';
+    /**
+     * The label to display for this capability
+     */
+    label: string;
+    /**
+     * The name of the icon to display for this capability
+     */
+    iconName: string;
+};
 export type AgentBasicInformation = {
     /**
      * Name of the agent
@@ -55,6 +73,7 @@ export type AgentBasicInformation = {
      */
     meta: {
         fullname?: string;
+        description?: string;
         image?: string_url_image;
         font?: string_fonts;
         color?: string_color;
@@ -72,6 +91,11 @@ export type AgentBasicInformation = {
      * - {parameterName} or {parameter with multiple words} or {parameterName: description text}
      */
     parameters: BookParameter[];
+    /**
+     * Capabilities of the agent
+     * This is parsed from commitments like USE BROWSER, USE SEARCH ENGINE, KNOWLEDGE, etc.
+     */
+    capabilities: AgentCapability[];
 };
 /**
  * TODO: [🐱‍🚀] Make all properties of `AgentBasicInformation` readonly

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/book-components/Chat/types/ChatMessage.d.ts

@@ -23,11 +23,11 @@ export type ChatMessage = Omit<Message<id>, 'direction' | 'recipients' | 'thread
      */
     isComplete?: boolean;
     /**
-     * @@@
+     * The expected answer for the message (used for testing or validation)
      */
     expectedAnswer?: string;
     /**
-     * @@@
+     * Indicates if the message was sent via a voice call
      */
     isVoiceCall?: boolean;
 };

package/esm/typings/src/book-components/_common/Dropdown/Dropdown.d.ts

@@ -7,7 +7,7 @@ type DropdownProps = {
     }>;
 };
 /**
- * @@@
+ * A dropdown menu component that displays a list of actions triggered by a hamburger menu button.
  *
  * @private internal subcomponent used by various components
  */

package/esm/typings/src/book-components/_common/HamburgerMenu/HamburgerMenu.d.ts

@@ -4,7 +4,7 @@ type HamburgerMenuProps = {
     className?: string;
 };
 /**
- * @@@
+ * An animated hamburger menu button component.
  *
  * @private Internal component
  */

package/esm/typings/src/book-components/icons/AboutIcon.d.ts

@@ -1,6 +1,6 @@
 import { SVGProps } from 'react';
 /**
- * @@@
+ * Renders an about icon
  *
  * @private internal subcomponent used by various components
  */

package/esm/typings/src/book-components/icons/AttachmentIcon.d.ts

@@ -3,7 +3,7 @@ type AttachmentIconProps = {
     color?: string;
 };
 /**
- * @@@
+ * Renders an attachment icon
  *
  * @public exported from `@promptbook/components`
  */

package/esm/typings/src/book-components/icons/CameraIcon.d.ts

@@ -3,7 +3,7 @@ type CameraIconProps = {
     color?: string;
 };
 /**
- * @@@
+ * Renders a camera icon
  *
  * @public exported from `@promptbook/components`
  */

package/esm/typings/src/book-components/icons/DownloadIcon.d.ts

@@ -1,6 +1,6 @@
 import { SVGProps } from 'react';
 /**
- * @@@
+ * Renders a download icon
  *
  * @private internal subcomponent used by various components
  */

package/esm/typings/src/book-components/icons/MenuIcon.d.ts

@@ -1,6 +1,6 @@
 import { SVGProps } from 'react';
 /**
- * @@@
+ * Renders a menu icon
  *
  * @private internal subcomponent used by various components
  */

package/esm/typings/src/book-components/icons/SaveIcon.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
 /**
- * @@@
+ * Renders a save icon
  *
  * @public exported from `@promptbook/components`
  */

package/esm/typings/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentCollectionInSupabase.d.ts

@@ -26,11 +26,11 @@ export declare class AgentCollectionInSupabase {
      */
     listAgents(): Promise<ReadonlyArray<AgentBasicInformation>>;
     /**
-     * [🐱‍🚀]@@@
+     * Retrieves the permanent ID of an agent by its name or permanent ID.
      */
     getAgentPermanentId(agentNameOrPermanentId: string_agent_name | string_agent_permanent_id): Promise<string_agent_permanent_id>;
     /**
-     * [🐱‍🚀]@@@
+     * Retrieves the source code of an agent by its name or permanent ID.
      */
     getAgentSource(agentNameOrPermanentId: string_agent_name | string_agent_permanent_id): Promise<string_book>;
     /**

package/esm/typings/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentsDatabaseSchema.d.ts

@@ -108,60 +108,6 @@ export type AgentsDatabaseSchema = {
                     }
                 ];
             };
-            GenerationLock: {
-                Row: {
-                    id: number;
-                    createdAt: string;
-                    updatedAt: string;
-                    lockKey: string;
-                    expiresAt: string;
-                };
-                Insert: {
-                    id?: number;
-                    createdAt?: string;
-                    updatedAt?: string;
-                    lockKey: string;
-                    expiresAt: string;
-                };
-                Update: {
-                    id?: number;
-                    createdAt?: string;
-                    updatedAt?: string;
-                    lockKey?: string;
-                    expiresAt?: string;
-                };
-                Relationships: [];
-            };
-            Image: {
-                Row: {
-                    id: number;
-                    createdAt: string;
-                    updatedAt: string;
-                    filename: string;
-                    prompt: string;
-                    cdnUrl: string;
-                    cdnKey: string;
-                };
-                Insert: {
-                    id?: number;
-                    createdAt?: string;
-                    updatedAt?: string;
-                    filename: string;
-                    prompt: string;
-                    cdnUrl: string;
-                    cdnKey: string;
-                };
-                Update: {
-                    id?: number;
-                    createdAt?: string;
-                    updatedAt?: string;
-                    filename?: string;
-                    prompt?: string;
-                    cdnUrl?: string;
-                    cdnKey?: string;
-                };
-                Relationships: [];
-            };
         };
         Views: Record<string, never>;
         Functions: Record<string, never>;

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/countUsage.d.ts

@@ -13,5 +13,5 @@ export declare function countUsage(llmTools: LlmExecutionTools): LlmExecutionToo
  * 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
  */

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/agent/Agent.d.ts

@@ -1,5 +1,5 @@
 import { BehaviorSubject } from 'rxjs';
-import type { AgentBasicInformation, BookParameter } from '../../book-2.0/agent-source/AgentBasicInformation';
+import type { AgentBasicInformation, AgentCapability, BookParameter } from '../../book-2.0/agent-source/AgentBasicInformation';
 import type { string_book } from '../../book-2.0/agent-source/string_book';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { ChatPromptResult } from '../../execution/PromptResult';
@@ -37,6 +37,11 @@ export declare class Agent extends AgentLlmExecutionTools implements LlmExecutio
      * Links found in the agent source
      */
     links: Array<string_agent_url>;
+    /**
+     * Capabilities of the agent
+     * This is parsed from commitments like USE BROWSER, USE SEARCH ENGINE, KNOWLEDGE, etc.
+     */
+    capabilities: AgentCapability[];
     /**
      * Computed hash of the agent source for integrity verification
      */

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/remote-server/ui/ServerApp.d.ts

@@ -1,6 +1,6 @@
 import type { ServerInfo } from './types';
 /**
- * @@@
+ * Renders the HTML document for the Promptbook Server UI.
  *
  * @private internal utility of Remote Server
  */

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

@@ -0,0 +1,9 @@
+import type { Promisable } from 'type-fest';
+import type { string_markdown, string_markdown_text, string_title } from '../types/typeAliases';
+import type { SearchResult } from './SearchResult';
+export type SearchEngine = {
+    readonly title: string_title & string_markdown_text;
+    readonly description?: string_markdown;
+    checkConfiguration(): Promisable<void>;
+    search(query: string): Promise<SearchResult[]>;
+};

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

@@ -0,0 +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

@@ -0,0 +1,15 @@
+import type { Promisable } from 'type-fest';
+import type { string_markdown, string_markdown_text, string_title } from '../../types/typeAliases';
+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
+ */
+export declare class BingSearchEngine implements SearchEngine {
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    checkConfiguration(): Promisable<void>;
+    search(query: string): Promise<SearchResult[]>;
+}

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

@@ -0,0 +1,15 @@
+import type { Promisable } from 'type-fest';
+import type { string_markdown, string_markdown_text, string_title } from '../../types/typeAliases';
+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`
+ */
+export declare class DummySearchEngine implements SearchEngine {
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    checkConfiguration(): Promisable<void>;
+    search(query: string): Promise<SearchResult[]>;
+}

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/utils/random/$randomAgentPersona.d.ts

@@ -1,9 +1,10 @@
+import type { string_persona_description } from '../../types/typeAliases';
 /**
- * @@@@
+ * Generates a random agent persona description.
  *
  * @private internal helper function
  */
-export declare function $randomAgentPersona(): string;
+export declare function $randomAgentPersona(): string_persona_description;
 /**
  * TODO: [🤶] Maybe export through `@promptbook/utils` or `@promptbook/random` package
  */

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-9`).
+ * It follows semantic versioning (e.g., `0.104.0-11`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/ollama",
-    "version": "0.104.0-10",
+    "version": "0.104.0-12",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
@@ -94,7 +94,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/ollama.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.104.0-10"
+        "@promptbook/core": "0.104.0-12"
     },
     "dependencies": {
         "bottleneck": "2.19.5",

package/umd/index.umd.js

@@ -25,7 +25,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
@@ -2865,6 +2865,22 @@
         return replacedTemplates;
     }
 
+    /**
+     * 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
      *
@@ -3062,6 +3078,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) {
@@ -3206,6 +3225,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(),
             };
@@ -3460,8 +3480,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
             };