@promptbook/openai 0.60.0 → 0.61.0-0

package/umd/typings/src/commands/EXPECT/expectCommand.test.d.ts

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

package/umd/typings/src/commands/EXPECT/expectCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { ExpectCommand } from './ExpectCommand';
+/**
+ * Parses the expect command
+ *
+ * @see ./EXPECT-README.md for more details
+ * @private within the commands folder
+ */
+export declare const expectCommandParser: CommandParser<ExpectCommand>;

package/umd/typings/src/commands/JOKER/JokerCommand.d.ts

@@ -0,0 +1,11 @@
+import type { string_name } from '../../types/typeAliases';
+/**
+ * Parsed JOKER command
+ *
+ * @see ./jokerCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type JokerCommand = {
+    readonly type: 'JOKER';
+    readonly parameterName: string_name;
+};

package/umd/typings/src/commands/JOKER/jokerCommand.test.d.ts

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

package/umd/typings/src/commands/JOKER/jokerCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { JokerCommand } from './JokerCommand';
+/**
+ * Parses the joker command
+ *
+ * @see ./JOKER-README.md for more details
+ * @private within the commands folder
+ */
+export declare const jokerCommandParser: CommandParser<JokerCommand>;

package/umd/typings/src/commands/KNOWLEDGE/KnowledgeCommand.d.ts

@@ -0,0 +1,12 @@
+import type { string_file_relative_path } from '../../types/typeAliases';
+import type { string_url } from '../../types/typeAliases';
+/**
+ * Parsed KNOWLEDGE command
+ *
+ * @see ./knowledgeCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type KnowledgeCommand = {
+    readonly type: 'KNOWLEDGE';
+    readonly source: string_url | string_file_relative_path;
+};

package/umd/typings/src/commands/KNOWLEDGE/knowledgeCommand.test.d.ts

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

package/umd/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { KnowledgeCommand } from './KnowledgeCommand';
+/**
+ * Parses the knowledge command
+ *
+ * @see ./KNOWLEDGE-README.md for more details
+ * @private within the commands folder
+ */
+export declare const knowledgeCommandParser: CommandParser<KnowledgeCommand>;

package/umd/typings/src/commands/MODEL/ModelCommand.d.ts

@@ -0,0 +1,13 @@
+import type { ModelRequirements } from '../../types/ModelRequirements';
+import type { TODO } from '../../types/typeAliases';
+/**
+ * Parsed MODEL command
+ *
+ * @see ./modelCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type ModelCommand = {
+    readonly type: 'MODEL';
+    readonly key: keyof ModelRequirements;
+    readonly value: TODO;
+};

package/umd/typings/src/commands/MODEL/modelCommand.test.d.ts

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

package/umd/typings/src/commands/MODEL/modelCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { ModelCommand } from './ModelCommand';
+/**
+ * Parses the model command
+ *
+ * @see ./MODEL-README.md for more details
+ * @private within the commands folder
+ */
+export declare const modelCommandParser: CommandParser<ModelCommand>;

package/umd/typings/src/commands/PARAMETER/ParameterCommand.d.ts

@@ -0,0 +1,15 @@
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_name } from '../../types/typeAliases';
+/**
+ * Parsed PARAMETER command
+ *
+ * @see ./parameterCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type ParameterCommand = {
+    readonly type: 'PARAMETER';
+    readonly isInput: boolean;
+    readonly isOutput: boolean;
+    readonly parameterName: string_name;
+    readonly parameterDescription: string_markdown_text | null;
+};

package/umd/typings/src/commands/PARAMETER/parameterCommand.test.d.ts

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

package/umd/typings/src/commands/PARAMETER/parameterCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { ParameterCommand } from './ParameterCommand';
+/**
+ * Parses the parameter command
+ *
+ * @see ./PARAMETER-README.md for more details
+ * @private within the commands folder
+ */
+export declare const parameterCommandParser: CommandParser<ParameterCommand>;

