@promptbook/openai 0.24.0 → 0.26.0

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

@@ -6,9 +6,18 @@ import { Prompt } from '../types/Prompt';
 import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
 import { PromptTemplatePipelineString } from '../types/PromptTemplatePipelineString';
 import { PromptTemplatePipeline } from './PromptTemplatePipeline';
+/**
+ * Options for PromptTemplatePipelineLibrary
+ */
 type PromptTemplatePipelineLibraryOptions = {
+    /**
+     * The library of prompt template pipelines
+     */
     readonly library: Record<string_name, PromptTemplatePipeline>;
-    readonly settings: CreatePtpExecutorSettings;
+    /**
+     * Optional settings for creating a PromptTemplatePipelineExecutor
+     */
+    readonly settings?: Partial<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.
@@ -28,9 +37,10 @@ export declare class PromptTemplatePipelineLibrary {
      * Note: You can combine .ptbk.md and .ptbk.json files BUT it is not recommended
      *
      * @param ptbkSources contents of .ptbk.md or .ptbk.json files
+     * @param settings settings for creating executor functions
      * @returns PromptTemplatePipelineLibrary
      */
-    static fromSources(ptbkSources: Record<string_name, PromptTemplatePipelineJson | PromptTemplatePipelineString>, settings: CreatePtpExecutorSettings): PromptTemplatePipelineLibrary;
+    static fromSources(ptbkSources: Record<string_name, PromptTemplatePipelineJson | PromptTemplatePipelineString>, settings?: Partial<CreatePtpExecutorSettings>): PromptTemplatePipelineLibrary;
     private constructor();
     /**
      * Gets prompt template pipeline by name

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

@@ -5,14 +5,26 @@ export interface CreatePtpExecutorSettings {
     /**
      * When executor does not satisfy expectations it will be retried this amount of times
      *
-     * !!!!!!! Make default in version 24.1.0
+     * @default 3
      */
     readonly maxNaturalExecutionAttempts: number;
 }
+/**
+ * Options for creating a PTP (Prompt Template Pipeline) executor
+ */
 interface CreatePtpExecutorOptions {
+    /**
+     * The Prompt Template Pipeline (PTP) to be executed
+     */
     readonly ptp: PromptTemplatePipeline;
+    /**
+     * The execution tools to be used during the execution of the PTP
+     */
     readonly tools: ExecutionTools;
-    readonly settings: CreatePtpExecutorSettings;
+    /**
+     * Optional settings for the PTP executor
+     */
+    readonly settings?: Partial<CreatePtpExecutorSettings>;
 }
 /**
  * Creates executor function from prompt template pipeline and execution tools.

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 { ExpectFormatCommand } from '../Command';
 import { ExecutionType } from '../ExecutionTypes';
 import { ModelRequirements } from '../ModelRequirements';
 import { ScriptLanguage } from '../ScriptLanguage';
@@ -12,12 +13,18 @@ export type PromptTemplateJson = NaturalTemplateJson | SimpleTemplateJson | Scri
 export interface NaturalTemplateJson extends PromptTemplateJsonCommon {
     readonly executionType: 'PROMPT_TEMPLATE';
     /**
-     * Expectations for the answer
+     * Expect this amount of each unit in the answer
+     *
+     * For example 5 words, 3 sentences, 2 paragraphs, ...
      */
-    readonly expectations: Partial<Record<Lowercase<ExpectationUnit>, {
+    readonly expectAmount?: Partial<Record<Lowercase<ExpectationUnit>, {
         min?: ExpectationAmount;
         max?: ExpectationAmount;
     }>>;
+    /**
+     * Expect this format of the answer
+     */
+    readonly expectFormat?: ExpectFormatCommand['format'];
     /**
      * Requirements for the model
      * - This is required only for executionType PROMPT_TEMPLATE
@@ -31,7 +38,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
  */

package/package.json

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

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

@@ -6,9 +6,18 @@ import { Prompt } from '../types/Prompt';
 import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
 import { PromptTemplatePipelineString } from '../types/PromptTemplatePipelineString';
 import { PromptTemplatePipeline } from './PromptTemplatePipeline';
+/**
+ * Options for PromptTemplatePipelineLibrary
+ */
 type PromptTemplatePipelineLibraryOptions = {
+    /**
+     * The library of prompt template pipelines
+     */
     readonly library: Record<string_name, PromptTemplatePipeline>;
-    readonly settings: CreatePtpExecutorSettings;
+    /**
+     * Optional settings for creating a PromptTemplatePipelineExecutor
+     */
+    readonly settings?: Partial<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.
@@ -28,9 +37,10 @@ export declare class PromptTemplatePipelineLibrary {
      * Note: You can combine .ptbk.md and .ptbk.json files BUT it is not recommended
      *
      * @param ptbkSources contents of .ptbk.md or .ptbk.json files
+     * @param settings settings for creating executor functions
      * @returns PromptTemplatePipelineLibrary
      */
-    static fromSources(ptbkSources: Record<string_name, PromptTemplatePipelineJson | PromptTemplatePipelineString>, settings: CreatePtpExecutorSettings): PromptTemplatePipelineLibrary;
+    static fromSources(ptbkSources: Record<string_name, PromptTemplatePipelineJson | PromptTemplatePipelineString>, settings?: Partial<CreatePtpExecutorSettings>): PromptTemplatePipelineLibrary;
     private constructor();
     /**
      * Gets prompt template pipeline by name

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

@@ -5,14 +5,26 @@ export interface CreatePtpExecutorSettings {
     /**
      * When executor does not satisfy expectations it will be retried this amount of times
      *
-     * !!!!!!! Make default in version 24.1.0
+     * @default 3
      */
     readonly maxNaturalExecutionAttempts: number;
 }
+/**
+ * Options for creating a PTP (Prompt Template Pipeline) executor
+ */
 interface CreatePtpExecutorOptions {
+    /**
+     * The Prompt Template Pipeline (PTP) to be executed
+     */
     readonly ptp: PromptTemplatePipeline;
+    /**
+     * The execution tools to be used during the execution of the PTP
+     */
     readonly tools: ExecutionTools;
-    readonly settings: CreatePtpExecutorSettings;
+    /**
+     * Optional settings for the PTP executor
+     */
+    readonly settings?: Partial<CreatePtpExecutorSettings>;
 }
 /**
  * Creates executor function from prompt template pipeline and execution tools.

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 { ExpectFormatCommand } from '../Command';
 import { ExecutionType } from '../ExecutionTypes';
 import { ModelRequirements } from '../ModelRequirements';
 import { ScriptLanguage } from '../ScriptLanguage';
@@ -12,12 +13,18 @@ export type PromptTemplateJson = NaturalTemplateJson | SimpleTemplateJson | Scri
 export interface NaturalTemplateJson extends PromptTemplateJsonCommon {
     readonly executionType: 'PROMPT_TEMPLATE';
     /**
-     * Expectations for the answer
+     * Expect this amount of each unit in the answer
+     *
+     * For example 5 words, 3 sentences, 2 paragraphs, ...
      */
-    readonly expectations: Partial<Record<Lowercase<ExpectationUnit>, {
+    readonly expectAmount?: Partial<Record<Lowercase<ExpectationUnit>, {
         min?: ExpectationAmount;
         max?: ExpectationAmount;
     }>>;
+    /**
+     * Expect this format of the answer
+     */
+    readonly expectFormat?: ExpectFormatCommand['format'];
     /**
      * Requirements for the model
      * - This is required only for executionType PROMPT_TEMPLATE
@@ -31,7 +38,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
  */