@promptbook/google 0.104.0-9 → 0.104.0

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

@@ -4,8 +4,12 @@ type HamburgerMenuProps = {
     className?: string;
 };
 /**
- * @@@
+ * An animated hamburger menu button component.
  *
+ * This component renders a 3-bar hamburger icon that animates into an "X" when
+ * the menu is open.
+ *
+ * @param props - Contains the open state, an optional click handler, and optional className
  * @private Internal component
  */
 export declare function HamburgerMenu({ isOpen, onClick, className }: HamburgerMenuProps): import("react/jsx-runtime").JSX.Element;

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

@@ -1,7 +1,11 @@
 import { SVGProps } from 'react';
 /**
- * @@@
+ * Renders an information/about icon.
  *
+ * This icon is typically used in UI elements that provide additional information
+ * or "about" details to the user.
+ *
+ * @param props - SVG properties augmented with an optional `size`
  * @private internal subcomponent used by various components
  */
 export declare function AboutIcon(props: SVGProps<SVGSVGElement> & {

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

@@ -3,9 +3,13 @@ type AttachmentIconProps = {
     color?: string;
 };
 /**
- * @@@
+ * Renders an attachment icon.
  *
- * @public exported from `@promptbook/components`
+ * This icon is typically used in chat interfaces to indicate the ability to
+ * upload or view files associated with a message.
+ *
+ * @param props - SVG properties augmented with an optional `size`
+ * @private internal subcomponent used by various components
  */
 export declare function AttachmentIcon({ size, color }: AttachmentIconProps): import("react/jsx-runtime").JSX.Element;
 export {};

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

@@ -3,9 +3,13 @@ type CameraIconProps = {
     color?: string;
 };
 /**
- * @@@
+ * Renders a camera icon.
  *
- * @public exported from `@promptbook/components`
+ * This icon is typically used in buttons or inputs that trigger image capture
+ * or selection.
+ *
+ * @param props - SVG properties augmented with an optional `size`
+ * @private internal subcomponent used by various components
  */
 export declare function CameraIcon({ size, color }: CameraIconProps): import("react/jsx-runtime").JSX.Element;
 export {};

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

@@ -1,7 +1,11 @@
 import { SVGProps } from 'react';
 /**
- * @@@
+ * Renders a download icon.
  *
+ * This icon is typically used in buttons or links that trigger the downloading
+ * of files or assets.
+ *
+ * @param props - SVG properties augmented with an optional `size`
  * @private internal subcomponent used by various components
  */
 export declare function DownloadIcon(props: SVGProps<SVGSVGElement> & {

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

@@ -1,7 +1,11 @@
 import { SVGProps } from 'react';
 /**
- * @@@
+ * Renders a menu icon.
  *
+ * This icon is typically used in buttons that toggle the visibility of
+ * navigation menus or dropdowns.
+ *
+ * @param props - SVG properties augmented with an optional `size`
  * @private internal subcomponent used by various components
  */
 export declare function MenuIcon(props: SVGProps<SVGSVGElement> & {

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

@@ -1,8 +1,12 @@
 import React from 'react';
 /**
- * @@@
+ * Renders a save icon.
  *
- * @public exported from `@promptbook/components`
+ * This icon is typically used in buttons that trigger the saving of data,
+ * configurations, or agent sources.
+ *
+ * @param props - SVG properties augmented with an optional `size`
+ * @private internal subcomponent used by various components
  */
 export declare function SaveIcon({ size, color, ...props }: {
     size?: number;

package/esm/typings/src/collection/agent-collection/AgentCollection.d.ts

@@ -1,4 +1,4 @@
-import { AgentCollectionInSupabase } from './constructors/agent-collection-in-supabase/AgentCollectionInSupabase';
+import type { AgentCollectionInSupabase } from './constructors/agent-collection-in-supabase/AgentCollectionInSupabase';
 /**
  * Collection that groups together multiple AI Agents
  *

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

@@ -5,9 +5,12 @@ import type { string_agent_name, string_agent_permanent_id } from '../../../../t
 import { AgentCollectionInSupabaseOptions } from './AgentCollectionInSupabaseOptions';
 import type { AgentsDatabaseSchema } from './AgentsDatabaseSchema';
 /**
- * Agent collection stored in Supabase table
+ * Agent collection stored in a Supabase table.
  *
- * Note: This object can work both from Node.js and browser environment depending on the Supabase client provided
+ * This class provides a way to manage a collection of agents (pipelines) using Supabase
+ * as the storage backend. It supports listing, creating, updating, and soft-deleting agents.
+ *
+ * Note: This object can work both from Node.js and browser environment depending on the Supabase client provided.
  *
  * @public exported from `@promptbook/core`
  * <- TODO: [🐱‍🚀] Move to `@promptbook/supabase` package
@@ -16,9 +19,8 @@ export declare class AgentCollectionInSupabase {
     private readonly supabaseClient;
     readonly options?: AgentCollectionInSupabaseOptions | undefined;
     /**
-     * @param rootPath - path to the directory with agents
-     * @param tools - Execution tools to be used in [🐱‍🚀] `Agent` itself and listing the agents
-     * @param options - Options for the collection creation
+     * @param supabaseClient - The initialized Supabase client
+     * @param options - Configuration options for the collection (e.g., table prefix, verbosity)
      */
     constructor(supabaseClient: SupabaseClient<AgentsDatabaseSchema>, options?: AgentCollectionInSupabaseOptions | undefined);
     /**
@@ -26,11 +28,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/commands/_common/types/Command.d.ts

@@ -3,4 +3,4 @@ import { COMMANDS } from '../../index';
  * Command is one piece of the book file section which adds some logic to the task or the whole pipeline.
  * It is parsed from the markdown from ul/ol items - one command per one item.
  */
-export type Command = ReturnType<typeof COMMANDS[number]['parse']>;
+export type Command = ReturnType<(typeof COMMANDS)[number]['parse']>;

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/commitments/_base/BookCommitment.d.ts

@@ -2,4 +2,4 @@ import { COMMITMENT_REGISTRY } from '../index';
 /**
  * All available book commitment types
  */
-export type BookCommitment = typeof COMMITMENT_REGISTRY[number]['type'];
+export type BookCommitment = (typeof COMMITMENT_REGISTRY)[number]['type'];

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

@@ -1,6 +1,6 @@
 import type { CsvSettings } from './formats/csv/CsvSettings';
 import type { IntermediateFilesStrategy } from './types/IntermediateFilesStrategy';
-import type { string_app_id, string_email, string_name, string_promptbook_server_url } from './types/typeAliases';
+import type { string_app_id, string_email, string_legal_entity, string_name, string_promptbook_server_url } from './types/typeAliases';
 import { Color } from './utils/color/Color';
 /**
  * Warning message for the generated sections and files files
@@ -22,6 +22,12 @@ export declare const NAME = "Promptbook";
  * @public exported from `@promptbook/core`
  */
 export declare const ADMIN_EMAIL: string_email;
+/**
+ * Email of the responsible person
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const PROMPTBOOK_LEGAL_ENTITY: string_legal_entity;
 /**
  * Name of the responsible person for the Promptbook on GitHub
  *
@@ -295,6 +301,7 @@ export declare const MOMENT_ARG_THRESHOLDS: {
 /**
  * Default remote server URL for the Promptbook
  *
+ * @deprecated TODO: !!! Deprecate all things related to pipelines and pipelines server
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_REMOTE_SERVER_URL: string_promptbook_server_url;

package/esm/typings/src/formfactors/_common/FormfactorDefinition.d.ts

@@ -7,4 +7,4 @@ import { FORMFACTOR_DEFINITIONS } from '../index';
  * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook/discussions/172
  */
-export type FormfactorDefinition = typeof FORMFACTOR_DEFINITIONS[number];
+export type FormfactorDefinition = (typeof FORMFACTOR_DEFINITIONS)[number];

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

@@ -1,10 +1,14 @@
 import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
 import type { LlmExecutionToolsWithTotalUsage } from './LlmExecutionToolsWithTotalUsage';
 /**
- * Intercepts LLM tools and counts total usage of the tools
+ * Intercepts LLM tools and counts total usage of the tools.
  *
- * @param llmTools LLM tools to be intercepted with usage counting
- * @returns LLM tools with same functionality with added total cost counting
+ * This function wraps the provided `LlmExecutionTools` with a proxy that tracks the cumulative
+ * usage (tokens, cost, etc.) across all model calls. It provides a way to monitor spending
+ * in real-time through an observable.
+ *
+ * @param llmTools - The LLM tools to be intercepted and tracked
+ * @returns An augmented version of the tools that includes usage tracking capabilities
  * @public exported from `@promptbook/core`
  */
 export declare function countUsage(llmTools: LlmExecutionTools): LlmExecutionToolsWithTotalUsage;
@@ -13,5 +17,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

@@ -2,22 +2,26 @@ import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { string_markdown_text, string_title } from '../../types/typeAliases';
 import { MultipleLlmExecutionTools } from './MultipleLlmExecutionTools';
 /**
- * Joins multiple LLM Execution Tools into one
+ * Joins multiple LLM Execution Tools into one.
  *
- * @returns {LlmExecutionTools} Single wrapper for multiple LlmExecutionTools
+ * This function takes a list of `LlmExecutionTools` and returns a single unified
+ * `MultipleLlmExecutionTools` object. It provides failover and aggregation logic:
  *
- * 0) If there is no LlmExecutionTools, it warns and returns valid but empty LlmExecutionTools
- * 1) If there is only one LlmExecutionTools, it returns it wrapped in a proxy object
- * 2) If there are multiple LlmExecutionTools, first will be used first, second will be used if the first hasn`t defined model variant or fails, etc.
- * 3) When all LlmExecutionTools fail, it throws an error with a list of all errors merged into one
+ * 1.  **Failover**: When a model call is made, it tries providers in the order they were provided.
+ *     If the first provider doesn't support the requested model or fails, it tries the next one.
+ * 2.  **Aggregation**: `listModels` returns a combined list of all models available from all providers.
+ * 3.  **Empty case**: If no tools are provided, it logs a warning (as Promptbook requires LLMs to function).
  *
+ * @param title - A descriptive title for this collection of joined tools
+ * @param llmExecutionTools - An array of execution tools to be joined
+ * @returns A single unified execution tool wrapper
  *
- * Tip: You don't have to use this function directly, just pass an array of LlmExecutionTools to the `ExecutionTools`
+ * Tip: You don't have to use this function directly, just pass an array of LlmExecutionTools to the `ExecutionTools`.
  *
  * @public exported from `@promptbook/core`
  */
 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';
@@ -20,6 +20,7 @@ import type { AgentOptions } from './AgentOptions';
  * @public exported from `@promptbook/core`
  */
 export declare class Agent extends AgentLlmExecutionTools implements LlmExecutionTools, AgentBasicInformation {
+    #private;
     private _agentName;
     /**
      * Name of the agent
@@ -37,6 +38,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/agent/AgentLlmExecutionTools.d.ts

@@ -22,7 +22,7 @@ import type { CreateAgentLlmExecutionToolsOptions } from './CreateAgentLlmExecut
  * @public exported from `@promptbook/core`
  */
 export declare class AgentLlmExecutionTools implements LlmExecutionTools {
-    private readonly options;
+    protected readonly options: CreateAgentLlmExecutionToolsOptions;
     /**
      * Cache of OpenAI assistants to avoid creating duplicates
      */

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,7 +1,11 @@
 import type { ServerInfo } from './types';
 /**
- * @@@
+ * Renders the full HTML document for the Promptbook Server UI.
  *
+ * This component provides the root structure of the server information page,
+ * including necessary meta tags, Tailwind CSS styling, and the server details body.
+ *
+ * @param props - Contains server information such as versions, port, and pipelines
  * @private internal utility of Remote Server
  */
 export declare function HtmlDoc({ info }: {

package/esm/typings/src/scrapers/_common/utils/promptbookFetch.test.d.ts

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

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