@promptbook/openai 0.25.0 → 0.26.0

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.25.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.25.0"
+        "@promptbook/core": "0.26.0"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

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
  */