@promptbook/openai 0.44.0-1 → 0.44.0-2

package/esm/typings/_packages/core.index.d.ts

@@ -2,6 +2,7 @@ import { promptbookStringToJson } from '../conversion/promptbookStringToJson';
 import { validatePromptbookJson } from '../conversion/validation/validatePromptbookJson';
 import { createPromptbookExecutor } from '../execution/createPromptbookExecutor';
 import { MockedEchoNaturalExecutionTools } from '../execution/plugins/natural-execution-tools/mocked/MockedEchoNaturalExecutionTools';
+import { MockedFackedNaturalExecutionTools } from '../execution/plugins/natural-execution-tools/mocked/MockedFackedNaturalExecutionTools';
 import { CallbackInterfaceTools } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceTools';
 import { CallbackInterfaceToolsOptions } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceToolsOptions';
 import { SimplePromptInterfaceTools } from '../execution/plugins/user-interface-execution-tools/simple-prompt/SimplePromptInterfaceTools';
@@ -15,6 +16,6 @@ export { ExecutionTypes, PROMPTBOOK_VERSION };
 export { createPromptbookLibraryFromPromise, createPromptbookLibraryFromSources, createPromptbookSublibrary, SimplePromptbookLibrary, };
 export { SimplePromptInterfaceTools };
 export { promptbookStringToJson, validatePromptbookJson };
-export { MockedEchoNaturalExecutionTools };
+export { MockedEchoNaturalExecutionTools, MockedFackedNaturalExecutionTools };
 export { createPromptbookExecutor };
 export { CallbackInterfaceTools, CallbackInterfaceToolsOptions };

package/esm/typings/execution/plugins/natural-execution-tools/mocked/MockedEchoNaturalExecutionTools.d.ts

@@ -18,5 +18,5 @@ export declare class MockedEchoNaturalExecutionTools implements NaturalExecution
     gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
 }
 /**
- * TODO: Allow in spaceTrim: nesting with > ${block(prompt.request)}
+ * TODO: Allow in spaceTrim: nesting with > ${block(prompt.request)}, same as replace params
  */

package/esm/typings/execution/plugins/natural-execution-tools/mocked/MockedFackedNaturalExecutionTools.d.ts

