@promptbook/openai 0.24.0-0 → 0.24.0-2.0

package/esm/typings/classes/PromptTemplatePipeline.d.ts

@@ -1,4 +1,4 @@
-import { string_name } from '.././types/typeAliases';
+import { string_name, string_version } from '.././types/typeAliases';
 import { PromptTemplateJson } from '../types/PromptTemplatePipelineJson/PromptTemplateJson';
 import { PromptTemplateParameterJson } from '../types/PromptTemplatePipelineJson/PromptTemplateParameterJson';
 import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
@@ -16,6 +16,9 @@ import { PromptTemplatePipelineString } from '../types/PromptTemplatePipelineStr
  */
 export declare class PromptTemplatePipeline {
     readonly ptbkUrl: URL | null;
+    readonly title: string | null;
+    readonly ptbkVersion: string_version | null;
+    readonly description: string | null;
     readonly parameters: Record<string_name, PromptTemplateParameterJson>;
     readonly promptTemplates: Array<PromptTemplateJson>;
     /**

package/esm/typings/classes/PromptTemplatePipelineLibrary.d.ts

@@ -1,10 +1,15 @@
 import { string_name } from '.././types/typeAliases';
+import { CreatePtpExecutorSettings } from '../execution/createPtpExecutor';
 import { ExecutionTools } from '../execution/ExecutionTools';
 import { PtpExecutor } from '../execution/PtpExecutor';
 import { Prompt } from '../types/Prompt';
 import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
 import { PromptTemplatePipelineString } from '../types/PromptTemplatePipelineString';
 import { PromptTemplatePipeline } from './PromptTemplatePipeline';
+type PromptTemplatePipelineLibraryOptions = {
+    readonly library: Record<string_name, PromptTemplatePipeline>;
+    readonly settings: CreatePtpExecutorSettings;
+};
 /**
  * Library of prompt template pipelines that groups together prompt template pipelines for an application. This is a very thin wrapper around the Array / Set of prompt template pipelines.
  *
@@ -15,7 +20,7 @@ import { PromptTemplatePipeline } from './PromptTemplatePipeline';
  * @see https://github.com/webgptorg/promptbook#prompt-template-pipeline-library
  */
 export declare class PromptTemplatePipelineLibrary {
-    readonly promptTemplatePipelines: Record<string_name, PromptTemplatePipeline>;
+    readonly options: PromptTemplatePipelineLibraryOptions;
     /**
      * Constructs PromptTemplatePipeline from any sources
      *
@@ -25,7 +30,7 @@ export declare class PromptTemplatePipelineLibrary {
      * @param ptbkSources contents of .ptbk.md or .ptbk.json files
      * @returns PromptTemplatePipelineLibrary
      */
-    static fromSources(ptbkSources: Record<string_name, PromptTemplatePipelineJson | PromptTemplatePipelineString>): PromptTemplatePipelineLibrary;
+    static fromSources(ptbkSources: Record<string_name, PromptTemplatePipelineJson | PromptTemplatePipelineString>, settings: CreatePtpExecutorSettings): PromptTemplatePipelineLibrary;
     private constructor();
     /**
      * Gets prompt template pipeline by name
@@ -40,6 +45,7 @@ export declare class PromptTemplatePipelineLibrary {
      */
     createExecutor(name: string_name, tools: ExecutionTools): PtpExecutor;
 }
+export {};
 /**
  * TODO: !!! This should be renamed to Promptbook
  * TODO: !! [👐][🧠] Split of PromptTemplatePipeline,PromptTemplatePipelineLibrary between interface and class

package/esm/typings/execution/PtpExecutor.d.ts

@@ -1,6 +1,7 @@
-import { Promisable } from 'type-fest';
-import { string_name } from '.././types/typeAliases';
-import { TaskProgress } from '../types/TaskProgress';
+import type { Promisable } from 'type-fest';
+import type { string_name } from '.././types/typeAliases';
+import type { TaskProgress } from '../types/TaskProgress';
+import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
 /**
  * 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 prompt template pipeline library.
@@ -12,7 +13,26 @@ import { TaskProgress } from '../types/TaskProgress';
  * @see https://github.com/webgptorg/promptbook#executor
  */
 export interface PtpExecutor {
-    (inputParameters: Record<string_name, string>, onProgress: (taskProgress: TaskProgress) => Promisable<void>): Promise<Record<string_name, string>>;
+    (inputParameters: Record<string_name, string>, onProgress: (taskProgress: TaskProgress) => Promisable<void>): Promise<{
+        /**
+         * Whether the execution was successful
+         */
+        isSuccessful: boolean;
+        /**
+         * Errors that occured during the execution
+         */
+        errors: Array<Error>;
+        /**
+         * The report of the execution
+         */
+        executionReport: ExecutionReportJson;
+        /**
+         * Result parameters of the execution
+         *
+         * Note: If the execution was not successful, there are only some of the result parameters
+         */
+        outputParameters: Record<string_name, string>;
+    }>;
 }
 /**
  * TODO: [🧠] Should this file be in /execution or /types folder?

package/esm/typings/execution/createPtpExecutor.d.ts

@@ -1,9 +1,18 @@
 import { PromptTemplatePipeline } from '../classes/PromptTemplatePipeline';
 import { ExecutionTools } from './ExecutionTools';
 import { PtpExecutor } from './PtpExecutor';
+export interface CreatePtpExecutorSettings {
+    /**
+     * When executor does not satisfy expectations it will be retried this amount of times
+     *
+     * !!!!!!! Make default in version 24.1.0
+     */
+    readonly maxNaturalExecutionAttempts: number;
+}
 interface CreatePtpExecutorOptions {
     readonly ptp: PromptTemplatePipeline;
     readonly tools: ExecutionTools;
+    readonly settings: CreatePtpExecutorSettings;
 }
 /**
  * Creates executor function from prompt template pipeline and execution tools.

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

@@ -1,11 +1,17 @@
-import { string_name, string_prompt, string_ptbk_url_with_hashtemplate } from '.././types/typeAliases';
-import { ModelRequirements } from './ModelRequirements';
+import type { string_name, string_prompt, string_ptbk_url_with_hashtemplate, string_title } from '.././types/typeAliases';
+import type { ModelRequirements } from './ModelRequirements';
 /**
  * Prompt in a text along with model requirements, but without any execution or templating logic.
  *
  * @see https://github.com/webgptorg/promptbook#prompt
  */
 export interface Prompt {
+    /**
+     * The title of the prompt
+     *
+     * Note: This has no effect on the model, it is just for the reporting
+     */
+    readonly title: string_title;
     /**
      * The text of the prompt
      *

package/esm/typings/types/execution-report/ExecutionReportJson.d.ts

@@ -1,5 +1,6 @@
 import type { PromptResult } from '../../execution/PromptResult';
-import { Prompt } from '../Prompt';
+import type { Prompt } from '../Prompt';
+import type { string_ptbk_url, string_version } from '../typeAliases';
 /**
  * ExecutionReport is result of executing one promptbook
  * It is kind of a variant of the promptbook usefull for debugging, logging and transparency for users.
@@ -10,10 +11,46 @@ import { Prompt } from '../Prompt';
  *
  * @see https://github.com/webgptorg/promptbook#execution-report
  */
-export type ExecutionReportJson = Array<{
-    prompt: Omit<Prompt, 'ptbkUrl' | 'parameters'>;
-    result: PromptResult;
-}>;
-/**
- * TODO: [🧠] What is the best shape of ExecutionReportJson
- */
+export type ExecutionReportJson = {
+    /**
+     * Unique identifier of the ptp from ptp which was executed
+     */
+    readonly ptbkUrl?: string_ptbk_url;
+    /**
+     * Title of from ptp which was executed
+     */
+    readonly title?: string;
+    /**
+     * Version from ptp which was executed
+     */
+    readonly ptbkUsedVersion: string_version;
+    /**
+     * Version from ptp which was requested by promptbook
+     */
+    readonly ptbkRequestedVersion?: string_version;
+    /**
+     * Description of the ptp which was executed
+     */
+    readonly description?: string;
+    /**
+     * Sequence of prompt templates in order which were executed
+     */
+    readonly promptExecutions: Array<{
+        /**
+         * The prompt wich was executed
+         */
+        prompt: Omit<Prompt, 'ptbkUrl' | 'parameters'>;
+        /**
+         * Result of the prompt execution (if not failed during LLM execution)
+         */
+        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
+         */
+        error?: {
+            message: string;
+        };
+    }>;
+};

package/esm/typings/utils/markdown/prettifyMarkdown.d.ts

@@ -0,0 +1,8 @@
+import type { string_html } from '../../types/typeAliases';
+/**
+ * Prettify the html code
+ *
+ * @param html raw html code
+ * @returns formatted html code
+ */
+export declare function prettifyMarkdown(html: string_html): string_html;

package/esm/typings/utils/markdown/prettifyMarkdown.test.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.24.0-0",
+    "version": "0.24.0-2.0",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -37,7 +37,7 @@
         "openai": "4.2.0"
     },
     "peerDependencies": {
-        "@promptbook/core": "0.24.0-0"
+        "@promptbook/core": "0.24.0-2.0"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/typings/classes/PromptTemplatePipeline.d.ts

@@ -1,4 +1,4 @@
-import { string_name } from '.././types/typeAliases';
+import { string_name, string_version } from '.././types/typeAliases';
 import { PromptTemplateJson } from '../types/PromptTemplatePipelineJson/PromptTemplateJson';
 import { PromptTemplateParameterJson } from '../types/PromptTemplatePipelineJson/PromptTemplateParameterJson';
 import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
@@ -16,6 +16,9 @@ import { PromptTemplatePipelineString } from '../types/PromptTemplatePipelineStr
  */
 export declare class PromptTemplatePipeline {
     readonly ptbkUrl: URL | null;
+    readonly title: string | null;
+    readonly ptbkVersion: string_version | null;
+    readonly description: string | null;
     readonly parameters: Record<string_name, PromptTemplateParameterJson>;
     readonly promptTemplates: Array<PromptTemplateJson>;
     /**

package/umd/typings/classes/PromptTemplatePipelineLibrary.d.ts

@@ -1,10 +1,15 @@
 import { string_name } from '.././types/typeAliases';
+import { CreatePtpExecutorSettings } from '../execution/createPtpExecutor';
 import { ExecutionTools } from '../execution/ExecutionTools';
 import { PtpExecutor } from '../execution/PtpExecutor';
 import { Prompt } from '../types/Prompt';
 import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
 import { PromptTemplatePipelineString } from '../types/PromptTemplatePipelineString';
 import { PromptTemplatePipeline } from './PromptTemplatePipeline';
+type PromptTemplatePipelineLibraryOptions = {
+    readonly library: Record<string_name, PromptTemplatePipeline>;
+    readonly settings: CreatePtpExecutorSettings;
+};
 /**
  * Library of prompt template pipelines that groups together prompt template pipelines for an application. This is a very thin wrapper around the Array / Set of prompt template pipelines.
  *
@@ -15,7 +20,7 @@ import { PromptTemplatePipeline } from './PromptTemplatePipeline';
  * @see https://github.com/webgptorg/promptbook#prompt-template-pipeline-library
  */
 export declare class PromptTemplatePipelineLibrary {
-    readonly promptTemplatePipelines: Record<string_name, PromptTemplatePipeline>;
+    readonly options: PromptTemplatePipelineLibraryOptions;
     /**
      * Constructs PromptTemplatePipeline from any sources
      *
@@ -25,7 +30,7 @@ export declare class PromptTemplatePipelineLibrary {
      * @param ptbkSources contents of .ptbk.md or .ptbk.json files
      * @returns PromptTemplatePipelineLibrary
      */
-    static fromSources(ptbkSources: Record<string_name, PromptTemplatePipelineJson | PromptTemplatePipelineString>): PromptTemplatePipelineLibrary;
+    static fromSources(ptbkSources: Record<string_name, PromptTemplatePipelineJson | PromptTemplatePipelineString>, settings: CreatePtpExecutorSettings): PromptTemplatePipelineLibrary;
     private constructor();
     /**
      * Gets prompt template pipeline by name
@@ -40,6 +45,7 @@ export declare class PromptTemplatePipelineLibrary {
      */
     createExecutor(name: string_name, tools: ExecutionTools): PtpExecutor;
 }
+export {};
 /**
  * TODO: !!! This should be renamed to Promptbook
  * TODO: !! [👐][🧠] Split of PromptTemplatePipeline,PromptTemplatePipelineLibrary between interface and class

package/umd/typings/execution/PtpExecutor.d.ts

@@ -1,6 +1,7 @@
-import { Promisable } from 'type-fest';
-import { string_name } from '.././types/typeAliases';
-import { TaskProgress } from '../types/TaskProgress';
+import type { Promisable } from 'type-fest';
+import type { string_name } from '.././types/typeAliases';
+import type { TaskProgress } from '../types/TaskProgress';
+import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
 /**
  * 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 prompt template pipeline library.
@@ -12,7 +13,26 @@ import { TaskProgress } from '../types/TaskProgress';
  * @see https://github.com/webgptorg/promptbook#executor
  */
 export interface PtpExecutor {
-    (inputParameters: Record<string_name, string>, onProgress: (taskProgress: TaskProgress) => Promisable<void>): Promise<Record<string_name, string>>;
+    (inputParameters: Record<string_name, string>, onProgress: (taskProgress: TaskProgress) => Promisable<void>): Promise<{
+        /**
+         * Whether the execution was successful
+         */
+        isSuccessful: boolean;
+        /**
+         * Errors that occured during the execution
+         */
+        errors: Array<Error>;
+        /**
+         * The report of the execution
+         */
+        executionReport: ExecutionReportJson;
+        /**
+         * Result parameters of the execution
+         *
+         * Note: If the execution was not successful, there are only some of the result parameters
+         */
+        outputParameters: Record<string_name, string>;
+    }>;
 }
 /**
  * TODO: [🧠] Should this file be in /execution or /types folder?

package/umd/typings/execution/createPtpExecutor.d.ts

@@ -1,9 +1,18 @@
 import { PromptTemplatePipeline } from '../classes/PromptTemplatePipeline';
 import { ExecutionTools } from './ExecutionTools';
 import { PtpExecutor } from './PtpExecutor';
+export interface CreatePtpExecutorSettings {
+    /**
+     * When executor does not satisfy expectations it will be retried this amount of times
+     *
+     * !!!!!!! Make default in version 24.1.0
+     */
+    readonly maxNaturalExecutionAttempts: number;
+}
 interface CreatePtpExecutorOptions {
     readonly ptp: PromptTemplatePipeline;
     readonly tools: ExecutionTools;
+    readonly settings: CreatePtpExecutorSettings;
 }
 /**
  * Creates executor function from prompt template pipeline and execution tools.

package/umd/typings/types/Prompt.d.ts

@@ -1,11 +1,17 @@
-import { string_name, string_prompt, string_ptbk_url_with_hashtemplate } from '.././types/typeAliases';
-import { ModelRequirements } from './ModelRequirements';
+import type { string_name, string_prompt, string_ptbk_url_with_hashtemplate, string_title } from '.././types/typeAliases';
+import type { ModelRequirements } from './ModelRequirements';
 /**
  * Prompt in a text along with model requirements, but without any execution or templating logic.
  *
  * @see https://github.com/webgptorg/promptbook#prompt
  */
 export interface Prompt {
+    /**
+     * The title of the prompt
+     *
+     * Note: This has no effect on the model, it is just for the reporting
+     */
+    readonly title: string_title;
     /**
      * The text of the prompt
      *

package/umd/typings/types/execution-report/ExecutionReportJson.d.ts

@@ -1,5 +1,6 @@
 import type { PromptResult } from '../../execution/PromptResult';
-import { Prompt } from '../Prompt';
+import type { Prompt } from '../Prompt';
+import type { string_ptbk_url, string_version } from '../typeAliases';
 /**
  * ExecutionReport is result of executing one promptbook
  * It is kind of a variant of the promptbook usefull for debugging, logging and transparency for users.
@@ -10,10 +11,46 @@ import { Prompt } from '../Prompt';
  *
  * @see https://github.com/webgptorg/promptbook#execution-report
  */
-export type ExecutionReportJson = Array<{
-    prompt: Omit<Prompt, 'ptbkUrl' | 'parameters'>;
-    result: PromptResult;
-}>;
-/**
- * TODO: [🧠] What is the best shape of ExecutionReportJson
- */
+export type ExecutionReportJson = {
+    /**
+     * Unique identifier of the ptp from ptp which was executed
+     */
+    readonly ptbkUrl?: string_ptbk_url;
+    /**
+     * Title of from ptp which was executed
+     */
+    readonly title?: string;
+    /**
+     * Version from ptp which was executed
+     */
+    readonly ptbkUsedVersion: string_version;
+    /**
+     * Version from ptp which was requested by promptbook
+     */
+    readonly ptbkRequestedVersion?: string_version;
+    /**
+     * Description of the ptp which was executed
+     */
+    readonly description?: string;
+    /**
+     * Sequence of prompt templates in order which were executed
+     */
+    readonly promptExecutions: Array<{
+        /**
+         * The prompt wich was executed
+         */
+        prompt: Omit<Prompt, 'ptbkUrl' | 'parameters'>;
+        /**
+         * Result of the prompt execution (if not failed during LLM execution)
+         */
+        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
+         */
+        error?: {
+            message: string;
+        };
+    }>;
+};

package/umd/typings/utils/markdown/prettifyMarkdown.d.ts

@@ -0,0 +1,8 @@
+import type { string_html } from '../../types/typeAliases';
+/**
+ * Prettify the html code
+ *
+ * @param html raw html code
+ * @returns formatted html code
+ */
+export declare function prettifyMarkdown(html: string_html): string_html;

package/umd/typings/utils/markdown/prettifyMarkdown.test.d.ts

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