@promptbook/openai 0.60.1 → 0.61.0-0

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

@@ -0,0 +1,9 @@
+import type { TupleToUnion } from 'type-fest';
+/**
+ * Where the command can be used
+ */
+export type CommandUsagePlace = TupleToUnion<typeof CommandUsagePlaces>;
+/**
+ * Where the command can be used
+ */
+export declare const CommandUsagePlaces: readonly ["PIPELINE_HEAD", "PIPELINE_TEMPLATE"];

package/esm/typings/src/commands/index.d.ts

@@ -0,0 +1,4 @@
+/**
+ * All available command parsers
+ */
+export declare const COMMANDS: readonly [import("./_common/types/CommandParser").CommandParser<import("./BLOCK/BlockCommand").BlockCommand>, import("./_common/types/CommandParser").CommandParser<import("./EXPECT/ExpectCommand").ExpectCommand>, import("./_common/types/CommandParser").CommandParser<import("./JOKER/JokerCommand").JokerCommand>, import("./_common/types/CommandParser").CommandParser<import("./MODEL/ModelCommand").ModelCommand>, import("./_common/types/CommandParser").CommandParser<import("./PARAMETER/ParameterCommand").ParameterCommand>, import("./_common/types/CommandParser").CommandParser<import("./POSTPROCESS/PostprocessCommand").PostprocessCommand>, import("./_common/types/CommandParser").CommandParser<import("./PROMPTBOOK_VERSION/PromptbookVersionCommand").PromptbookVersionCommand>, import("./_common/types/CommandParser").CommandParser<import("./URL/UrlCommand").UrlCommand>, import("./_common/types/CommandParser").CommandParser<import("./KNOWLEDGE/KnowledgeCommand").KnowledgeCommand>, import("./_common/types/CommandParser").CommandParser<import("./X_ACTION/ActionCommand").ActionCommand>, import("./_common/types/CommandParser").CommandParser<import("./X_INSTRUMENT/InstrumentCommand").InstrumentCommand>, import("./_common/types/CommandParser").CommandParser<import("./PERSONA/PersonaCommand").PersonaCommand>, import("./_common/types/CommandParser").CommandParser<import("./_BOILERPLATE/BoilerplateCommand").BoilerplateCommand>];

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

