@promptbook/openai 0.25.0 → 0.27.0-0

package/esm/index.es.js

@@ -191,7 +191,7 @@ var OpenAiExecutionTools = /** @class */ (function () {
     return OpenAiExecutionTools;
 }());
 /**
- * TODO: !!!! Allow to use other models - List all from openai
+
  * TODO: Maybe Create some common util for gptChat and gptComplete
  * TODO: Maybe make custom OpenaiError
  */

package/esm/typings/conversion/parseCommand.test.d.ts

@@ -1,6 +1,5 @@
 export {};
 /**
  * TODO: [🧠] Probbably change syntax MODEL VARIANT -> MODEL
- * TODO: !!!! Allow to skip segments SKIP IF {foo} NOT DEFINED
- * TODO: !!! Allow to EXPECT 3 words
+ * TODO: !!! Allow to skip segments SKIP IF {foo} NOT DEFINED
  */

package/esm/typings/conversion/promptTemplatePipelineStringToJson.d.ts

@@ -9,7 +9,5 @@ export declare function promptTemplatePipelineStringToJson(promptTemplatePipelin
 /**
  * TODO: Report here line/column of error
  * TODO: Use spaceTrim more effectively
- * TODO: !!!! Parameter flags - isInput, isOutput, isInternal, isBeforePostprocessing, isBeforeFinal, canonicalName
- * TODO: !!!! Allow to have non-immutable parameters - suffix them with fooPrevious3 -> fooPrevious2 -> fooPrevious1 -> foo
- *            This must work with other technial parameters
+ * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
  */

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

@@ -0,0 +1,10 @@
+/**
+ * This error occurs when some expectation is not met in the execution of the pipeline
+ */
+export declare class ExpectError extends Error {
+    readonly name = "ExpectError";
+    constructor(message: string);
+}
+/**
+ * TODO: [🧠] Should be this exported from the library
+ */

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

@@ -1,4 +1,4 @@
-import { PromptTemplatePipeline } from '../classes/PromptTemplatePipeline';
+import type { PromptTemplatePipeline } from '../classes/PromptTemplatePipeline';
 import { ExecutionTools } from './ExecutionTools';
 import { PtpExecutor } from './PtpExecutor';
 export interface CreatePtpExecutorSettings {
@@ -7,7 +7,7 @@ export interface CreatePtpExecutorSettings {
      *
      * @default 3
      */
-    readonly maxNaturalExecutionAttempts: number;
+    readonly maxExecutionAttempts: number;
 }
 /**
  * Options for creating a PTP (Prompt Template Pipeline) executor

package/esm/typings/execution/plugins/natural-execution-tools/openai/OpenAiExecutionTools.d.ts

@@ -22,7 +22,7 @@ export declare class OpenAiExecutionTools implements NaturalExecutionTools {
     gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
 }
 /**
- * TODO: !!!! Allow to use other models - List all from openai
+
  * TODO: Maybe Create some common util for gptChat and gptComplete
  * TODO: Maybe make custom OpenaiError
  */

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

@@ -66,13 +66,25 @@ export interface PostprocessCommand {
 }
 /**
  * Expect command describes the desired output of the prompt template (after post-processing)
+ * It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs or some other shape of the output.
+ */
+export type ExpectCommand = ExpectAmountCommand | ExpectFormatCommand;
+/**
+ * Expect amount command describes the desired output of the prompt template (after post-processing)
  * It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs,...
  *
  * Note: LLMs work with tokens, not characters, but in Promptbooks we want to use some human-recognisable and cross-model interoperable units.
  */
-export interface ExpectCommand {
-    readonly type: 'EXPECT';
+export interface ExpectAmountCommand {
+    readonly type: 'EXPECT_AMOUNT';
     readonly sign: 'EXACTLY' | 'MINIMUM' | 'MAXIMUM';
     readonly unit: ExpectationUnit;
     readonly amount: ExpectationAmount;
 }
+/**
+ * Represents a command that expects a specific format.
+ */
+export interface ExpectFormatCommand {
+    readonly type: 'EXPECT_FORMAT';
+    readonly format: 'JSON';
+}

package/esm/typings/types/PromptTemplatePipelineJson/PromptTemplateJson.d.ts

@@ -1,4 +1,5 @@
-import { number_integer, number_positive_or_zero, string_javascript, string_markdown, string_name, string_prompt, string_template } from '../.././types/typeAliases';
+import { number_integer, number_positive_or_zero, string_javascript, string_javascript_name, string_markdown, string_name, string_prompt, string_template } from '../.././types/typeAliases';
+import { ExpectFormatCommand } from '../Command';
 import { ExecutionType } from '../ExecutionTypes';
 import { ModelRequirements } from '../ModelRequirements';
 import { ScriptLanguage } from '../ScriptLanguage';
@@ -11,13 +12,6 @@ export type PromptTemplateJson = NaturalTemplateJson | SimpleTemplateJson | Scri
  */
 export interface NaturalTemplateJson extends PromptTemplateJsonCommon {
     readonly executionType: 'PROMPT_TEMPLATE';
-    /**
-     * Expectations for the answer
-     */
-    readonly expectations: Partial<Record<Lowercase<ExpectationUnit>, {
-        min?: ExpectationAmount;
-        max?: ExpectationAmount;
-    }>>;
     /**
      * Requirements for the model
      * - This is required only for executionType PROMPT_TEMPLATE
@@ -31,7 +25,7 @@ export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTEN
 /**
  * Unit of text measurement
  */
-export type ExpectationUnit = (typeof EXPECTATION_UNITS)[number];
+export type ExpectationUnit = typeof EXPECTATION_UNITS[number];
 /**
  * Amount of text measurement
  */
@@ -90,6 +84,27 @@ interface PromptTemplateJsonCommon {
      * Content of the template with {placeholders} for parameters
      */
     readonly content: (string_prompt | string_javascript | string_markdown) & string_template;
+    /**
+     * List of postprocessing steps that are executed after the prompt template
+     */
+    readonly postprocessing?: Array<string_javascript_name>;
+    /**
+     * Expect this amount of each unit in the answer
+     *
+     * For example 5 words, 3 sentences, 2 paragraphs, ...
+     *
+     * Note: Expectations are performed after all postprocessing steps
+     */
+    readonly expectAmount?: Partial<Record<Lowercase<ExpectationUnit>, {
+        min?: ExpectationAmount;
+        max?: ExpectationAmount;
+    }>>;
+    /**
+     * Expect this format of the answer
+     *
+     * Note: Expectations are performed after all postprocessing steps
+     */
+    readonly expectFormat?: ExpectFormatCommand['format'];
     /**
      * Name of the parameter that is the result of the prompt template
      */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.25.0",
+    "version": "0.27.0-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.25.0"
+        "@promptbook/core": "0.27.0-0"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/index.umd.js

@@ -199,7 +199,7 @@
         return OpenAiExecutionTools;
     }());
     /**
-     * TODO: !!!! Allow to use other models - List all from openai
+
      * TODO: Maybe Create some common util for gptChat and gptComplete
      * TODO: Maybe make custom OpenaiError
      */

package/umd/typings/conversion/parseCommand.test.d.ts

@@ -1,6 +1,5 @@
 export {};
 /**
  * TODO: [🧠] Probbably change syntax MODEL VARIANT -> MODEL
- * TODO: !!!! Allow to skip segments SKIP IF {foo} NOT DEFINED
- * TODO: !!! Allow to EXPECT 3 words
+ * TODO: !!! Allow to skip segments SKIP IF {foo} NOT DEFINED
  */

package/umd/typings/conversion/promptTemplatePipelineStringToJson.d.ts

@@ -9,7 +9,5 @@ export declare function promptTemplatePipelineStringToJson(promptTemplatePipelin
 /**
  * TODO: Report here line/column of error
  * TODO: Use spaceTrim more effectively
- * TODO: !!!! Parameter flags - isInput, isOutput, isInternal, isBeforePostprocessing, isBeforeFinal, canonicalName
- * TODO: !!!! Allow to have non-immutable parameters - suffix them with fooPrevious3 -> fooPrevious2 -> fooPrevious1 -> foo
- *            This must work with other technial parameters
+ * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
  */

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

@@ -0,0 +1,10 @@
+/**
+ * This error occurs when some expectation is not met in the execution of the pipeline
+ */
+export declare class ExpectError extends Error {
+    readonly name = "ExpectError";
+    constructor(message: string);
+}
+/**
+ * TODO: [🧠] Should be this exported from the library
+ */

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

@@ -1,4 +1,4 @@
-import { PromptTemplatePipeline } from '../classes/PromptTemplatePipeline';
+import type { PromptTemplatePipeline } from '../classes/PromptTemplatePipeline';
 import { ExecutionTools } from './ExecutionTools';
 import { PtpExecutor } from './PtpExecutor';
 export interface CreatePtpExecutorSettings {
@@ -7,7 +7,7 @@ export interface CreatePtpExecutorSettings {
      *
      * @default 3
      */
-    readonly maxNaturalExecutionAttempts: number;
+    readonly maxExecutionAttempts: number;
 }
 /**
  * Options for creating a PTP (Prompt Template Pipeline) executor

package/umd/typings/execution/plugins/natural-execution-tools/openai/OpenAiExecutionTools.d.ts

@@ -22,7 +22,7 @@ export declare class OpenAiExecutionTools implements NaturalExecutionTools {
     gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
 }
 /**
- * TODO: !!!! Allow to use other models - List all from openai
+
  * TODO: Maybe Create some common util for gptChat and gptComplete
  * TODO: Maybe make custom OpenaiError
  */

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

@@ -66,13 +66,25 @@ export interface PostprocessCommand {
 }
 /**
  * Expect command describes the desired output of the prompt template (after post-processing)
+ * It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs or some other shape of the output.
+ */
+export type ExpectCommand = ExpectAmountCommand | ExpectFormatCommand;
+/**
+ * Expect amount command describes the desired output of the prompt template (after post-processing)
  * It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs,...
  *
  * Note: LLMs work with tokens, not characters, but in Promptbooks we want to use some human-recognisable and cross-model interoperable units.
  */
-export interface ExpectCommand {
-    readonly type: 'EXPECT';
+export interface ExpectAmountCommand {
+    readonly type: 'EXPECT_AMOUNT';
     readonly sign: 'EXACTLY' | 'MINIMUM' | 'MAXIMUM';
     readonly unit: ExpectationUnit;
     readonly amount: ExpectationAmount;
 }
+/**
+ * Represents a command that expects a specific format.
+ */
+export interface ExpectFormatCommand {
+    readonly type: 'EXPECT_FORMAT';
+    readonly format: 'JSON';
+}

package/umd/typings/types/PromptTemplatePipelineJson/PromptTemplateJson.d.ts

@@ -1,4 +1,5 @@
-import { number_integer, number_positive_or_zero, string_javascript, string_markdown, string_name, string_prompt, string_template } from '../.././types/typeAliases';
+import { number_integer, number_positive_or_zero, string_javascript, string_javascript_name, string_markdown, string_name, string_prompt, string_template } from '../.././types/typeAliases';
+import { ExpectFormatCommand } from '../Command';
 import { ExecutionType } from '../ExecutionTypes';
 import { ModelRequirements } from '../ModelRequirements';
 import { ScriptLanguage } from '../ScriptLanguage';
@@ -11,13 +12,6 @@ export type PromptTemplateJson = NaturalTemplateJson | SimpleTemplateJson | Scri
  */
 export interface NaturalTemplateJson extends PromptTemplateJsonCommon {
     readonly executionType: 'PROMPT_TEMPLATE';
-    /**
-     * Expectations for the answer
-     */
-    readonly expectations: Partial<Record<Lowercase<ExpectationUnit>, {
-        min?: ExpectationAmount;
-        max?: ExpectationAmount;
-    }>>;
     /**
      * Requirements for the model
      * - This is required only for executionType PROMPT_TEMPLATE
@@ -31,7 +25,7 @@ export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTEN
 /**
  * Unit of text measurement
  */
-export type ExpectationUnit = (typeof EXPECTATION_UNITS)[number];
+export type ExpectationUnit = typeof EXPECTATION_UNITS[number];
 /**
  * Amount of text measurement
  */
@@ -90,6 +84,27 @@ interface PromptTemplateJsonCommon {
      * Content of the template with {placeholders} for parameters
      */
     readonly content: (string_prompt | string_javascript | string_markdown) & string_template;
+    /**
+     * List of postprocessing steps that are executed after the prompt template
+     */
+    readonly postprocessing?: Array<string_javascript_name>;
+    /**
+     * Expect this amount of each unit in the answer
+     *
+     * For example 5 words, 3 sentences, 2 paragraphs, ...
+     *
+     * Note: Expectations are performed after all postprocessing steps
+     */
+    readonly expectAmount?: Partial<Record<Lowercase<ExpectationUnit>, {
+        min?: ExpectationAmount;
+        max?: ExpectationAmount;
+    }>>;
+    /**
+     * Expect this format of the answer
+     *
+     * Note: Expectations are performed after all postprocessing steps
+     */
+    readonly expectFormat?: ExpectFormatCommand['format'];
     /**
      * Name of the parameter that is the result of the prompt template
      */