@promptbook/browser 0.66.0-9 → 0.67.0-0

package/esm/typings/src/errors/utils/serializeError.d.ts

@@ -0,0 +1,7 @@
+import type { ErrorJson } from './ErrorJson';
+/**
+ * Serializes an error into a [🚉] JSON-serializable object
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function serializeError(error: Error): ErrorJson;

package/esm/typings/src/errors/utils/serializeError.test.d.ts

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

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

@@ -11,7 +11,7 @@ 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
+     * Tip: Use `createLlmToolsFromEnv()` to use all available LLM providers you configured
      * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#llm-execution-tools
      */
     llm?: Arrayable<LlmExecutionTools>;
@@ -20,7 +20,10 @@ export type ExecutionTools = {
      *
      * 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
+     * Tip: Use here `new JavascriptExecutionTools()`
+     *
      * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#script-execution-tools
+     * @default [] - If not provided, no script execution will be possible
      */
     script?: Arrayable<ScriptExecutionTools>;
     /**

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

@@ -1,64 +1,18 @@
 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';
+import type { PipelineExecutorResult } from './PipelineExecutorResult';
 /**
  * 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?
  */

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

@@ -0,0 +1,49 @@
+import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
+import type { Parameters } from '../types/typeAliases';
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import type { ErrorJson } from '../errors/utils/ErrorJson';
+import type { PromptResultUsage } from './PromptResultUsage';
+/**
+ * @@@
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+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<ErrorJson>;
+    /**
+     * Warnings that occured during the execution, details are aviable in `executionReport`
+     */
+    readonly warnings: Array<ErrorJson>;
+    /**
+     * 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: [🧠] Maybe constrain `ErrorJson` -> `ErrorJson & { name: 'PipelineExecutionError' | 'Error' }`
+ */

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

@@ -15,19 +15,19 @@ export type PromptResult = CompletionPromptResult | ChatPromptResult | Embedding
  * Completion prompt result
  *
  * Note:It contains only the newly generated text NOT the whole completion
- * Note: This is fully serializable as JSON
+ * Note: [🚉] This is fully serializable as JSON
  */
 export type CompletionPromptResult = CommonPromptResult;
 /**
  *Chat prompt result
  *
- * Note: This is fully serializable as JSON
+ * Note: [🚉] This is fully serializable as JSON
  */
 export type ChatPromptResult = CommonPromptResult & {};
 /**
  * Embedding prompt  result
  *
- * Note: This is fully serializable as JSON
+ * Note: [🚉] This is fully serializable as JSON
  */
 export type EmbeddingPromptResult = Omit<CommonPromptResult, 'content'> & {
     /**
@@ -38,7 +38,7 @@ export type EmbeddingPromptResult = Omit<CommonPromptResult, 'content'> & {
 /**
  * Common properties for all prompt results
  *
- * Note: This is fully serializable as JSON
+ * Note: [🚉] This is fully serializable as JSON
  */
 export type CommonPromptResult = {
     /**
@@ -90,6 +90,7 @@ export type CommonPromptResult = {
     readonly rawResponse: TODO_object;
 };
 /**
+ * TODO: !!!!!! [🚉] Check each provider that rawResponse is fully serializable as JSON
  * TODO: [🧠] Maybe timing more accurate then seconds?
  * TODO: [🧠] Should here be link to the prompt?
  * TODO: [🧠] Maybe type `rawResponse` properly - not onject but OpenAI.result.whatever

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

@@ -3,6 +3,8 @@ import type { ExpectationUnit } from '../types/PipelineJson/Expectations';
 import type { UncertainNumber } from './UncertainNumber';
 /**
  * Usage statistics for one or many prompt results
+ *
+ * Note: [🚉] This is fully serializable as JSON
  */
 export type PromptResultUsage = {
     /**
@@ -22,6 +24,8 @@ export type PromptResultUsage = {
 };
 /**
  * Record of all possible measurable units
+ *
+ * Note: [🚉] This is fully serializable as JSON
  */
 export type PromptResultUsageCounts = Record<`${KebabCase<'TOKENS' | ExpectationUnit>}Count`, UncertainNumber>;
 /**

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

@@ -3,6 +3,7 @@ import type { number_usd } from '../types/typeAliases';
 /**
  * Number which can be uncertain
  *
+ * Note: [🚉] This is fully serializable as JSON
  * Note: If the value is completelly unknown, the value 0 and isUncertain is true
  * Note: Not using NaN or null because it looses the value which is better to be uncertain then not to be at all
  */

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

@@ -1,8 +1,8 @@
 import type { PipelineExecutor } from './PipelineExecutor';
 /**
- * Asserts that the execution of a promptnook is successful
+ * Asserts that the execution of a Promptbook is successful
  *
- * @param executionResult - The partial result of the promptnook execution
+ * @param executionResult - The partial result of the Promptbook execution
  * @throws {PipelineExecutionError} If the execution is not successful or if multiple errors occurred
  * @public exported from `@promptbook/core`
  */

package/esm/typings/src/llm-providers/_common/utils/cache/CacheItem.d.ts

@@ -25,5 +25,4 @@ export type CacheItem = {
 };
 /**
  * TODO: [🧠] Should be this exported alongsite `cacheLlmTools` through `@promptbook/utils` OR through `@promptbook/types`
- * TODO: [🛫] `prompt` is NOT fully serializable as JSON, it contains functions which are not serializable, fix it
  */

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/Expectations';
+import type { string_postprocessing_function_name } from '../../types/typeAliases';
 /**
  * Gets the expectations and creates a fake text that meets the expectations
  *
@@ -9,7 +9,7 @@ import type { Expectations } from '../../types/PipelineJson/Expectations';
  *
  * @private internal utility for MockedFackedLlmExecutionTools
  */
-export declare function $fakeTextToExpectations(expectations: Expectations, postprocessing?: Array<PostprocessingFunction>): Promise<string>;
+export declare function $fakeTextToExpectations(expectations: Expectations, postprocessingFunctionNames?: Array<string_postprocessing_function_name>): Promise<string>;
 /**
  * TODO: [💝] Unite object for expecting amount and format - use here also a format
  */

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

@@ -29,15 +29,15 @@ export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools
     /**
      * Fakes chat model
      */
-    callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'expectations' | 'postprocessing'>): Promise<ChatPromptResult & CompletionPromptResult>;
+    callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'expectations' | 'postprocessingFunctionNames'>): Promise<ChatPromptResult & CompletionPromptResult>;
     /**
      * Fakes completion model
      */
-    callCompletionModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'expectations' | 'postprocessing'>): Promise<CompletionPromptResult>;
+    callCompletionModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'expectations' | 'postprocessingFunctionNames'>): Promise<CompletionPromptResult>;
     /**
      * Fakes embedding model
      */