@@ -10,3 +10,7 @@ export declare const CHARACTER_LOOP_LIMIT = 100000;
  * The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createCollectionFromDirectory`
  */
 export declare const PIPELINE_COLLECTION_BASE_FILENAME = "index";
+/**
+ * The names of the parameters that are reserved for special purposes
+ */
+export declare const RESERVED_PARAMETER_NAMES: string[];

package/esm/typings/src/conversion/pipelineJsonToString.d.ts

@@ -8,5 +8,7 @@ import type { PipelineString } from '../types/PipelineString';
  */
 export declare function pipelineJsonToString(pipelineJson: PipelineJson): PipelineString;
 /**
+ * TODO: !!!!! Implement new features and commands into `promptTemplateParameterJsonToString`
+ * TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
  * TODO: Escape all
  */

package/esm/typings/src/conversion/pipelineStringToJson.d.ts

@@ -4,7 +4,7 @@ import type { PipelineString } from '../types/PipelineString';
 /**
  * Options for pipelineStringToJson
  */
-type PipelineStringToJsonOptions = {
+export type PipelineStringToJsonOptions = {
     /**
      * Tools for processing required for knowledge processing *(not for actual execution)*
      */
@@ -20,13 +20,12 @@ type PipelineStringToJsonOptions = {
  * @param pipelineString {Promptbook} in string markdown format (.ptbk.md)
  * @param options - Options and tools for the compilation
  * @returns {Promptbook} compiled in JSON format (.ptbk.json)
- * @throws {SyntaxError} if the promptbook string is not valid
+ * @throws {ParsingError} if the promptbook string is not valid
  *
  * Note: This function does not validate logic of the pipeline only the syntax
  * Note: This function acts as compilation process
  */
 export declare function pipelineStringToJson(pipelineString: PipelineString, options?: PipelineStringToJsonOptions): Promise<PipelineJson>;
-export {};
 /**
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
  */

package/esm/typings/src/conversion/pipelineStringToJsonSync.d.ts

@@ -10,14 +10,16 @@ import type { PipelineString } from '../types/PipelineString';
  * @param pipelineString {Promptbook} in string markdown format (.ptbk.md)
  * @param options - Options and tools for the compilation
  * @returns {Promptbook} compiled in JSON format (.ptbk.json)
- * @throws {SyntaxError} if the promptbook string is not valid
+ * @throws {ParsingError} if the promptbook string is not valid
  *
  * Note: This function does not validate logic of the pipeline only the syntax
  * Note: This function acts as compilation process
  */
 export declare function pipelineStringToJsonSync(pipelineString: PipelineString): PipelineJson;
 /**
- * TODO: Report here line/column of error
+ * TODO: !!!! Warn if used only sync version
+ * TODO: [🚞] Report here line/column of error
  * TODO: Use spaceTrim more effectively
  * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
+ * TODO: [🥞] Not optimal parsing because `splitMarkdownIntoSections` is executed twice with same string, once through `flattenMarkdown` and second directly here
  */

package/esm/typings/src/conversion/utils/extractParametersFromPromptTemplate.d.ts

@@ -5,9 +5,9 @@ import type { string_name } from '../../types/typeAliases';
  *
  * @param promptTemplate the template with used parameters
  * @returns the set of parameter names
- * @throws {SyntaxError} if the script is invalid
+ * @throws {ParsingError} if the script is invalid
  */
-export declare function extractParametersFromPromptTemplate(promptTemplate: Pick<PromptTemplateJson, 'title' | 'description' | 'executionType' | 'content'>): Set<string_name>;
+export declare function extractParametersFromPromptTemplate(promptTemplate: Pick<PromptTemplateJson, 'title' | 'description' | 'blockType' | 'content'>): Set<string_name>;
 /**
  * TODO: [🔣] If script require contentLanguage
  */

package/esm/typings/src/conversion/utils/extractVariables.d.ts

@@ -5,7 +5,7 @@ import type { string_javascript_name } from '../../types/typeAliases';
  *
  * @param script from which to extract the variables
  * @returns the list of variable names
- * @throws {SyntaxError} if the script is invalid
+ * @throws {ParsingError} if the script is invalid
  */
 export declare function extractVariables(script: string_javascript): Set<string_javascript_name>;
 /**

package/esm/typings/src/conversion/validation/validatePipeline-logicErrors.test.d.ts

@@ -1 +1,4 @@
 export {};
+/**
+ * TODO: Include automatically all samples from logic errors folder (same with syntax errors)
+ */

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

@@ -0,0 +1,7 @@
+/**
+ * This error type indicates that some part of the code is not implemented yet
+ */
+export declare class NotYetImplementedError extends Error {
+    readonly name = "NotYetImplementedError";
+    constructor(message: string);
+}

package/esm/typings/src/errors/{SyntaxError.d.ts → ParsingError.d.ts}

@@ -1,7 +1,7 @@
 /**
  * This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
  */
-export declare class SyntaxError extends Error {
-    readonly name = "SyntaxError";
+export declare class ParsingError extends Error {
+    readonly name = "ParsingError";
     constructor(message: string);
 }

package/{umd/typings/src/errors/ExecutionError.d.ts → esm/typings/src/errors/PipelineExecutionError.d.ts}

@@ -1,7 +1,7 @@
 /**
  * This error indicates errors during the execution of the pipeline
  */
-export declare class ExecutionError extends Error {
-    readonly name = "ExecutionError";
+export declare class PipelineExecutionError extends Error {
+    readonly name = "PipelineExecutionError";
     constructor(message: string);
 }

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

@@ -1,8 +1,8 @@
 /**
  * This error occurs when some expectation is not met in the execution of the pipeline
  *
- * @private Always catched and rethrown as `ExecutionError`
- * Note: This is a kindof subtype of ExecutionError
+ * @private Always catched and rethrown as `PipelineExecutionError`
+ * Note: This is a kindof subtype of PipelineExecutionError
  */
 export declare class ExpectError extends Error {
     readonly name = "ExpectError";

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

@@ -1,3 +1,4 @@
+import type { Arrayable } from '../types/Arrayable';
 import type { LlmExecutionTools } from './LlmExecutionTools';
 import type { ScriptExecutionTools } from './ScriptExecutionTools';
 import type { UserInterfaceTools } from './UserInterfaceTools';
@@ -10,10 +11,10 @@ export type ExecutionTools = {
     /**
      * Tools for executing prompts to large language models like GPT-4
      *
-     * Tip: Combine multiple LLM execution tools with `MultipleLlmExecutionTools`
+     * Tip: Combine multiple LLM execution tools - use array of LlmExecutionTools instead of single LlmExecutionTools
      * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#llm-execution-tools
      */
-    llm: LlmExecutionTools;
+    llm?: Arrayable<LlmExecutionTools>;
     /**
      * Tools for executing scripts
      *
@@ -21,7 +22,7 @@ export type ExecutionTools = {
      *       If none of them supports the script, an error is thrown
      * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#script-execution-tools
      */
-    script: Array<ScriptExecutionTools>;
+    script?: Arrayable<ScriptExecutionTools>;
     /**
      * Tools for interacting with the user
      *

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

@@ -1,10 +1,13 @@
 import type { Promisable } from 'type-fest';
 import type { ModelVariant } from '../types/ModelRequirements';
 import type { Prompt } from '../types/Prompt';
+import type { string_markdown } from '../types/typeAliases';
+import type { string_markdown_text } from '../types/typeAliases';
 import type { string_model_name } from '../types/typeAliases';
 import type { string_title } from '../types/typeAliases';
 import type { PromptChatResult } from './PromptResult';
 import type { PromptCompletionResult } from './PromptResult';
+import type { PromptEmbeddingResult } from './PromptResult';
 /**
  * Container for all the tools needed to execute prompts to large language models like GPT-4
  * On its interface it exposes common methods for prompt execution.
@@ -14,13 +17,29 @@ import type { PromptCompletionResult } from './PromptResult';
  */
 export type LlmExecutionTools = {
     /**
-     * Use a chat model
+     * Title of the model provider
+     *
+     * @example "OpenAI"
      */
-    callChatModel(prompt: Prompt): Promise<PromptChatResult>;
+    readonly title: string_title & string_markdown_text;
     /**
-     * Use a completion model
+     * Description of the provider
+     *
+     * @example "Use all models from OpenAI"
      */
-    callCompletionModel(prompt: Prompt): Promise<PromptCompletionResult>;
+    readonly description: string_markdown;
+    /**
+     * Calls a chat model
+     */
+    callChatModel?(prompt: Prompt): Promise<PromptChatResult>;
+    /**
+     * Calls a completion model
+     */
+    callCompletionModel?(prompt: Prompt): Promise<PromptCompletionResult>;
+    /**
+     * Calls an embedding model
+     */
+    callEmbeddingModel?(prompt: Prompt): Promise<PromptEmbeddingResult>;
     /**
      * List all available models that can be used
      */
@@ -44,8 +63,8 @@ export type AvailableModel = {
     readonly modelVariant: ModelVariant;
 };
 /**
+ * TODO: !!!! Translation model
  * TODO: [🧠] Emulation of one type of model with another one - emuate chat with completion; emulate translation with chat
  * TODO: [🍓][♐] Some heuristic to pick the best model in listed models
- * TODO: [🏳] callChatModel -> chat, callCompletionModel -> complete, translate
  * TODO: [🧠] Should or should not there be a word "GPT" in both callCompletionModel and callChatModel
  */

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

@@ -1,5 +1,5 @@
 import type { KebabCase } from 'type-fest';
-import type { ExpectationUnit } from '../types/PipelineJson/PromptTemplateJson';
+import type { ExpectationUnit } from '../types/PipelineJson/Expectations';
 import type { number_positive } from '../types/typeAliases';
 import type { number_usd } from '../types/typeAliases';
 import type { string_date_iso8601 } from '../types/typeAliases';
@@ -11,7 +11,7 @@ import type { EmbeddingVector } from './EmbeddingVector';
  *
  * @see https://github.com/webgptorg/promptbook#prompt-result
  */
-export type PromptResult = PromptCompletionResult | PromptChatResult;
+export type PromptResult = PromptCompletionResult | PromptChatResult | PromptEmbeddingResult;
 /**
  * Prompt completion result
  * It contains only the following text NOT the whole completion

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

@@ -3,7 +3,7 @@ import type { PipelineExecutor } from './PipelineExecutor';
  * Asserts that the execution of a promptnook is successful
  *
  * @param executionResult - The partial result of the promptnook execution
- * @throws {ExecutionError} If the execution is not successful or if multiple errors occurred
+ * @throws {PipelineExecutionError} If the execution is not successful or if multiple errors occurred
  */
 export declare function assertsExecutionSuccessful(executionResult: Pick<Awaited<ReturnType<PipelineExecutor>>, 'isSuccessful' | 'errors'>): void;
 /**

package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts

@@ -2,6 +2,6 @@
  *
  * @param message
  * @returns
- * @throws {ExecutionError}
+ * @throws {PipelineExecutionError}
  */
 export declare function extractMultiplicatedOccurrence(message: string): string;

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

@@ -1,4 +1,4 @@
-import type { Expectations } from '../../types/PipelineJson/PromptTemplateJson';
+import type { Expectations } from '../../types/PipelineJson/Expectations';
 /**
  * Function checkExpectations will check if the expectations on given value are met
  *

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

@@ -6,7 +6,7 @@ import type { string_template } from '../../types/typeAliases';
  * @param template the template with parameters in {curly} braces
  * @param parameters the object with parameters
  * @returns the template with replaced parameters
- * @throws {TemplateError} if parameter is not defined, not closed, or not opened
+ * @throws {PipelineExecutionError} if parameter is not defined, not closed, or not opened
  *
  * @private within the createPipelineExecutor
  */

package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts

@@ -8,6 +8,8 @@ type PrepareKnowledgeFromMarkdownOptions = {
     content: string_markdown;
     /**
      * The LLM tools to use for the conversion and extraction of knowledge
+     *
+     * Note: If you want to use multiple LLMs, you can use `joinLlmExecutionTools` to join them first
      */
     llmTools: LlmExecutionTools;
     /**
@@ -19,3 +21,6 @@ type PrepareKnowledgeFromMarkdownOptions = {
 };
 export declare function prepareKnowledgeFromMarkdown(options: PrepareKnowledgeFromMarkdownOptions): Promise<KnowledgeJson>;
 export {};
+/**
+ * 11:11
+ */

package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts

@@ -1,8 +1,10 @@
 import type { AvailableModel } from '../../execution/LlmExecutionTools';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { PromptChatResult } from '../../execution/PromptResult';
-import type { PromptCompletionResult } from '../../execution/PromptResult';
 import type { Prompt } from '../../types/Prompt';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_title } from '../../types/typeAliases';
 import type { AnthropicClaudeExecutionToolsOptions } from './AnthropicClaudeExecutionToolsOptions';
 /**
  * Execution Tools for calling Anthropic Claude API.
@@ -19,14 +21,12 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
      * @param options which are relevant are directly passed to the Anthropic Claude client
      */
     constructor(options?: AnthropicClaudeExecutionToolsOptions);
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
     /**
      * Calls Anthropic Claude API to use a chat model.
      */
     callChatModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptChatResult>;
-    /**
-     * Calls Anthropic Claude API to use a complete model.
-     */
-    callCompletionModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptCompletionResult>;
     /**
      * Get the model that should be used as default
      */

package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts

@@ -14,6 +14,7 @@ export declare const ANTHROPIC_CLAUDE_MODELS: Array<AvailableModel & {
     };
 }>;
 /**
+ * Note: [🤖] Add models of new variant
  * TODO: !!!! Add embedding models OR Anthropic has only chat+completion models?
  * TODO: [🧠] Some mechanism to propagate unsureness
  * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths (	Top-level performance, intelligence, fluency, and understanding), contextWindow,...

package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts

@@ -3,6 +3,9 @@ import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { PromptChatResult } from '../../execution/PromptResult';
 import type { PromptCompletionResult } from '../../execution/PromptResult';
 import type { Prompt } from '../../types/Prompt';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_title } from '../../types/typeAliases';
 import type { AzureOpenAiExecutionToolsOptions } from './AzureOpenAiExecutionToolsOptions';
 /**
  * Execution Tools for calling Azure OpenAI API.
@@ -19,6 +22,8 @@ export declare class AzureOpenAiExecutionTools implements LlmExecutionTools {
      * @param options which are relevant are directly passed to the OpenAI client
      */
     constructor(options: AzureOpenAiExecutionToolsOptions);
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
     /**
      * Calls OpenAI API to use a chat model.
      */

package/esm/typings/src/llm-providers/langtail/LangtailExecutionTools.d.ts

@@ -1,7 +1,12 @@
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_title } from '../../types/typeAliases';
 import { OpenAiExecutionTools } from '../openai/OpenAiExecutionTools';
 /**
  * Execution Tools for calling OpenAI API.
  */
 export declare class LangtailExecutionTools extends OpenAiExecutionTools implements LlmExecutionTools {
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
 }

package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts

@@ -4,12 +4,17 @@ import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { PromptChatResult } from '../../execution/PromptResult';
 import type { PromptCompletionResult } from '../../execution/PromptResult';
 import type { Prompt } from '../../types/Prompt';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_title } from '../../types/typeAliases';
 /**
  * Mocked execution Tools for just echoing the requests for testing purposes.
  */
 export declare class MockedEchoLlmExecutionTools implements LlmExecutionTools {
     private readonly options;
     constructor(options?: CommonExecutionToolsOptions);
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
     /**
      * Mocks chat model
      */

package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts

@@ -3,13 +3,19 @@ import type { AvailableModel } from '../../execution/LlmExecutionTools';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { PromptChatResult } from '../../execution/PromptResult';
 import type { PromptCompletionResult } from '../../execution/PromptResult';
+import type { PromptEmbeddingResult } from '../../execution/PromptResult';
 import type { Prompt } from '../../types/Prompt';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_title } from '../../types/typeAliases';
 /**
  * Mocked execution Tools for just faking expected responses for testing purposes
  */
 export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools {
     private readonly options;
     constructor(options?: CommonExecutionToolsOptions);
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
     /**
      * Fakes chat model
      */
@@ -18,6 +24,10 @@ export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools
      * Fakes completion model
      */
     callCompletionModel(prompt: Pick<Prompt, 'content' | 'modelRequirements' | 'expectations' | 'postprocessing'>): Promise<PromptCompletionResult>;
+    /**
+     * Fakes embedding model
+     */
+    callEmbeddingModel(prompt: Pick<Prompt, 'content' | 'modelRequirements' | 'expectations' | 'postprocessing'>): Promise<PromptEmbeddingResult>;
     /**
      * List all available fake-models that can be used
      */

package/esm/typings/src/llm-providers/mocked/fakeTextToExpectations.d.ts

@@ -1,5 +1,5 @@
 import type { PostprocessingFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
-import type { Expectations } from '../../types/PipelineJson/PromptTemplateJson';
+import type { Expectations } from '../../types/PipelineJson/Expectations';
 /**
  * Gets the expectations and creates a fake text that meets the expectations
  *

package/esm/typings/src/llm-providers/mocked/test/fakeTextToExpectations.test.d.ts

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

package/esm/typings/src/llm-providers/mocked/test/faked-completion.test.d.ts

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

package/esm/typings/src/llm-providers/mocked/test/mocked-chat.test.d.ts

@@ -0,0 +1,5 @@
+export {};
+/**
+ * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPipelineExecutor.test.ts"
+ * Note: [🤖] For each new model variant consider adding new testing unit like "faked-completion.test.ts", "mocked-chat.test.ts" and "mocked-completion.test.ts"
+ */

package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts

@@ -2,11 +2,15 @@ import type { AvailableModel } from '../../execution/LlmExecutionTools';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { PromptChatResult } from '../../execution/PromptResult';
 import type { PromptCompletionResult } from '../../execution/PromptResult';
+import type { PromptEmbeddingResult } from '../../execution/PromptResult';
 import type { Prompt } from '../../types/Prompt';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_title } from '../../types/typeAliases';
 /**
  * Multiple LLM Execution Tools is a proxy server that uses multiple execution tools internally and exposes the executor interface externally.
  *
- * @see https://github.com/webgptorg/promptbook#multiple-server
+ * @private Internal utility of `joinLlmExecutionTools`
  */
 export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
     /**
@@ -17,6 +21,8 @@ export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
      * Gets array of execution tools in order of priority
      */
     constructor(...llmExecutionTools: Array<LlmExecutionTools>);
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
     /**
      * Calls the best available chat model
      */
@@ -25,6 +31,10 @@ export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
      * Calls the best available completion model
      */
     callCompletionModel(prompt: Prompt): Promise<PromptCompletionResult>;
+    /**
+     * Calls the best available embedding model
+     */
+    callEmbeddingModel(prompt: Prompt): Promise<PromptEmbeddingResult>;
     /**
      * Calls the best available model
      */
@@ -35,3 +45,6 @@ export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
      */
     listModels(): Promise<Array<AvailableModel>>;
 }
+/**
+ * TODO: [🧠][🎛] Aggregating multiple models - have result not only from one first aviable model BUT all of them
+ */

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

@@ -0,0 +1,16 @@
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import { MultipleLlmExecutionTools } from './MultipleLlmExecutionTools';
+/**
+ * Joins multiple LLM Execution Tools into one
+ *
+ * @returns {LlmExecutionTools} Single wrapper for multiple LlmExecutionTools
+ *
+ * 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
+ *
+ *
+ * Tip: You don't have to use this function directly, just pass an array of LlmExecutionTools to the `ExecutionTools`
+ */
+export declare function joinLlmExecutionTools(...llmExecutionTools: Array<LlmExecutionTools>): MultipleLlmExecutionTools;

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

@@ -4,6 +4,9 @@ import type { PromptChatResult } from '../../execution/PromptResult';
 import type { PromptCompletionResult } from '../../execution/PromptResult';
 import type { PromptEmbeddingResult } from '../../execution/PromptResult';
 import type { Prompt } from '../../types/Prompt';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_title } from '../../types/typeAliases';
 import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
 /**
  * Execution Tools for calling OpenAI API.
@@ -20,6 +23,8 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
      * @param options which are relevant are directly passed to the OpenAI client
      */
     constructor(options?: OpenAiExecutionToolsOptions);
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
     /**
      * Calls OpenAI API to use a chat model.
      */
@@ -31,7 +36,7 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
     /**
      * Calls OpenAI API to use a embedding model
      */
-    embed(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptEmbeddingResult>;
+    callEmbeddingModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptEmbeddingResult>;
     /**
      * Get the model that should be used as default
      */

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

@@ -7,7 +7,7 @@ import type { Prompt } from '../../types/Prompt';
  * @param promptContent The content of the prompt
  * @param resultContent The content of the result (for embedding prompts or failed prompts pass empty string)
  * @param rawResponse The raw response from OpenAI API
- * @throws {ExecutionError} If the usage is not defined in the response from OpenAI
+ * @throws {PipelineExecutionError} If the usage is not defined in the response from OpenAI
  * @private internal util of `OpenAiExecutionTools`
  */
 export declare function computeOpenaiUsage(promptContent: Prompt['content'], // <- Note: Intentionally using [] to access type properties to bring jsdoc from Prompt/PromptResult to consumer

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

@@ -15,6 +15,7 @@ export declare const OPENAI_MODELS: Array<AvailableModel & {
     };
 }>;
 /**
+ * Note: [🤖] Add models of new variant
  * TODO: [🧠] Some mechanism to propagate unsureness
  * TODO: [🕚][👮‍♀️] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing
  * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths (	Top-level performance, intelligence, fluency, and understanding), contextWindow,...

package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts

@@ -2,7 +2,11 @@ import type { AvailableModel } from '../../execution/LlmExecutionTools';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { PromptChatResult } from '../../execution/PromptResult';
 import type { PromptCompletionResult } from '../../execution/PromptResult';
+import type { PromptEmbeddingResult } from '../../execution/PromptResult';
 import type { Prompt } from '../../types/Prompt';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_title } from '../../types/typeAliases';
 import type { RemoteLlmExecutionToolsOptions } from './RemoteLlmExecutionToolsOptions';
 /**
  * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
@@ -15,20 +19,26 @@ import type { RemoteLlmExecutionToolsOptions } from './RemoteLlmExecutionToolsOp
 export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
     private readonly options;
     constructor(options: RemoteLlmExecutionToolsOptions);
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
     /**
      * Creates a connection to the remote proxy server.
      */
     private makeConnection;
     /**
-     * Calls remote proxy server to use a chat model.
+     * Calls remote proxy server to use a chat model
      */
     callChatModel(prompt: Prompt): Promise<PromptChatResult>;
     /**
-     * Calls remote proxy server to use a completion model.
+     * Calls remote proxy server to use a completion model
      */
     callCompletionModel(prompt: Prompt): Promise<PromptCompletionResult>;
     /**
-     * Calls remote proxy server to use both completion or chat model.
+     * Calls remote proxy server to use a embedding model
+     */
+    callEmbeddingModel(prompt: Prompt): Promise<PromptEmbeddingResult>;
+    /**
+     * Calls remote proxy server to use both completion or chat model
      */
     private callModelCommon;
     /**

package/esm/typings/src/llm-providers/remote/startRemoteServer.d.ts

@@ -15,4 +15,5 @@ export declare function startRemoteServer(options: RemoteServerOptions): IDestro
  * TODO: [🤹‍♂️] Do not hang up immediately but wait until client closes OR timeout
  * TODO: [🤹‍♂️] Timeout on chat to free up resources
  * TODO: [🃏] Pass here some security token to prevent malitious usage and/or DDoS
+ * TODO: [0] Set unavailable models as undefined in `RemoteLlmExecutionTools` NOT throw error here
  */

package/esm/typings/src/personas/personaToModelRequirements.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Function personaToModelRequirements will @@@
+ *
+ * @private within the package
+ */
+export declare function personaToModelRequirements(value: string): boolean;