@promptbook/openai 0.103.0-4 → 0.103.0-40

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;

package/esm/typings/src/execution/utils/usage-constants.d.ts

@@ -3,145 +3,25 @@
  *
  * @public exported from `@promptbook/core`
  */
-export declare const ZERO_VALUE: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    readonly value: 0;
-}>;
+export declare const ZERO_VALUE: any;
 /**
  * Represents the uncertain value
  *
  * @public exported from `@promptbook/core`
  */
-export declare const UNCERTAIN_ZERO_VALUE: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    readonly value: 0;
-    readonly isUncertain: true;
-}>;
+export declare const UNCERTAIN_ZERO_VALUE: any;
 /**
  * Represents the usage with no resources consumed
  *
  * @public exported from `@promptbook/core`
  */
-export declare const ZERO_USAGE: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    readonly price: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-        readonly value: 0;
-    }>;
-    readonly input: {
-        readonly tokensCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-            readonly value: 0;
-        }>;
-        readonly charactersCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-            readonly value: 0;
-        }>;
-        readonly wordsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-            readonly value: 0;
-        }>;
-        readonly sentencesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-            readonly value: 0;
-        }>;
-        readonly linesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-            readonly value: 0;
-        }>;
-        readonly paragraphsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-            readonly value: 0;
-        }>;
-        readonly pagesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-            readonly value: 0;
-        }>;
-    };
-    readonly output: {
-        readonly tokensCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-            readonly value: 0;
-        }>;
-        readonly charactersCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-            readonly value: 0;
-        }>;
-        readonly wordsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-            readonly value: 0;
-        }>;
-        readonly sentencesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-            readonly value: 0;
-        }>;
-        readonly linesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-            readonly value: 0;
-        }>;
-        readonly paragraphsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-            readonly value: 0;
-        }>;
-        readonly pagesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-            readonly value: 0;
-        }>;
-    };
-}>;
+export declare const ZERO_USAGE: any;
 /**
  * Represents the usage with unknown resources consumed
  *
  * @public exported from `@promptbook/core`
  */
-export declare const UNCERTAIN_USAGE: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    readonly price: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-        readonly value: 0;
-        readonly isUncertain: true;
-    }>;
-    readonly input: {
-        readonly tokensCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-            readonly value: 0;
-            readonly isUncertain: true;
-        }>;
-        readonly charactersCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-            readonly value: 0;
-            readonly isUncertain: true;
-        }>;
-        readonly wordsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-            readonly value: 0;
-            readonly isUncertain: true;
-        }>;
-        readonly sentencesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-            readonly value: 0;
-            readonly isUncertain: true;
-        }>;
-        readonly linesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-            readonly value: 0;
-            readonly isUncertain: true;
-        }>;
-        readonly paragraphsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-            readonly value: 0;
-            readonly isUncertain: true;
-        }>;
-        readonly pagesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-            readonly value: 0;
-            readonly isUncertain: true;
-        }>;
-    };
-    readonly output: {
-        readonly tokensCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-            readonly value: 0;
-            readonly isUncertain: true;
-        }>;
-        readonly charactersCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-            readonly value: 0;
-            readonly isUncertain: true;
-        }>;
-        readonly wordsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-            readonly value: 0;
-            readonly isUncertain: true;
-        }>;
-        readonly sentencesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-            readonly value: 0;
-            readonly isUncertain: true;
-        }>;
-        readonly linesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-            readonly value: 0;
-            readonly isUncertain: true;
-        }>;
-        readonly paragraphsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-            readonly value: 0;
-            readonly isUncertain: true;
-        }>;
-        readonly pagesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-            readonly value: 0;
-            readonly isUncertain: true;
-        }>;
-    };
-}>;
+export declare const UNCERTAIN_USAGE: any;
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */

package/esm/typings/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts

@@ -1,4 +1,5 @@
 import type { $PipelineJson } from '../../commands/_common/types/CommandParser';
+import { $side_effect } from '../../utils/organization/$side_effect';
 /**
  * Used in `parsePipeline`
  *
@@ -11,7 +12,7 @@ export type SyncHighLevelAbstraction = {
      *
      * Note: `$` is used to indicate that this function mutates given `pipelineJson`
      */
-    $applyToPipelineJson($pipelineJson: $PipelineJson): void;
+    $applyToPipelineJson($pipelineJson: $PipelineJson): $side_effect;
 };
 /**
  * TODO: [♓️] Add order here

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

@@ -1,4 +1,5 @@
 import type { string_filename, string_markdown } from '../../../types/typeAliases';
+import { $side_effect } from '../../../utils/organization/$side_effect';
 /**
  * Pass the `.env` file which was used to configure LLM tools
  *
@@ -6,7 +7,7 @@ import type { string_filename, string_markdown } from '../../../types/typeAliase
  *
  * @private internal log of `$provideLlmToolsConfigurationFromEnv` and `$registeredLlmToolsMessage`
  */
