@promptbook/cli 0.62.2 → 0.63.0-0

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

@@ -1,7 +1,9 @@
-/**
- * This error indicates that promptbook not found in the collection
- */
-export declare class NotFoundError extends Error {
-    readonly name = "NotFoundError";
-    constructor(message: string);
-}
+/**
+ * This error indicates that promptbook not found in the collection
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class NotFoundError extends Error {
+    readonly name = "NotFoundError";
+    constructor(message: string);
+}

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

@@ -1,7 +1,9 @@
-/**
- * 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);
-}
+/**
+ * This error type indicates that some part of the code is not implemented yet
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class NotYetImplementedError extends Error {
+    readonly name = "NotYetImplementedError";
+    constructor(message: string);
+}

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

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

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

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

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

@@ -1,7 +1,9 @@
-/**
- * This error indicates that the promptbook object has valid syntax but contains logical errors (like circular dependencies)
- */
-export declare class PipelineLogicError extends Error {
-    readonly name = "PipelineLogicError";
-    constructor(message: string);
-}
+/**
+ * This error indicates that the promptbook object has valid syntax but contains logical errors (like circular dependencies)
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class PipelineLogicError extends Error {
+    readonly name = "PipelineLogicError";
+    constructor(message: string);
+}

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

@@ -1,7 +1,9 @@
-/**
- * This error indicates errors in referencing promptbooks between each other
- */
-export declare class ReferenceError extends Error {
-    readonly name = "ReferenceError";
-    constructor(message: string);
-}
+/**
+ * This error indicates errors in referencing promptbooks between each other
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class ReferenceError extends Error {
+    readonly name = "ReferenceError";
+    constructor(message: string);
+}

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

@@ -1,7 +1,9 @@
-/**
- * This error type indicates that the error should not happen and its last check before crashing with some other error
- */
-export declare class UnexpectedError extends Error {
-    readonly name = "UnexpectedError";
-    constructor(message: string);
-}
+/**
+ * This error type indicates that the error should not happen and its last check before crashing with some other error
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class UnexpectedError extends Error {
+    readonly name = "UnexpectedError";
+    constructor(message: string);
+}

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

@@ -1,8 +1,10 @@
-import type { string_semantic_version } from '../types/typeAliases';
-/**
- * This error type indicates that the version of the pipeline is not matching the expected version
- */
-export declare class VersionMismatchError extends Error {
-    readonly name = "UnexpectedError";
-    constructor(message: string, expectedVersion: string_semantic_version);
-}
+import type { string_semantic_version } from '../types/typeAliases';
+/**
+ * This error type indicates that the version of the pipeline is not matching the expected version
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class VersionMismatchError extends Error {
+    readonly name = "UnexpectedError";
+    constructor(message: string, expectedVersion: string_semantic_version);
+}

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

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

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

@@ -1,10 +1,10 @@
-export type CommonExecutionToolsOptions = {
-    /**
-     * If true, the internal executions will be logged
-     */
-    readonly isVerbose?: boolean;
-};
-/**
- * TODO: [🈁] Maybe add here `isDeterministic`
- * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
- */
+export type CommonExecutionToolsOptions = {
+    /**
+     * If true, the internal executions will be logged
+     */
+    readonly isVerbose?: boolean;
+};
+/**
+ * TODO: [🈁] Maybe add here `isDeterministic`
+ * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
+ */

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

@@ -1,8 +1,8 @@
-/**
- * Represents a vector in an latent space of the embedding model
- */
-export type EmbeddingVector = Array<number>;
-/**
- * TODO: Figure out how to use NPM package xyzt
- *       Not using IVectorData due to HUGE dimensionality
- */
+/**
+ * Represents a vector in an latent space of the embedding model
+ */
+export type EmbeddingVector = Array<number>;
+/**
+ * TODO: Figure out how to use NPM package xyzt
+ *       Not using IVectorData due to HUGE dimensionality
+ */

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

@@ -1,33 +1,33 @@
-import type { Arrayable } from '../types/Arrayable';
-import type { LlmExecutionTools } from './LlmExecutionTools';
-import type { ScriptExecutionTools } from './ScriptExecutionTools';
-import type { UserInterfaceTools } from './UserInterfaceTools';
-/**
- * All the tools needed to execute pipelines.
- *
- * @see https://github.com/webgptorg/promptbook#execution-tools
- */
-export type ExecutionTools = {
-    /**
-     * Tools for executing prompts to large language models like GPT-4
-     *
-     * 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?: Arrayable<LlmExecutionTools>;
-    /**
-     * Tools for executing scripts
-     *
-     * Note: You can pass multiple ScriptExecutionTools, they will be tried one by one until one of them supports the script
-     *       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?: Arrayable<ScriptExecutionTools>;
-    /**
-     * Tools for interacting with the user
-     *
-     * Note: When undefined, the user interface is disabled and promptbook which requires user interaction will fail
-     * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#user-interface-tools
-     */
-    userInterface?: UserInterfaceTools;
-};
+import type { Arrayable } from '../types/Arrayable';
+import type { LlmExecutionTools } from './LlmExecutionTools';
+import type { ScriptExecutionTools } from './ScriptExecutionTools';
+import type { UserInterfaceTools } from './UserInterfaceTools';
+/**
+ * All the tools needed to execute pipelines.
+ *
+ * @see https://github.com/webgptorg/promptbook#execution-tools
+ */
+export type ExecutionTools = {
+    /**
+     * Tools for executing prompts to large language models like GPT-4
+     *
+     * 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?: Arrayable<LlmExecutionTools>;
+    /**
+     * Tools for executing scripts
+     *
+     * Note: You can pass multiple ScriptExecutionTools, they will be tried one by one until one of them supports the script
+     *       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?: Arrayable<ScriptExecutionTools>;
+    /**
+     * Tools for interacting with the user
+     *
+     * Note: When undefined, the user interface is disabled and promptbook which requires user interaction will fail
+     * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#user-interface-tools
+     */
+    userInterface?: UserInterfaceTools;
+};

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