-    callEmbeddingModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'expectations' | 'postprocessing'>): Promise<EmbeddingPromptResult>;
+    callEmbeddingModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'expectations' | 'postprocessingFunctionNames'>): Promise<EmbeddingPromptResult>;
 }
 /**
  * TODO: [🧠][🈁] Maybe use `isDeterministic` from options

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

@@ -54,6 +54,7 @@ export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
     private callCommonModel;
 }
 /**
+ * TODO: Maybe use `$asDeeplyFrozenSerializableJson`
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
  * TODO: [🍓] Allow to list compatible models with each variant
  * TODO: [🗯] RemoteLlmExecutionTools should extend Destroyable and implement IDestroyable

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

@@ -1,11 +1,7 @@
+import type { ErrorJson } from '../../../errors/utils/ErrorJson';
 /**
  * Socket.io error for remote text generation
  *
  * This is sent from server to client when error occurs and stops the process
  */
-export type PromptbookServer_Error = {
-    /**
-     * The error message which caused the error
-     */
-    readonly errorMessage: string;
-};
+export type PromptbookServer_Error = ErrorJson;

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

@@ -11,6 +11,7 @@ import type { RemoteServerOptions } from './interfaces/RemoteServerOptions';
  */
 export declare function startRemoteServer(options: RemoteServerOptions): IDestroyable;
 /**
+ * TODO: Maybe use `$asDeeplyFrozenSerializableJson`
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
  * TODO: [⚖] Expose the collection to be able to connect to same collection via createCollectionFromUrl
  * TODO: Handle progress - support streaming

package/esm/typings/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts

@@ -1,6 +1,6 @@
 import type { Promisable } from 'type-fest';
 import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
-import type { string_javascript_name } from '../../types/typeAliases';
+import type { string_postprocessing_function_name } from '../../types/typeAliases';
 /**
  * Options for `JavascriptExecutionTools`
  */