@@ -0,0 +1,19 @@
+import { Prompt } from '../../../../types/Prompt';
+import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+import { NaturalExecutionTools } from '../../../NaturalExecutionTools';
+import { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
+/**
+ * Mocked execution Tools for just faking expected responses for testing purposes
+ */
+export declare class MockedFackedNaturalExecutionTools implements NaturalExecutionTools {
+    private readonly options;
+    constructor(options: CommonExecutionToolsOptions);
+    /**
+     * Fakes chat model
+     */
+    gptChat(prompt: Prompt): Promise<PromptChatResult & PromptCompletionResult>;
+    /**
+     * Fakes completion model
+     */
+    gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+}

package/esm/typings/execution/plugins/natural-execution-tools/mocked/fakeTextToExpectations.d.ts

@@ -0,0 +1,7 @@
+import type { Expectations } from '../../../../types/PromptbookJson/PromptTemplateJson';
+/**
+ * Gets the expectations and creates a fake text that meets the expectations
+ *
+ * @private internal util for MockedFackedNaturalExecutionTools
+ */
+export declare function $fakeTextToExpectations(expectations: Expectations): string;

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

@@ -1,5 +1,6 @@
 import type { string_name, string_prompt, string_promptbook_url_with_hashtemplate, string_title } from '.././types/typeAliases';
 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.
  *
@@ -23,6 +24,13 @@ export type Prompt = {
      * Requirements for the model
      */
     readonly modelRequirements: ModelRequirements;
+    /**
+     * Expectations for the answer
+     *
+     * For example 5 words, 3 sentences, 2 paragraphs, ...
+     * If not set, nothing is expected from the answer
+     */
+    readonly expectations?: Expectations;
     /**
      * Unique identifier of the promptbook with specific template name as hash
      *

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

@@ -18,6 +18,17 @@ export type NaturalTemplateJson = PromptTemplateJsonCommon & {
      */
     readonly modelRequirements: ModelRequirements;
 };
+/**
+ * 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
+ */
+export type Expectations = Partial<Record<Lowercase<ExpectationUnit>, {
+    min?: ExpectationAmount;
+    max?: ExpectationAmount;
+}>>;
 /**
  * Units of text measurement
  */
@@ -105,10 +116,7 @@ interface PromptTemplateJsonCommon {
      *
      * Note: Expectations are performed after all postprocessing steps
      */
-    readonly expectAmount?: Partial<Record<Lowercase<ExpectationUnit>, {
-        min?: ExpectationAmount;
-        max?: ExpectationAmount;
-    }>>;
+    readonly expectations?: Expectations;
     /**
      * Expect this format of the answer
      *

package/package.json

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

package/umd/typings/_packages/core.index.d.ts

@@ -2,6 +2,7 @@ import { promptbookStringToJson } from '../conversion/promptbookStringToJson';
 import { validatePromptbookJson } from '../conversion/validation/validatePromptbookJson';
 import { createPromptbookExecutor } from '../execution/createPromptbookExecutor';
 import { MockedEchoNaturalExecutionTools } from '../execution/plugins/natural-execution-tools/mocked/MockedEchoNaturalExecutionTools';
+import { MockedFackedNaturalExecutionTools } from '../execution/plugins/natural-execution-tools/mocked/MockedFackedNaturalExecutionTools';
 import { CallbackInterfaceTools } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceTools';
 import { CallbackInterfaceToolsOptions } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceToolsOptions';
 import { SimplePromptInterfaceTools } from '../execution/plugins/user-interface-execution-tools/simple-prompt/SimplePromptInterfaceTools';
@@ -15,6 +16,6 @@ export { ExecutionTypes, PROMPTBOOK_VERSION };
 export { createPromptbookLibraryFromPromise, createPromptbookLibraryFromSources, createPromptbookSublibrary, SimplePromptbookLibrary, };
 export { SimplePromptInterfaceTools };
 export { promptbookStringToJson, validatePromptbookJson };
-export { MockedEchoNaturalExecutionTools };
+export { MockedEchoNaturalExecutionTools, MockedFackedNaturalExecutionTools };
 export { createPromptbookExecutor };
 export { CallbackInterfaceTools, CallbackInterfaceToolsOptions };

package/umd/typings/execution/plugins/natural-execution-tools/mocked/MockedEchoNaturalExecutionTools.d.ts

@@ -18,5 +18,5 @@ export declare class MockedEchoNaturalExecutionTools implements NaturalExecution
     gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
 }
 /**
- * TODO: Allow in spaceTrim: nesting with > ${block(prompt.request)}
+ * TODO: Allow in spaceTrim: nesting with > ${block(prompt.request)}, same as replace params
  */

package/umd/typings/execution/plugins/natural-execution-tools/mocked/MockedFackedNaturalExecutionTools.d.ts

@@ -0,0 +1,19 @@
+import { Prompt } from '../../../../types/Prompt';
+import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+import { NaturalExecutionTools } from '../../../NaturalExecutionTools';
+import { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
+/**
+ * Mocked execution Tools for just faking expected responses for testing purposes
+ */
+export declare class MockedFackedNaturalExecutionTools implements NaturalExecutionTools {
+    private readonly options;
+    constructor(options: CommonExecutionToolsOptions);
+    /**
+     * Fakes chat model
+     */
+    gptChat(prompt: Prompt): Promise<PromptChatResult & PromptCompletionResult>;
+    /**
+     * Fakes completion model
+     */
+    gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+}

package/umd/typings/execution/plugins/natural-execution-tools/mocked/fakeTextToExpectations.d.ts

@@ -0,0 +1,7 @@
+import type { Expectations } from '../../../../types/PromptbookJson/PromptTemplateJson';
+/**
+ * Gets the expectations and creates a fake text that meets the expectations
+ *
+ * @private internal util for MockedFackedNaturalExecutionTools
+ */
+export declare function $fakeTextToExpectations(expectations: Expectations): string;

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

@@ -1,5 +1,6 @@
 import type { string_name, string_prompt, string_promptbook_url_with_hashtemplate, string_title } from '.././types/typeAliases';
 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.
  *
@@ -23,6 +24,13 @@ export type Prompt = {
      * Requirements for the model
      */
     readonly modelRequirements: ModelRequirements;
+    /**
+     * Expectations for the answer
+     *
+     * For example 5 words, 3 sentences, 2 paragraphs, ...
+     * If not set, nothing is expected from the answer
+     */
+    readonly expectations?: Expectations;
     /**
      * Unique identifier of the promptbook with specific template name as hash
      *

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

@@ -18,6 +18,17 @@ export type NaturalTemplateJson = PromptTemplateJsonCommon & {
      */
     readonly modelRequirements: ModelRequirements;
 };
+/**
+ * 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
+ */
+export type Expectations = Partial<Record<Lowercase<ExpectationUnit>, {
+    min?: ExpectationAmount;
+    max?: ExpectationAmount;
+}>>;
 /**
  * Units of text measurement
  */
@@ -105,10 +116,7 @@ interface PromptTemplateJsonCommon {
      *
      * Note: Expectations are performed after all postprocessing steps
      */
-    readonly expectAmount?: Partial<Record<Lowercase<ExpectationUnit>, {
-        min?: ExpectationAmount;
-        max?: ExpectationAmount;
-    }>>;
+    readonly expectations?: Expectations;
     /**
      * Expect this format of the answer
      *