@@ -1,72 +1,72 @@
-import type { Promisable } from 'type-fest';
-import type { ModelVariant } from '../types/ModelVariant';
-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 { ChatPromptResult } from './PromptResult';
-import type { CompletionPromptResult } from './PromptResult';
-import type { EmbeddingPromptResult } 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.
- * Inside (in constructor) it calls OpenAI, Azure, GPU, proxy, cache, logging,...
- *
- * @see https://github.com/webgptorg/promptbook#llm-execution-tools
- */
-export type LlmExecutionTools = {
-    /**
-     * Title of the model provider
-     *
-     * @example "OpenAI"
-     */
-    readonly title: string_title & string_markdown_text;
-    /**
-     * Description of the provider
-     *
-     * @example "Use all models from OpenAI"
-     */
-    readonly description: string_markdown;
-    /**
-     * Calls a chat model
-     */
-    callChatModel?(prompt: Prompt): Promise<ChatPromptResult>;
-    /**
-     * Calls a completion model
-     */
-    callCompletionModel?(prompt: Prompt): Promise<CompletionPromptResult>;
-    /**
-     * Calls an embedding model
-     */
-    callEmbeddingModel?(prompt: Prompt): Promise<EmbeddingPromptResult>;
-    /**
-     * List all available models that can be used
-     */
-    listModels(): Promisable<Array<AvailableModel>>;
-};
-/**
- * Represents a model that can be used for prompt execution
- */
-export type AvailableModel = {
-    /**
-     * The model title
-     */
-    readonly modelTitle: string_title;
-    /**
-     * The model name aviailable
-     */
-    readonly modelName: string_model_name;
-    /**
-     * Variant of the model
-     */
-    readonly modelVariant: ModelVariant;
-};
-/**
- * TODO: [🏳] Add `callTranslationModel`
- * TODO: Maybe reorder `listModels` and put it befor `callChatModel`, `callCompletionModel`, `callEmbeddingModel`
- * 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: [🧠] Should or should not there be a word "GPT" in both callCompletionModel and callChatModel
- * TODO: [🧠][🪐] Should be common things like types, utils in folder containing A,B,C,.. or else outside this listing folder?
- */
+import type { Promisable } from 'type-fest';
+import type { ModelVariant } from '../types/ModelVariant';
+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 { ChatPromptResult } from './PromptResult';
+import type { CompletionPromptResult } from './PromptResult';
+import type { EmbeddingPromptResult } 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.
+ * Inside (in constructor) it calls OpenAI, Azure, GPU, proxy, cache, logging,...
+ *
+ * @see https://github.com/webgptorg/promptbook#llm-execution-tools
+ */
+export type LlmExecutionTools = {
+    /**
+     * Title of the model provider
+     *
+     * @example "OpenAI"
+     */
+    readonly title: string_title & string_markdown_text;
+    /**
+     * Description of the provider
+     *
+     * @example "Use all models from OpenAI"
+     */
+    readonly description: string_markdown;
+    /**
+     * Calls a chat model
+     */
+    callChatModel?(prompt: Prompt): Promise<ChatPromptResult>;
+    /**
+     * Calls a completion model
+     */
+    callCompletionModel?(prompt: Prompt): Promise<CompletionPromptResult>;
+    /**
+     * Calls an embedding model
+     */
+    callEmbeddingModel?(prompt: Prompt): Promise<EmbeddingPromptResult>;
+    /**
+     * List all available models that can be used
+     */
+    listModels(): Promisable<Array<AvailableModel>>;
+};
+/**
+ * Represents a model that can be used for prompt execution
+ */
+export type AvailableModel = {
+    /**
+     * The model title
+     */
+    readonly modelTitle: string_title;
+    /**
+     * The model name aviailable
+     */
+    readonly modelName: string_model_name;
+    /**
+     * Variant of the model
+     */
+    readonly modelVariant: ModelVariant;
+};
+/**
+ * TODO: [🏳] Add `callTranslationModel`
+ * TODO: Maybe reorder `listModels` and put it befor `callChatModel`, `callCompletionModel`, `callEmbeddingModel`
+ * 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: [🧠] Should or should not there be a word "GPT" in both callCompletionModel and callChatModel
+ * TODO: [🧠][🪐] Should be common things like types, utils in folder containing A,B,C,.. or else outside this listing folder?
+ */

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