package/umd/typings/src/commands/PERSONA/PersonaCommand.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Parsed PERSONA command
+ *
+ * @see ./personaCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type PersonaCommand = {
+    readonly type: 'PERSONA';
+    personaName: string;
+    personaDescription: string | null;
+};

package/umd/typings/src/commands/PERSONA/personaCommand.test.d.ts

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

package/umd/typings/src/commands/PERSONA/personaCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { PersonaCommand } from './PersonaCommand';
+/**
+ * Parses the persona command
+ *
+ * @see ./PERSONA-README.md for more details
+ * @private within the commands folder
+ */
+export declare const personaCommandParser: CommandParser<PersonaCommand>;

package/umd/typings/src/commands/POSTPROCESS/PostprocessCommand.d.ts

@@ -0,0 +1,11 @@
+import type { string_name } from '../../types/typeAliases';
+/**
+ * Parsed POSTPROCESS command
+ *
+ * @see ./postprocessCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type PostprocessCommand = {
+    readonly type: 'POSTPROCESS';
+    readonly functionName: string_name;
+};

package/umd/typings/src/commands/POSTPROCESS/postprocessCommand.test.d.ts

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

package/umd/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { PostprocessCommand } from './PostprocessCommand';
+/**
+ * Parses the postprocess command
+ *
+ * @see ./POSTPROCESS-README.md for more details
+ * @private within the commands folder
+ */
+export declare const postprocessCommandParser: CommandParser<PostprocessCommand>;

package/umd/typings/src/commands/PROMPTBOOK_VERSION/PromptbookVersionCommand.d.ts

@@ -0,0 +1,11 @@
+import type { string_semantic_version } from '../../types/typeAliases';
+/**
+ * Parsed PROMPTBOOK_VERSION command
+ *
+ * @see ./promptbookVersionCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type PromptbookVersionCommand = {
+    readonly type: 'PROMPTBOOK_VERSION';
+    readonly promptbookVersion: string_semantic_version;
+};

package/umd/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommand.test.d.ts

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

package/umd/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { PromptbookVersionCommand } from './PromptbookVersionCommand';
+/**
+ * Parses the PROMPTBOOK_VERSION command
+ *
+ * @see ./PROMPTBOOK_VERSION-README.md for more details
+ * @private within the commands folder
+ */
+export declare const promptbookVersionCommandParser: CommandParser<PromptbookVersionCommand>;

package/umd/typings/src/commands/URL/UrlCommand.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Parsed URL command
+ *
+ * @see ./urlCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type UrlCommand = {
+    readonly type: 'URL';
+    readonly pipelineUrl: URL;
+};

package/umd/typings/src/commands/URL/urlCommand.test.d.ts

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

package/umd/typings/src/commands/URL/urlCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { UrlCommand } from './UrlCommand';
+/**
+ * Parses the url command
+ *
+ * @see ./URL-README.md for more details
+ * @private within the commands folder
+ */
+export declare const urlCommandParser: CommandParser<UrlCommand>;

package/umd/typings/src/commands/X_ACTION/ActionCommand.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Parsed ACTION command
+ *
+ * @see ./actionCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type ActionCommand = {
+    readonly type: 'ACTION';
+};

package/umd/typings/src/commands/X_ACTION/actionCommand.test.d.ts

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

package/umd/typings/src/commands/X_ACTION/actionCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { ActionCommand } from './ActionCommand';
+/**
+ * Parses the action command
+ *
+ * @see ./ACTION-README.md for more details
+ * @private within the commands folder
+ */
+export declare const actionCommandParser: CommandParser<ActionCommand>;

package/umd/typings/src/commands/X_INSTRUMENT/InstrumentCommand.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Parsed INSTRUMENT command
+ *
+ * @see ./instrumentCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type InstrumentCommand = {
+    readonly type: 'INSTRUMENT';
+};

package/umd/typings/src/commands/X_INSTRUMENT/instrumentCommand.test.d.ts

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