-export declare function $setUsedEnvFilename(filepath: string_filename): void;
+export declare function $setUsedEnvFilename(filepath: string_filename): $side_effect;
 /**
  * Creates a message with all registered LLM tools
  *

package/esm/typings/src/llm-providers/agent/Agent.d.ts

@@ -0,0 +1,49 @@
+import { BehaviorSubject } from 'rxjs';
+import { AgentBasicInformation, BookParameter, LlmExecutionTools, string_agent_name, string_book, string_url_image } from '../../_packages/types.index';
+import { AgentOptions } from './AgentOptions';
+/**
+ * Represents one AI Agent
+ *
+ * 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`
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class Agent implements AgentBasicInformation {
+    private readonly options;
+    /**
+     * Name of the agent
+     */
+    agentName: string_agent_name | null;
+    /**
+     * Description of the agent
+     */
+    personaDescription: string | null;
+    /**
+     * Metadata like image or color
+     */
+    meta: {
+        image?: string_url_image;
+        link?: string;
+        title?: string;
+        description?: string;
+        [key: string]: string | undefined;
+    };
+    /**
+     * Not used in Agent, always returns empty array
+     */
+    get parameters(): BookParameter[];
+    readonly agentSource: BehaviorSubject<string_book>;
+    constructor(options: AgentOptions);
+    /**
+     * Creates LlmExecutionTools which exposes the agent as a model
+     */
+    getLlmExecutionTools(): LlmExecutionTools;
+}
+/**
+ * TODO: [🧠][😰]Agent is not working with the parameters, should it be?
+ * TODO: !!! Agent on remote server
+ */

package/esm/typings/src/llm-providers/agent/AgentLlmExecutionTools.d.ts

@@ -1,20 +1,25 @@
 import type { Promisable } from 'type-fest';
-import type { string_book } from '../../book-2.0/agent-source/string_book';
 import type { ChatParticipant } from '../../book-components/Chat/types/ChatParticipant';
 import type { AvailableModel } from '../../execution/AvailableModel';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { ChatPromptResult } from '../../execution/PromptResult';
 import type { Prompt } from '../../types/Prompt';
 import type { string_markdown, string_markdown_text, string_model_name, string_title } from '../../types/typeAliases';
+import { CreateAgentLlmExecutionToolsOptions } from './CreateAgentLlmExecutionToolsOptions';
 /**
  * Execution Tools for calling LLM models with a predefined agent "soul"
  * This wraps underlying LLM execution tools and applies agent-specific system prompts and requirements
  *
+ * 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`
+ *
  * @public exported from `@promptbook/core`
  */
 export declare class AgentLlmExecutionTools implements LlmExecutionTools {
-    private readonly llmTools;
-    private readonly agentSource;
+    private readonly options;
     /**
      * Cached model requirements to avoid re-parsing the agent source
      */
@@ -29,7 +34,7 @@ export declare class AgentLlmExecutionTools implements LlmExecutionTools {
      * @param llmTools The underlying LLM execution tools to wrap
      * @param agentSource The agent source string that defines the agent's behavior
      */
-    constructor(llmTools: LlmExecutionTools, agentSource: string_book);
+    constructor(options: CreateAgentLlmExecutionToolsOptions);
     /**
      * Get cached or parse agent information
      */

package/esm/typings/src/llm-providers/agent/AgentOptions.d.ts

@@ -0,0 +1,17 @@
+import { CommonToolsOptions, ExecutionTools, string_book } from '../../_packages/types.index';
+import { Updatable } from '../../types/Updatable';
+/**
+ * Options for creating an Agent
+ */
+export type AgentOptions = CommonToolsOptions & {
+    /**
+     * The execution tools available to the agent
+     *
+     * Here the agent has access to various LLM models, browser, scrapers, LibreOffice, tools, etc.
+     */
+    executionTools: ExecutionTools;
+    /**
+     * The source of the agent
+     */
+    agentSource: Updatable<string_book>;
+};

package/esm/typings/src/llm-providers/agent/CreateAgentLlmExecutionToolsOptions.d.ts

@@ -0,0 +1,16 @@
+import type { string_book } from '../../_packages/types.index';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { OpenAiAssistantExecutionTools } from '../openai/OpenAiAssistantExecutionTools';
+/**
+ * Options for creating AgentLlmExecutionTools
+ */
+export type CreateAgentLlmExecutionToolsOptions = {
+    /**
+     * The underlying LLM execution tools to wrap
+     */
+    llmTools: LlmExecutionTools | OpenAiAssistantExecutionTools;
+    /**
+     * The agent source string that defines the agent's behavior
+     */
+    agentSource: string_book;
+};