@promptbook/types 0.103.0-4 → 0.103.0-40

package/esm/typings/src/collection/agent-collection/constructors/AgentCollectionInDirectory.d.ts

@@ -0,0 +1,88 @@
+import { Agent } from '../../../_packages/core.index';
+import { CommonToolsOptions, string_book } from '../../../_packages/types.index';
+import type { ExecutionTools } from '../../../execution/ExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
+import type { string_agent_name, string_dirname } from '../../../types/typeAliases';
+import type { AgentCollection } from '../AgentCollection';
+/**
+ * Options for `createAgentCollectionFromDirectory` function
+ *
+ * Note: `rootDirname` is not needed because it is the folder in which `.book` or `.book` file is located
+ *       This is not same as `path` which is the first argument of `createAgentCollectionFromDirectory` - it can be a subfolder
+ */
+type CreateAgentCollectionInDirectoryOptions = Omit<PrepareAndScrapeOptions, 'rootDirname'> & CommonToolsOptions & {
+    /**
+     * If true, the directory is searched recursively for pipelines
+     *
+     * @default true
+     */
+    isRecursive?: boolean;
+    /**
+     * If true, directory will be scanned only when needed not during the construction
+     *
+     * @default false
+     */
+    isLazyLoaded?: boolean;
+    /**
+     * If true, whole collection creation crashes on error in any pipeline
+     * If true and isLazyLoaded is true, the error is thrown on first access to the pipeline
+     *
+     * @default true
+     */
+    isCrashedOnError?: boolean;
+};
+/**
+ * Agent collection stored in directory
+ *
+ * Note: Works only in Node.js environment because it reads the file system
+ *
+ * @public exported from `@promptbook/node`
+ */
+export declare class AgentCollectionInDirectory implements AgentCollection {
+    readonly rootPath: string_dirname;
+    private readonly tools?;
+    readonly options?: CreateAgentCollectionInDirectoryOptions | 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
+     */
+    constructor(rootPath: string_dirname, tools?: Pick<ExecutionTools, "llm" | "fs" | "scrapers"> | undefined, options?: CreateAgentCollectionInDirectoryOptions | undefined);
+    /**
+     * Cached defined execution tools
+     */
+    private _definedTools;
+    /**
+     * Gets or creates execution tools for the collection
+     */
+    private getTools;
+    /**
+     * Gets all agents in the collection
+     */
+    listAgents(): Promise<ReadonlyArray<string_agent_name>>;
+    /**
+     * Get one agent by its name
+     *
+     * Note: Agents are existing independently of you getting them or not, you can get the same agent multiple times.
+     * Note: Agents are changed by interacting with `Agent` objects directly. Only creation and deletion is done via the collection.
+     */
+    getAgentByName(agentName: string_agent_name): Promise<Agent>;
+    /**
+     * Deletes an agent from the collection
+     *
+     * Note: When you want delete an agent by name, first get the agent using `getAgentByName` and then pass it to `deleteAgent`.
+     */
+    deleteAgent(agent: Agent): Promise<void>;
+    /**
+     * Creates a new agent in the collection
+     *
+     * Note: You can set 'PARENT' in the agent source to inherit from another agent in the collection.
+     */
+    createAgent(agentSource: string_book): Promise<Agent>;
+}
+export {};
+/**
+ * TODO: [🖇] What about symlinks? Maybe option `isSymlinksFollowed`
+ * TODO: [🧠] Maybe add option `isImmutable`
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/collection/{PipelineCollection.d.ts → pipeline-collection/PipelineCollection.d.ts}

@@ -1,9 +1,13 @@
 import type { Promisable } from 'type-fest';
-import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
-import type { Prompt } from '../types/Prompt';
-import type { string_pipeline_url } from '../types/typeAliases';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { Prompt } from '../../types/Prompt';
+import type { string_pipeline_url } from '../../types/typeAliases';
 /**
  * Collection that groups together pipelines, knowledge, personas, tools and actions
+ *
+ * Note: [🧸] There are two types of collections:
+ * - `AgentCollection` - which groups together AI Agents
+ * - `PipelineCollection` - which groups together *(deprecated)* pipelines
  */
 export type PipelineCollection = {
     /**

package/esm/typings/src/collection/{SimplePipelineCollection.d.ts → pipeline-collection/SimplePipelineCollection.d.ts}

@@ -1,12 +1,12 @@
-import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
-import type { Prompt } from '../types/Prompt';
-import type { string_pipeline_url } from '../types/typeAliases';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { Prompt } from '../../types/Prompt';
+import type { string_pipeline_url } from '../../types/typeAliases';
 import type { PipelineCollection } from './PipelineCollection';
 /**
  * Library of pipelines that groups together pipelines for an application.
  * This implementation is a very thin wrapper around the Array / Map of pipelines.
  *
- * @private internal function of `createCollectionFromJson`, use `createCollectionFromJson` instead
+ * @private internal function of `createPipelineCollectionFromJson`, use `createPipelineCollectionFromJson` instead
  * @see https://github.com/webgptorg/pipeline#pipeline-collection
  */
 export declare class SimplePipelineCollection implements PipelineCollection {
@@ -17,7 +17,7 @@ export declare class SimplePipelineCollection implements PipelineCollection {
      * @param pipelines Array of pipeline JSON objects to include in the collection
      *
      * Note: During the construction logic of all pipelines are validated
-     * Note: It is not recommended to use this constructor directly, use `createCollectionFromJson` *(or other variant)* instead
+     * Note: It is not recommended to use this constructor directly, use `createPipelineCollectionFromJson` *(or other variant)* instead
      */
     constructor(...pipelines: ReadonlyArray<PipelineJson>);
     /**

package/esm/typings/src/collection/{constructors/createCollectionFromDirectory.d.ts → pipeline-collection/constructors/createPipelineCollectionFromDirectory.d.ts}

@@ -1,13 +1,12 @@
-import type { ExecutionTools } from '../../execution/ExecutionTools';
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import type { string_dirname } from '../../types/typeAliases';
-import type { string_pipeline_root_url } from '../../types/typeAliases';
+import type { ExecutionTools } from '../../../execution/ExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
+import type { string_dirname, string_pipeline_root_url } from '../../../types/typeAliases';
 import type { PipelineCollection } from '../PipelineCollection';
 /**
- * Options for `createCollectionFromDirectory` function
+ * Options for `createPipelineCollectionFromDirectory` function
  *
  * Note: `rootDirname` is not needed because it is the folder in which `.book` or `.book` file is located
- *       This is not same as `path` which is the first argument of `createCollectionFromDirectory` - it can be a subfolder
+ *       This is not same as `path` which is the first argument of `createPipelineCollectionFromDirectory` - it can be a subfolder
  */
 type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions, 'rootDirname'> & {
     /**
@@ -28,8 +27,6 @@ type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions
      * It has 2 purposes:
      * 1) Every pipeline in the collection is checked if it is a child of `rootUrl`
      * 2) If the pipeline does not have a URL, it is created from the `rootUrl` and path to the pipeline
-     *
-     * @default false
      */
     rootUrl?: string_pipeline_root_url;
     /**
@@ -47,7 +44,7 @@ type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions
     isCrashedOnError?: boolean;
 };
 /**
- * Constructs Pipeline from given directory
+ * Constructs `PipelineCollection` from given directory
  *
  * Note: Works only in Node.js environment because it reads the file system
  *
@@ -57,9 +54,9 @@ type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions
  * @returns PipelineCollection
  * @public exported from `@promptbook/node`
  */
-export declare function createCollectionFromDirectory(rootPath: string_dirname, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
+export declare function createPipelineCollectionFromDirectory(rootPath: string_dirname, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
 export {};
 /**
- * TODO: [🖇] What about symlinks? Maybe option isSymlinksFollowed
+ * TODO: [🖇] What about symlinks? Maybe option `isSymlinksFollowed`
  * TODO: Maybe move from `@promptbook/node` to `@promptbook/core` as we removes direct dependency on `fs`
  */

package/esm/typings/src/collection/pipeline-collection/constructors/createPipelineCollectionFromJson.d.ts

@@ -0,0 +1,13 @@
+import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
+import type { PipelineCollection } from '../PipelineCollection';
+/**
+ * Creates `PipelineCollection` from array of PipelineJson or PipelineString
+ *
+ * Note: Functions `pipelineCollectionToJson` and `createPipelineCollectionFromJson` are complementary
+ * Note: Syntax, parsing, and logic consistency checks are performed on all sources during build
+ *
+ * @param promptbookSources
+ * @returns PipelineCollection
+ * @public exported from `@promptbook/core`
+ */
+export declare function createPipelineCollectionFromJson(...promptbooks: ReadonlyArray<PipelineJson>): PipelineCollection;

package/esm/typings/src/collection/{constructors/createCollectionFromPromise.d.ts → pipeline-collection/constructors/createPipelineCollectionFromPromise.d.ts}

@@ -1,23 +1,24 @@
-import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
 import type { PipelineCollection } from '../PipelineCollection';
 /**
- * Constructs Promptbook from async sources
+ * Constructs `PipelineCollection` from async sources
+ *
  * It can be one of the following:
  * - Promise of array of PipelineJson or PipelineString
  * - Factory function that returns Promise of array of PipelineJson or PipelineString
  *
  * Note: This is useful as internal tool for other constructor functions like
- *       `createCollectionFromUrl` or `createCollectionFromDirectory`
+ *       `createPipelineCollectionFromUrl` or `createPipelineCollectionFromDirectory`
  *       Consider using those functions instead of this one
  *
  * Note: The function does NOT return promise it returns the collection directly which waits for the sources to be resolved
  *       when error occurs in given promise or factory function, it is thrown during `listPipelines` or `getPipelineByUrl` call
  *
- * Note: Consider using  `createCollectionFromDirectory` or `createCollectionFromUrl`
+ * Note: Consider using  `createPipelineCollectionFromDirectory` or `createPipelineCollectionFromUrl`
  *
  * @param promptbookSourcesPromiseOrFactory
  * @returns PipelineCollection
  * @deprecated Do not use, it will became internal tool for other constructor functions
  * @public exported from `@promptbook/core`
  */
-export declare function createCollectionFromPromise(promptbookSourcesPromiseOrFactory: Promise<ReadonlyArray<PipelineJson>> | (() => Promise<ReadonlyArray<PipelineJson>>)): PipelineCollection;
+export declare function createPipelineCollectionFromPromise(promptbookSourcesPromiseOrFactory: Promise<ReadonlyArray<PipelineJson>> | (() => Promise<ReadonlyArray<PipelineJson>>)): PipelineCollection;

package/esm/typings/src/collection/{constructors/createCollectionFromUrl.d.ts → pipeline-collection/constructors/createPipelineCollectionFromUrl.d.ts}

@@ -1,7 +1,7 @@
-import type { string_url } from '../../types/typeAliases';
+import type { string_url } from '../../../types/typeAliases';
 import type { PipelineCollection } from '../PipelineCollection';
 /**
- * Options for `createCollectionFromDirectory` function
+ * Options for `createPipelineCollectionFromDirectory` function
  */
 type CreatePipelineCollectionFromUrlyOptions = {
     /**
@@ -22,7 +22,7 @@ type CreatePipelineCollectionFromUrlyOptions = {
  * @returns PipelineCollection
  * @public exported from `@promptbook/core`
  */
-export declare function createCollectionFromUrl(url: string_url | URL, options: CreatePipelineCollectionFromUrlyOptions): Promise<PipelineCollection>;
+export declare function createPipelineCollectionFromUrl(url: string_url | URL, options: CreatePipelineCollectionFromUrlyOptions): Promise<PipelineCollection>;
 export {};
 /**
  * TODO: [main] !!4 [🧠] Library precompilation and do not mix markdown and json promptbooks

package/esm/typings/src/collection/{constructors/createSubcollection.d.ts → pipeline-collection/constructors/createPipelineSubcollection.d.ts}

@@ -1,7 +1,7 @@
-import type { string_pipeline_url } from '../../types/typeAliases';
+import type { string_pipeline_url } from '../../../types/typeAliases';
 import type { PipelineCollection } from '../PipelineCollection';
 /**
- * Creates PipelineCollection as a subset of another PipelineCollection
+ * Creates `PipelineCollection` as a subset of another `PipelineCollection`
  *
  * Note: You can use any type of collection as a parent collection - local, remote, etc.
  * Note: This is just a thin wrapper / proxy around the parent collection
@@ -10,4 +10,4 @@ import type { PipelineCollection } from '../PipelineCollection';
  * @returns PipelineCollection
  * @public exported from `@promptbook/core`
  */
-export declare function createSubcollection(collection: PipelineCollection, predicate: (url: string_pipeline_url) => boolean): PipelineCollection;
+export declare function createPipelineSubcollection(collection: PipelineCollection, predicate: (url: string_pipeline_url) => boolean): PipelineCollection;

package/esm/typings/src/collection/pipeline-collection/pipelineCollectionToJson.d.ts

@@ -0,0 +1,13 @@
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { PipelineCollection } from './PipelineCollection';
+/**
+ * Converts PipelineCollection to serialized JSON
+ *
+ * Note: Functions `pipelineCollectionToJson` and `createPipelineCollectionFromJson` are complementary
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function pipelineCollectionToJson(collection: PipelineCollection): Promise<ReadonlyArray<PipelineJson>>;
+/**
+ * TODO: [🧠] Maybe clear `sourceFile` or clear when exposing through API or remote server
+ */

package/esm/typings/src/commands/_common/types/CommandParser.d.ts

@@ -1,10 +1,9 @@
 import type { SetOptional, WritableDeep } from 'type-fest';
 import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../../pipeline/PipelineJson/TaskJson';
-import type { string_markdown_text } from '../../../types/typeAliases';
-import type { string_name } from '../../../types/typeAliases';
-import type { string_promptbook_documentation_url } from '../../../types/typeAliases';
+import type { string_markdown_text, string_name, string_promptbook_documentation_url } from '../../../types/typeAliases';
 import type { string_SCREAMING_CASE } from '../../../utils/normalization/normalizeTo_SCREAMING_CASE';
+import { $side_effect } from '../../../utils/organization/$side_effect';
 import type { ___and___ } from '../../../utils/organization/___and___';
 import type { CommandUsagePlace } from './CommandUsagePlaces';
 /**
@@ -98,7 +97,7 @@ export type PipelineHeadCommandParser<TCommand extends CommandBase> = CommonComm
      *
      * Note: `$` is used to indicate that this function mutates given `pipelineJson`
      */
-    $applyToPipelineJson(command: TCommand, $pipelineJson: $PipelineJson): void;
+    $applyToPipelineJson(command: TCommand, $pipelineJson: $PipelineJson): $side_effect;
     /**
      * Reads the command from the `PipelineJson`
      *
@@ -126,7 +125,7 @@ export type PipelineTaskCommandParser<TCommand extends CommandBase> = CommonComm
      *
      * Note: `$` is used to indicate that this function mutates given `taskJson` and/or `pipelineJson`
      */
-    $applyToTaskJson(command: TCommand, $taskJson: $TaskJson, $pipelineJson: $PipelineJson): void;
+    $applyToTaskJson(command: TCommand, $taskJson: $TaskJson, $pipelineJson: $PipelineJson): $side_effect;
     /**
      * Reads the command from the `TaskJson`
      *

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

@@ -45,7 +45,20 @@ export declare const CLAIM = "Turn your company's scattered knowledge into AI re
  */
 export declare const PROMPTBOOK_COLOR: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
 /**
- * Dark color of the Promptbook
+ * Colors for syntax highlighting in the `<BookEditor/>`
+ *
+ * TODO: [🗽] Unite branding and make single place for it
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const PROMPTBOOK_SYNTAX_COLORS: {
+    readonly TITLE: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
+    readonly LINE: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
+    readonly COMMITMENT: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
+    readonly PARAMETER: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
+};
+/**
+ * Chat color of the Promptbook (in chat)
  *
  * TODO: [🗽] Unite branding and make single place for it
  *
@@ -220,6 +233,13 @@ export declare const DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL = 200;
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_BOOKS_DIRNAME = "./books";
+/**
+ * Where to store your agents (also book files)
+ * This is kind of a "src" for your books
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_AGENTS_DIRNAME = "./agents";
 /**
  * Where to store the temporary downloads
  *
@@ -257,7 +277,7 @@ export declare const CLI_APP_ID: string_app_id;
  */
 export declare const PLAYGROUND_APP_ID: string_app_id;
 /**
- * The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createCollectionFromDirectory`
+ * The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createPipelineCollectionFromDirectory`
  *
  * @public exported from `@promptbook/core`
  */

package/esm/typings/src/errors/0-index.d.ts

@@ -7,6 +7,7 @@ import { ExpectError } from './ExpectError';
 import { KnowledgeScrapeError } from './KnowledgeScrapeError';
 import { LimitReachedError } from './LimitReachedError';
 import { MissingToolsError } from './MissingToolsError';
+import { NotAllowed } from './NotAllowed';
 import { NotFoundError } from './NotFoundError';
 import { NotYetImplementedError } from './NotYetImplementedError';
 import { ParseError } from './ParseError';
@@ -40,6 +41,7 @@ export declare const PROMPTBOOK_ERRORS: {
     readonly PromptbookFetchError: typeof PromptbookFetchError;
     readonly UnexpectedError: typeof UnexpectedError;
     readonly WrappedError: typeof WrappedError;
+    readonly NotAllowed: typeof NotAllowed;
 };
 /**
  * Index of all javascript errors
@@ -88,6 +90,7 @@ export declare const ALL_ERRORS: {
     readonly PromptbookFetchError: typeof PromptbookFetchError;
     readonly UnexpectedError: typeof UnexpectedError;
     readonly WrappedError: typeof WrappedError;
+    readonly NotAllowed: typeof NotAllowed;
 };
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/errors/NotAllowed.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This error indicates that promptbook operation is not allowed
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class NotAllowed extends Error {
+    readonly name = "NotAllowed";
+    constructor(message: string);
+}

package/esm/typings/src/execution/AvailableModel.d.ts

@@ -46,5 +46,6 @@ export type AvailableModel = {
     readonly isDeprecated?: boolean;
 };
 /**
+ * TODO: [🕛] Extend this from sth like `AgentBasicInformation` / `ModelBasicInformation`
  * TODO: [🧠] Maybe rename to something else - like `ModelInformation` or `ModelMetadata`
  */

package/esm/typings/src/execution/Executables.d.ts

@@ -16,3 +16,6 @@ export type Executables = {
      */
     libreOfficePath?: string_executable_path;
 };
+/**
+ * <- TODO: Add !!! `browserPath` to `Executables`
+ */

package/esm/typings/src/execution/ExecutionTask.d.ts

@@ -1,8 +1,9 @@
 import type { Observable } from 'rxjs';
 import { PartialDeep } from 'type-fest';
-import type { number_percent } from '../types/typeAliases';
-import type { task_id } from '../types/typeAliases';
+import type { LlmCall } from '../types/LlmCall';
+import type { number_percent, task_id } from '../types/typeAliases';
 import type { string_SCREAMING_CASE } from '../utils/normalization/normalizeTo_SCREAMING_CASE';
+import type { really_any } from '../utils/organization/really_any';
 import type { string_promptbook_version } from '../version';
 import type { AbstractTaskResult } from './AbstractTaskResult';
 import type { PipelineExecutorResult } from './PipelineExecutorResult';
@@ -32,7 +33,7 @@ type CreateTaskOptions<TTaskResult extends AbstractTaskResult> = {
     }) => void, updateTldr: (tldrInfo: {
         readonly percent: number_percent;
         readonly message: string;
-    }) => void): Promise<TTaskResult>;
+    }) => void, logLlmCall: (llmCall: LlmCall) => void): Promise<TTaskResult>;
 };
 /**
  * Helper to create a new task
@@ -136,6 +137,14 @@ export type AbstractTask<TTaskResult extends AbstractTaskResult> = {
      * List of warnings that occurred during the task processing
      */
     readonly warnings: Array<Error>;
+    /**
+     * List of LLM calls that occurred during the task processing
+     */
+    readonly llmCalls: Array<LlmCall>;
+    /**
+     * Optional nonce to correlate logs with version of the Promptbook engine
+     */
+    readonly ptbkNonce?: really_any;
 };
 export type Task = ExecutionTask | PreparationTask;
 export {};