package/umd/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { InstrumentCommand } from './InstrumentCommand';
+/**
+ * Parses the instrument command
+ *
+ * @see ./INSTRUMENT-README.md for more details
+ * @private within the commands folder
+ */
+export declare const instrumentCommandParser: CommandParser<InstrumentCommand>;

package/umd/typings/src/commands/_BOILERPLATE/BoilerplateCommand.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Parsed BOILERPLATE command
+ *
+ * @see ./boilerplateCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type BoilerplateCommand = {
+    readonly type: 'BOILERPLATE';
+    readonly value: string;
+};

package/umd/typings/src/commands/_BOILERPLATE/boilerplateCommand.test.d.ts

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

package/umd/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts

@@ -0,0 +1,12 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { BoilerplateCommand } from './BoilerplateCommand';
+/**
+ * Parses the boilerplate command
+ *
+ * @see ./BOILERPLATE-README.md for more details
+ * @private within the commands folder
+ */
+export declare const boilerplateCommandParser: CommandParser<BoilerplateCommand>;
+/**
+ * TODO: [💐] Implement BOILERPLATE command into `pipelineStringToJsonSync` function
+ */

package/umd/typings/src/commands/_common/parseCommand.d.ts

@@ -0,0 +1,12 @@
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { Command } from './types/Command';
+import type { CommandUsagePlace } from './types/CommandUsagePlaces';
+/**
+ * Parses one line of ul/ol to command
+ *
+ * @returns parsed command object
+ * @throws {ParsingError} if the command is invalid
+ *
+ * @private within the pipelineStringToJson
+ */
+export declare function parseCommand(raw: string_markdown_text, usagePlace: CommandUsagePlace): Command;

package/umd/typings/src/commands/_common/parseCommand.test.d.ts

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

package/umd/typings/src/commands/_common/types/Command.d.ts

@@ -0,0 +1,6 @@
+import { COMMANDS } from '../../index';
+/**
+ * Command is one piece of the prompt template which adds some logic to the prompt template or the whole pipeline.
+ * It is parsed from the markdown from ul/ol items - one command per one item.
+ */
+export type Command = ReturnType<typeof COMMANDS[number]['parse']>;

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

@@ -0,0 +1,36 @@
+import type { string_markdown_text } from '../../../types/typeAliases';
+import type { string_name } from '../../../types/typeAliases';
+import type { string_SCREAMING_CASE } from '../../../utils/normalization/normalizeTo_SCREAMING_CASE';
+import type { CommandUsagePlace } from './CommandUsagePlaces';
+export type CommandParser<TCommand extends {
+    type: string_name & string_SCREAMING_CASE;
+}> = {
+    name: string_name & string_SCREAMING_CASE;
+    aliasNames?: Array<string_name & string_SCREAMING_CASE>;
+    deprecatedNames?: Array<string_name & string_SCREAMING_CASE>;
+    usagePlaces: Array<CommandUsagePlace>;
+    description: string_markdown_text;
+    discussionUrl: `https://github.com/webgptorg/promptbook/discussions/${number | '@@'}`;
+    examples: Array<string_markdown_text>;
+    /**
+     * @throws {ParsingError} if the parsing fails
+     */
+    parse(input: CommandParserInput): TCommand;
+};
+export type CommandParserInput = {
+    usagePlace: CommandUsagePlace;
+    raw: string_markdown_text;
+    rawArgs: string_markdown_text;
+    normalized: string_name & string_SCREAMING_CASE;
+    args: Array<string_name & string_SCREAMING_CASE>;
+};
+/**
+ * TODO: !!!! Annotate
+ * TODO: [🧠] Maybe put flag if it is for whole `.ptbk.md` file of just one section
+ * TODO: [🍧] CommandParser should have applyToPipelineJson method
+ *       which will apply parsed command to the pipeline JSON
+ *       it will be called from `pipelineStringToJsonSync`
+ *       and replace hardcoded switch statement and [💐]
+ *       and throw ParsingError
+ *
+ */

package/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/{esm/typings/src/errors/ExecutionError.d.ts → umd/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/umd/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/umd/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/umd/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/umd/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