@@ -15,7 +15,7 @@ export type JavascriptExecutionToolsOptions = CommonExecutionToolsOptions & {
      * Note: There are also some built-in functions available:
      *      @see ./JavascriptEvalExecutionTools.ts
      */
-    functions?: Record<string_javascript_name, PostprocessingFunction>;
+    functions?: Record<string_postprocessing_function_name, PostprocessingFunction>;
 };
 /**
  * Function that can be used to postprocess the output of the LLM

package/esm/typings/src/storage/_common/PromptbookStorage.d.ts

@@ -20,5 +20,5 @@ export type PromptbookStorage<TItem> = {
     removeItem(key: string): Promisable<void>;
 };
 /**
- * TODO: [🧠][🛫] Constrain `TItem` to JSON-serializable objects only
+ * TODO: [💺] Constrain `TItem` to [🚉] JSON-serializable objects only in type level
  */

package/esm/typings/src/types/ModelRequirements.d.ts

@@ -7,14 +7,14 @@ import type { string_system_message } from './typeAliases';
  * Abstract way to specify the LLM.
  * It does not specify the LLM with concrete version itself, only the requirements for the LLM.
  *
- * Note: This is fully serializable as JSON
+ * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook#model-requirements
  */
 export type ModelRequirements = CompletionModelRequirements | ChatModelRequirements | EmbeddingModelRequirements;
 /**
  * Model requirements for the completion variant
  *
- * Note: This is fully serializable as JSON
+ * Note: [🚉] This is fully serializable as JSON
  */
 export type CompletionModelRequirements = CommonModelRequirements & {
     /**
@@ -25,7 +25,7 @@ export type CompletionModelRequirements = CommonModelRequirements & {
 /**
  * Model requirements for the chat variant
  *
- * Note: This is fully serializable as JSON
+ * Note: [🚉] This is fully serializable as JSON
  */
 export type ChatModelRequirements = CommonModelRequirements & {
     /**
@@ -40,7 +40,7 @@ export type ChatModelRequirements = CommonModelRequirements & {
 /**
  * Model requirements for the embedding variant
  *
- * Note: This is fully serializable as JSON
+ * Note: [🚉] This is fully serializable as JSON
  */
 export type EmbeddingModelRequirements = CommonModelRequirements & {
     /**
@@ -51,7 +51,7 @@ export type EmbeddingModelRequirements = CommonModelRequirements & {
 /**
  * Common properties for all model requirements variants
  *
- * Note: This is fully serializable as JSON
+ * Note: [🚉] This is fully serializable as JSON
  */
 export type CommonModelRequirements = {
     /**

package/esm/typings/src/types/PipelineJson/Expectations.d.ts

@@ -7,7 +7,7 @@ import type { number_positive } from '../typeAliases';
  * For example 5 words, 3 sentences, 2 paragraphs, ...
  *
  * Note: Expectations are performed after all postprocessing steps
- *
+ * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook/discussions/30
  */
 export type Expectations = Partial<Record<Lowercase<ExpectationUnit>, {
@@ -17,6 +17,7 @@ export type Expectations = Partial<Record<Lowercase<ExpectationUnit>, {
 /**
  * Unit of text measurement
  *
+ * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook/discussions/30
  */
 export type ExpectationUnit = TupleToUnion<typeof EXPECTATION_UNITS>;
@@ -30,6 +31,7 @@ export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTEN
 /**
  * Amount of text measurement
  *
+ * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook/discussions/30
  */
 export type ExpectationAmount = number_integer & (number_positive | 0);

package/esm/typings/src/types/PipelineJson/KnowledgePieceJson.d.ts

@@ -11,6 +11,8 @@ import type { string_name } from '../typeAliases';
  *
  * Note: Knowledge piece is by definition prepared
  *
+ * Note: [🚉] This is fully serializable as JSON
+ *
  * @see https://github.com/webgptorg/promptbook/discussions/41
  */
 export type KnowledgePiecePreparedJson = {

package/esm/typings/src/types/PipelineJson/KnowledgeSourceJson.d.ts

@@ -5,6 +5,8 @@ import type { string_name } from '../typeAliases';
  * Defines one source of knowledge in the pipeline
  * For example, a source of information, a fact, a quote, a definition, website, etc.
  *
+ * Note: [🚉] This is fully serializable as JSON
+ *
  * @see https://github.com/webgptorg/promptbook/discussions/41
  */
 export type KnowledgeSourceJson = {
@@ -20,6 +22,8 @@ export type KnowledgeSourceJson = {
 /**
  * Defines one source of knowledge in the pipeline after it has been prepared
  *
+ * Note: [🚉] This is fully serializable as JSON
+ *
  * @see https://github.com/webgptorg/promptbook/discussions/41
  */
 export type KnowledgeSourcePreparedJson = KnowledgeSourceJson & {

package/esm/typings/src/types/PipelineJson/LlmTemplateJson.d.ts

@@ -3,6 +3,8 @@ import type { string_name } from '../typeAliases';
 import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
 /**
  * Template for prompt to LLM
+ *
+ * Note: [🚉] This is fully serializable as JSON
  */
 export type LlmTemplateJson = PromptTemplateJsonCommon & {
     readonly blockType: 'PROMPT_TEMPLATE';

package/esm/typings/src/types/PipelineJson/PersonaJson.d.ts

@@ -5,6 +5,8 @@ import type { string_persona_description } from '../typeAliases';
 /**
  * Defines a persona in the pipeline
  *
+ * Note: [🚉] This is fully serializable as JSON
+ *
  * @see https://github.com/webgptorg/promptbook/discussions/22
  */
 export type PersonaJson = {
@@ -22,6 +24,8 @@ export type PersonaJson = {
 /**
  * Defines a persona in the pipeline after it has been prepared
  *
+ * Note: [🚉] This is fully serializable as JSON
+ *
  * @see https://github.com/webgptorg/promptbook/discussions/22
  */
 export type PersonaPreparedJson = PersonaJson & {

package/esm/typings/src/types/PipelineJson/PipelineJson.d.ts

@@ -14,6 +14,8 @@ import type { PromptTemplateParameterJson } from './PromptTemplateParameterJson'
  * Promptbook is the **core concept of this package**.
  * It represents a series of prompt templates chained together to form a pipeline / one big prompt template with input and result parameters.
  *
+ * Note: [🚉] This is fully serializable as JSON
+ *
  * @see @@@ https://github.com/webgptorg/promptbook#promptbook
  */
 export type PipelineJson = {

package/esm/typings/src/types/PipelineJson/PromptDialogJson.d.ts

@@ -2,6 +2,7 @@ import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
 /**
  * Template for prompt to user
  *
+ * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook/discussions/76
  */
 export type PromptDialogJson = PromptTemplateJsonCommon & {

package/esm/typings/src/types/PipelineJson/PromptTemplateJson.d.ts

@@ -5,6 +5,8 @@ import type { ScriptJson } from './ScriptJson';
 import type { SimpleTemplateJson } from './SimpleTemplateJson';
 /**
  * Describes one prompt template in the promptbook
+ *
+ * Note: [🚉] This is fully serializable as JSON
  */
 export type PromptTemplateJson = LlmTemplateJson | SimpleTemplateJson | ScriptJson | PromptDialogJson | ___ | ___ | ___ | ___;
 /**

package/esm/typings/src/types/PipelineJson/PromptTemplateJsonCommon.d.ts

@@ -1,11 +1,11 @@
 import type { BlockType } from '../../commands/BLOCK/BlockTypes';
 import type { ExpectFormatCommand } from '../../commands/EXPECT/ExpectFormatCommand';
 import type { string_javascript } from '../typeAliases';
-import type { string_javascript_name } from '../typeAliases';
 import type { string_markdown } from '../typeAliases';
 import type { string_markdown_text } from '../typeAliases';
 import type { string_name } from '../typeAliases';
 import type { string_parameter_name } from '../typeAliases';
+import type { string_postprocessing_function_name } from '../typeAliases';
 import type { string_prompt } from '../typeAliases';
 import type { string_template } from '../typeAliases';
 import type { Expectations } from './Expectations';
@@ -66,7 +66,7 @@ export interface PromptTemplateJsonCommon {
      *
      * @see https://github.com/webgptorg/promptbook/discussions/31
      */
-    readonly postprocessingFunctionNames?: Array<string_javascript_name>;
+    readonly postprocessingFunctionNames?: Array<string_postprocessing_function_name>;
     /**
      * Expect this amount of each unit in the answer
      *

package/esm/typings/src/types/PipelineJson/PromptTemplateParameterJson.d.ts

@@ -3,6 +3,8 @@ import type { string_parameter_name } from '../typeAliases';
 import type { string_parameter_value } from '../typeAliases';
 /**
  * Describes one parameter of the promptbook
+ *
+ * Note: [🚉] This is fully serializable as JSON
  */
 export type PromptTemplateParameterJson = {
     /**

package/esm/typings/src/types/PipelineJson/ScriptJson.d.ts

@@ -3,6 +3,7 @@ import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
 /**
  * Template for script execution
  *
+ * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook/discussions/77
  */
 export type ScriptJson = PromptTemplateJsonCommon & {

package/esm/typings/src/types/PipelineJson/SimpleTemplateJson.d.ts

@@ -2,6 +2,7 @@ import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
 /**
  * Template for simple concatenation of strings
  *
+ * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook/discussions/17
  */
 export type SimpleTemplateJson = PromptTemplateJsonCommon & {

package/esm/typings/src/types/Prompt.d.ts

@@ -1,5 +1,4 @@
 import type { ExpectFormatCommand } from '../commands/EXPECT/ExpectFormatCommand';
-import type { PostprocessingFunction } from '../scripting/javascript/JavascriptExecutionToolsOptions';
 import type { ChatModelRequirements } from './ModelRequirements';
 import type { CompletionModelRequirements } from './ModelRequirements';
 import type { EmbeddingModelRequirements } from './ModelRequirements';
@@ -7,20 +6,21 @@ import type { ModelRequirements } from './ModelRequirements';
 import type { Expectations } from './PipelineJson/Expectations';
 import type { Parameters } from './typeAliases';
 import type { string_pipeline_url_with_hashtemplate } from './typeAliases';
+import type { string_postprocessing_function_name } from './typeAliases';
 import type { string_prompt } from './typeAliases';
 import type { string_template } from './typeAliases';
 import type { string_title } from './typeAliases';
 /**
  * Prompt in a text along with model requirements, but without any execution or templating logic.
  *
- * Note: [🛫] This is NOT fully serializable as JSON, it contains functions which are not serializable
+ * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook#prompt
  */
 export type Prompt = CompletionPrompt | ChatPrompt | EmbeddingPrompt;
 /**
  * Completion prompt
  *
- * Note: [🛫] This is NOT fully serializable as JSON, it contains functions which are not serializable
+ * Note: [🚉] This is fully serializable as JSON
  */
 export type CompletionPrompt = CommonPrompt & {
     /**
@@ -31,7 +31,7 @@ export type CompletionPrompt = CommonPrompt & {
 /**
  * Chat prompt
  *
- * Note: [🛫] This is NOT fully serializable as JSON, it contains functions which are not serializable
+ * Note: [🚉] This is fully serializable as JSON
  */
 export type ChatPrompt = CommonPrompt & {
     /**
@@ -42,7 +42,7 @@ export type ChatPrompt = CommonPrompt & {
 /**
  * Embedding prompt
  *
- * Note: [🛫] This is NOT fully serializable as JSON, it contains functions which are not serializable
+ * Note: [🚉] This is fully serializable as JSON
  */
 export type EmbeddingPrompt = CommonPrompt & {
     /**
@@ -53,7 +53,7 @@ export type EmbeddingPrompt = CommonPrompt & {
 /**
  * Common properties for all prompt results
  *
- * Note: This is fully serializable as JSON
+ * Note: [🚉] This is fully serializable as JSON
  */
 export type CommonPrompt = {
     /**
@@ -75,7 +75,7 @@ export type CommonPrompt = {
     /**
      * List of postprocessing steps that are executed after the prompt
      */
-    readonly postprocessing?: Array<PostprocessingFunction>;
+    readonly postprocessingFunctionNames?: Array<string_postprocessing_function_name>;
     /**
      * Expectations for the answer
      *

package/esm/typings/src/types/ScriptLanguage.d.ts

@@ -1,6 +1,8 @@
 import type { TupleToUnion } from 'type-fest';
 /**
  * Script language
+ *
+ * Note: [🚉] This is fully serializable as JSON
  */
 export type ScriptLanguage = TupleToUnion<typeof SUPPORTED_SCRIPT_LANGUAGES>;
 /**

package/esm/typings/src/types/execution-report/ExecutionPromptReportJson.d.ts

@@ -0,0 +1,24 @@
+import type { ErrorJson } from '../../errors/utils/ErrorJson';
+import type { PromptResult } from '../../execution/PromptResult';
+import type { Prompt } from '../Prompt';
+/**
+ * Report of single prompt execution
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type ExecutionPromptReportJson = {
+    /**
+     * The prompt wich was executed
+     */
+    readonly prompt: Omit<Prompt, 'pipelineUrl'>;
+    /**
+     * Result of the prompt execution (if not failed during LLM execution)
+     */
+    readonly result?: PromptResult;
+    /**
+     * The error which occured during LLM execution or during postprocessing or expectation checking
+     *
+     * Note: It makes sense to have both error and result defined, for example when the result not pass expectations
+     */
+    readonly error?: ErrorJson;
+};