package/esm/typings/src/execution/ExecutionTools.d.ts

@@ -67,3 +67,8 @@ export type ExecutionTools = {
      */
     readonly userInterface?: UserInterfaceTools;
 };
+/**
+ * <- TODO: Add !!! `promptbookAgent` to `ExecutionTools`
+ * <- TODO: Add !!! `mcps` to `ExecutionTools`
+ * <- TODO: Add !!! `prepareCache` to `ExecutionTools`
+ */

package/esm/typings/src/execution/FilesystemTools.d.ts

@@ -3,7 +3,7 @@ import type fs from 'fs/promises';
 /**
  * Container for all the tools needed to manipulate with filesystem
  */
-export type FilesystemTools = Pick<typeof fs, 'access' | 'constants' | 'readFile' | 'writeFile' | 'stat' | 'readdir' | 'mkdir'>;
+export type FilesystemTools = Pick<typeof fs, 'access' | 'constants' | 'readFile' | 'writeFile' | 'stat' | 'readdir' | 'mkdir' | 'watch'>;
 /**
  * TODO: Implement destroyable pattern to free resources
  */

package/esm/typings/src/execution/LlmExecutionTools.d.ts

@@ -9,6 +9,12 @@ import type { ChatPromptResult, CompletionPromptResult, EmbeddingPromptResult }
  * On its interface it exposes common methods for prompt execution.
  * Inside (in constructor) it calls OpenAI, Azure, GPU, proxy, cache, logging,...
  *