@@ -1,64 +1,64 @@
-import type { Promisable } from 'type-fest';
-import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
-import { PipelineExecutionError } from '../errors/PipelineExecutionError';
-import type { TaskProgress } from '../types/TaskProgress';
-import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
-import type { Parameters } from '../types/typeAliases';
-import type { PromptResultUsage } from './PromptResultUsage';
-/**
- * Executor is a simple async function that takes INPUT  PARAMETERs and returns result parameters _(along with all intermediate parameters and INPUT  PARAMETERs = it extends input object)_.
- * Executor is made by combining execution tools and pipeline collection.
- *
- * It can be created with `createPipelineExecutor` function.
- *
- * @@@ almost-JSON (what about errors)
- *
- * @see https://github.com/webgptorg/promptbook#executor
- */
-export type PipelineExecutor = {
-    (inputParameters: Parameters, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<PipelineExecutorResult>;
-};
-/**
- * @@@
- *
- * @@@ almost-JSON (what about errors)
- */
-export type PipelineExecutorResult = {
-    /**
-     * Result parameters of the execution
-     *
-     * Note: If the execution was not successful, there are only some of the result parameters
-     */
-    readonly outputParameters: Parameters;
-    /**
-     * Whether the execution was successful, details are aviable in `executionReport`
-     */
-    readonly isSuccessful: boolean;
-    /**
-     * Added usage of whole execution, detailed usage is aviable in `executionReport`
-     */
-    readonly usage: PromptResultUsage;
-    /**
-     * Errors that occured during the execution, details are aviable in `executionReport`
-     */
-    readonly errors: Array<PipelineExecutionError | Error>;
-    /**
-     * Warnings that occured during the execution, details are aviable in `executionReport`
-     */
-    readonly warnings: Array<PipelineExecutionError | Error>;
-    /**
-     * The report of the execution with all details
-     */
-    readonly executionReport: ExecutionReportJson;
-    /**
-     * The prepared pipeline that was used for the execution
-     *
-     * Note: If you called `createPipelineExecutor` with fully prepared pipeline, this is the same object as this pipeline
-     *       If you passed not fully prepared pipeline, this is same pipeline but fully prepared
-     */
-    readonly preparedPipeline: PipelineJson;
-};
-/**
- * TODO: [🧠] Should this file be in /execution or /types folder?
- * TODO: [💷] `assertsExecutionSuccessful` should be the method of `PipelineExecutor` result - BUT maybe NOT?
- */
+import type { Promisable } from 'type-fest';
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import { PipelineExecutionError } from '../errors/PipelineExecutionError';
+import type { TaskProgress } from '../types/TaskProgress';
+import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
+import type { Parameters } from '../types/typeAliases';
+import type { PromptResultUsage } from './PromptResultUsage';
+/**
+ * Executor is a simple async function that takes INPUT  PARAMETERs and returns result parameters _(along with all intermediate parameters and INPUT  PARAMETERs = it extends input object)_.
+ * Executor is made by combining execution tools and pipeline collection.
+ *
+ * It can be created with `createPipelineExecutor` function.
+ *
+ * @@@ almost-JSON (what about errors)
+ *
+ * @see https://github.com/webgptorg/promptbook#executor
+ */
+export type PipelineExecutor = {
+    (inputParameters: Parameters, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<PipelineExecutorResult>;
+};
+/**
+ * @@@
+ *
+ * @@@ almost-JSON (what about errors)
+ */
+export type PipelineExecutorResult = {
+    /**
+     * Result parameters of the execution
+     *
+     * Note: If the execution was not successful, there are only some of the result parameters
+     */
+    readonly outputParameters: Parameters;
+    /**
+     * Whether the execution was successful, details are aviable in `executionReport`
+     */
+    readonly isSuccessful: boolean;
+    /**
+     * Added usage of whole execution, detailed usage is aviable in `executionReport`
+     */
+    readonly usage: PromptResultUsage;
+    /**
+     * Errors that occured during the execution, details are aviable in `executionReport`
+     */
+    readonly errors: Array<PipelineExecutionError | Error>;
+    /**
+     * Warnings that occured during the execution, details are aviable in `executionReport`
+     */
+    readonly warnings: Array<PipelineExecutionError | Error>;
+    /**
+     * The report of the execution with all details
+     */
+    readonly executionReport: ExecutionReportJson;
+    /**
+     * The prepared pipeline that was used for the execution
+     *
+     * Note: If you called `createPipelineExecutor` with fully prepared pipeline, this is the same object as this pipeline
+     *       If you passed not fully prepared pipeline, this is same pipeline but fully prepared
+     */
+    readonly preparedPipeline: PipelineJson;
+};
+/**
+ * TODO: [🧠] Should this file be in /execution or /types folder?
+ * TODO: [💷] `assertsExecutionSuccessful` should be the method of `PipelineExecutor` result - BUT maybe NOT?
+ */