@promptbook/types 0.56.0 → 0.57.0-0

package/esm/index.es.js

@@ -11,7 +11,7 @@ var EXPECTATION_UNITS = ['CHARACTERS', 'WORDS', 'SENTENCES', 'LINES', 'PARAGRAPH
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.56.0-4';
+var PROMPTBOOK_VERSION = '0.56.0';
 
 export { EXPECTATION_UNITS, PROMPTBOOK_VERSION };
 //# sourceMappingURL=index.es.js.map

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

@@ -22,7 +22,7 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
     /**
      * Calls OpenAI API to use a chat model.
      */
-    gptChat(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptChatResult>;
+    gptChat(prompt: Pick<Prompt, 'content' | 'modelRequirements' | 'expectFormat'>): Promise<PromptChatResult>;
     /**
      * Calls OpenAI API to use a complete model.
      */

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

@@ -1,10 +1,11 @@
+import type { PostprocessingFunction } from '../execution/plugins/script-execution-tools/javascript/JavascriptExecutionToolsOptions';
+import type { ExpectFormatCommand } from './Command';
+import type { ModelRequirements } from './ModelRequirements';
+import type { Expectations } from './PromptbookJson/PromptTemplateJson';
 import type { string_name } from './typeAliases';
 import type { string_prompt } from './typeAliases';
 import type { string_promptbook_url_with_hashtemplate } from './typeAliases';
 import type { string_title } from './typeAliases';
-import type { PostprocessingFunction } from '../execution/plugins/script-execution-tools/javascript/JavascriptExecutionToolsOptions';
-import type { ModelRequirements } from './ModelRequirements';
-import type { Expectations } from './PromptbookJson/PromptTemplateJson';
 /**
  * Prompt in a text along with model requirements, but without any execution or templating logic.
  *
@@ -39,6 +40,13 @@ export type Prompt = {
      * If not set, nothing is expected from the answer
      */
     readonly expectations?: Expectations;
+    /**
+     * Expect this format of the answer
+     *
+     * Note: Expectations are performed after all postprocessing steps
+     * @deprecated [💝]
+     */
+    readonly expectFormat?: ExpectFormatCommand['format'];
     /**
      * Unique identifier of the promptbook with specific template name as hash
      *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.56.0",
+    "version": "0.57.0-0",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -45,7 +45,7 @@
         }
     ],
     "peerDependencies": {
-        "@promptbook/core": "0.56.0"
+        "@promptbook/core": "0.57.0-0"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/index.umd.js

@@ -17,7 +17,7 @@
 	/**
 	 * The version of the Promptbook library
 	 */
-	var PROMPTBOOK_VERSION = '0.56.0-4';
+	var PROMPTBOOK_VERSION = '0.56.0';
 
 	exports.EXPECTATION_UNITS = EXPECTATION_UNITS;
 	exports.PROMPTBOOK_VERSION = PROMPTBOOK_VERSION;

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

@@ -22,7 +22,7 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
     /**
      * Calls OpenAI API to use a chat model.
      */
-    gptChat(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptChatResult>;
+    gptChat(prompt: Pick<Prompt, 'content' | 'modelRequirements' | 'expectFormat'>): Promise<PromptChatResult>;
     /**
      * Calls OpenAI API to use a complete model.
      */

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

@@ -1,10 +1,11 @@
+import type { PostprocessingFunction } from '../execution/plugins/script-execution-tools/javascript/JavascriptExecutionToolsOptions';
+import type { ExpectFormatCommand } from './Command';
+import type { ModelRequirements } from './ModelRequirements';
+import type { Expectations } from './PromptbookJson/PromptTemplateJson';
 import type { string_name } from './typeAliases';
 import type { string_prompt } from './typeAliases';
 import type { string_promptbook_url_with_hashtemplate } from './typeAliases';
 import type { string_title } from './typeAliases';
-import type { PostprocessingFunction } from '../execution/plugins/script-execution-tools/javascript/JavascriptExecutionToolsOptions';
-import type { ModelRequirements } from './ModelRequirements';
-import type { Expectations } from './PromptbookJson/PromptTemplateJson';
 /**
  * Prompt in a text along with model requirements, but without any execution or templating logic.
  *
@@ -39,6 +40,13 @@ export type Prompt = {
      * If not set, nothing is expected from the answer
      */
     readonly expectations?: Expectations;
+    /**
+     * Expect this format of the answer
+     *
+     * Note: Expectations are performed after all postprocessing steps
+     * @deprecated [💝]
+     */
+    readonly expectFormat?: ExpectFormatCommand['format'];
     /**
      * Unique identifier of the promptbook with specific template name as hash
      *