+ * Note: [🦖] There are several different things in Promptbook:
+ * - `Agent` - which represents an AI Agent with its source, memories, actions, etc. Agent is a higher-level abstraction which is internally using:
+ * - `LlmExecutionTools` - which wraps one or more LLM models and provides an interface to execute them
+ * - `AgentLlmExecutionTools` - which is a specific implementation of `LlmExecutionTools` that wraps another LlmExecutionTools and applies agent-specific system prompts and requirements
+ * - `OpenAiAssistantExecutionTools` - which is a specific implementation of `LlmExecutionTools` for OpenAI models with assistant capabilities, recommended for usage in `Agent` or `AgentLlmExecutionTools`
+ *
  * @see https://github.com/webgptorg/promptbook#llm-execution-tools
  */
 export type LlmExecutionTools = {
@@ -56,7 +62,7 @@ export type LlmExecutionTools = {
     callEmbeddingModel?(prompt: Prompt): Promise<EmbeddingPromptResult>;
 };
 /**
- * TODO: [🕛] Extend this from sth class
+ * TODO: [🕛] Extend this from sth class -  like `AgentBasicInformation` / `ModelBasicInformation``
  * TODO: [🍚] Implement destroyable pattern to free resources
  * TODO: [🏳] Add `callTranslationModel`
  * TODO: [🧠] Emulation of one type of model with another one - emuate chat with completion; emulate translation with chat

package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts

@@ -2,6 +2,7 @@ import type { PartialDeep, Promisable, ReadonlyDeep } from 'type-fest';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { InputParameters } from '../../types/typeAliases';
 import type { PipelineExecutorResult } from '../PipelineExecutorResult';
+import type { LlmCall } from '../../types/LlmCall';
 import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
 /**
  * Options for executing an entire pipeline, including input parameters, pipeline context, and progress callbacks.
@@ -17,6 +18,10 @@ type ExecutePipelineOptions = Required<CreatePipelineExecutorOptions> & {
      * Optional callback invoked with partial results as the pipeline execution progresses.
      */
     onProgress?(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
+    /**
+     * Optional callback invoked with each LLM call.
+     */
+    logLlmCall?(llmCall: LlmCall): Promisable<void>;
     /**
      * The pipeline definition to execute.
      */

package/esm/typings/src/execution/createPipelineExecutor/20-executeTask.d.ts

@@ -2,6 +2,7 @@ import type { PartialDeep, Promisable, ReadonlyDeep, WritableDeep } from 'type-f
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { Parameters } from '../../types/typeAliases';
+import type { LlmCall } from '../../types/LlmCall';
 import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
 import type { PipelineExecutorResult } from '../PipelineExecutorResult';
 import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
@@ -27,6 +28,10 @@ type executeSingleTaskOptions = Required<CreatePipelineExecutorOptions> & {
      * Callback invoked with partial results as the execution progresses.
      */
     onProgress(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
+    /**
+     * Optional callback invoked with each LLM call.
+     */
+    logLlmCall?(llmCall: LlmCall): Promisable<void>;
     /**
      * Mutable execution report object for tracking execution details.
      */

package/esm/typings/src/execution/createPipelineExecutor/30-executeFormatSubvalues.d.ts

@@ -1,5 +1,6 @@
 import type { PartialDeep, Promisable } from 'type-fest';
 import type { TODO_any } from '../../utils/organization/TODO_any';
+import type { LlmCall } from '../../types/LlmCall';
 import type { PipelineExecutorResult } from '../PipelineExecutorResult';
 import type { ExecuteAttemptsOptions } from './40-executeAttempts';
 /**
@@ -13,6 +14,10 @@ type ExecuteFormatCellsOptions = ExecuteAttemptsOptions & {
      * Callback invoked with partial results as the execution progresses.
      */
     onProgress(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
+    /**
+     * Optional callback invoked with each LLM call.
+     */
+    logLlmCall?(llmCall: LlmCall): Promisable<void>;
 };
 /**
  * Executes a pipeline task that requires mapping or iterating over subvalues of a parameter (such as rows in a CSV).

package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts

@@ -3,6 +3,7 @@ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { Parameters, string_parameter_name } from '../../types/typeAliases';
 import type { TODO_string } from '../../utils/organization/TODO_string';
+import type { LlmCall } from '../../types/LlmCall';
 import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
 import type { PipelineExecutorResult } from '../PipelineExecutorResult';
 import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
@@ -50,6 +51,10 @@ export type ExecuteAttemptsOptions = Required<Omit<CreatePipelineExecutorOptions
      * Callback invoked with partial results as the execution progresses.
      */
     onProgress(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
+    /**
+     * Optional callback invoked with each LLM call.
+     */
+    logLlmCall?(llmCall: LlmCall): Promisable<void>;
     /**
      * The execution report object, which is updated during execution.
      */

package/esm/typings/src/execution/utils/logLlmCall.d.ts

@@ -0,0 +1,8 @@
+import type { LlmCall } from '../../types/LlmCall';
+import type { ExecutionPromptReportJson } from '../execution-report/ExecutionPromptReportJson';
+/**
+ * Logs an LLM call with the given report.
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function logLlmCall(logLlmCall: (llmCall: LlmCall) => void, report: ExecutionPromptReportJson): void;