@promptbook/openai 0.44.0-1 → 0.44.0-11

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/_packages/utils.index.d.ts

@@ -1,6 +1,7 @@
 import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptbookString';
 import { parseNumber } from '../conversion/utils/parseNumber';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
+import { checkExpectations, isPassingExpectations } from '../execution/utils/checkExpectations';
 import { replaceParameters } from '../execution/utils/replaceParameters';
 import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
 import { ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults } from '../types/execution-report/ExecutionReportStringOptions';
@@ -40,9 +41,9 @@ import { removeQuotes } from '../utils/removeQuotes';
 import { trimCodeBlock } from '../utils/trimCodeBlock';
 import { trimEndOfCodeBlock } from '../utils/trimEndOfCodeBlock';
 import { unwrapResult } from '../utils/unwrapResult';
-export { assertsExecutionSuccessful, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, extractAllBlocksFromMarkdown, // <- [🌻]
+export { assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, extractAllBlocksFromMarkdown, // <- [🌻]
 extractAllListItemsFromMarkdown, extractBlock, // <- [🌻]
-extractOneBlockFromMarkdown, isValidJsonString, parseNumber, // <- [🌻]
+extractOneBlockFromMarkdown, isPassingExpectations, isValidJsonString, parseNumber, // <- [🌻]
 prettifyPromptbookString, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
 export { countCharacters, countLines, countPages, countParagraphs, countSentences, CountUtils, countWords };
 export { splitIntoSentences };

package/esm/typings/config.d.ts

@@ -2,3 +2,7 @@
  * The maximum number of iterations for a loops
  */
 export declare const LOOP_LIMIT = 1000;
+/**
+ * The maximum number of iterations for a loops which adds characters one by one
+ */
+export declare const CHARACTER_LOOP_LIMIT = 100000;

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,15 @@
+import type { Expectations } from '../../../../types/PromptbookJson/PromptTemplateJson';
+import { PostprocessingFunction } from '../../script-execution-tools/javascript/JavascriptExecutionToolsOptions';
+/**
+ * Gets the expectations and creates a fake text that meets the expectations
+ *
+ * Note: You can provide postprocessing functions to modify the text before checking the expectations
+ *       The result will be the text BEFORE the postprocessing
+ *
+ * @private internal util for MockedFackedNaturalExecutionTools
+ */
+export declare function $fakeTextToExpectations(expectations: Expectations, postprocessing?: Array<PostprocessingFunction>): Promise<string>;
+/**
+ * TODO: Implement better - create FakeLLM from this
+ * TODO: [💝] Unite object for expecting amount and format - use here also a format
+ */

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

@@ -0,0 +1 @@
+export {};

package/esm/typings/execution/plugins/natural-execution-tools/mocked/faked-completion.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/execution/plugins/script-execution-tools/javascript/JavascriptExecutionToolsOptions.d.ts

@@ -15,8 +15,12 @@ export type JavascriptExecutionToolsOptions = CommonExecutionToolsOptions & {
      * Note: There are also some built-in functions available:
      *      @see ./JavascriptEvalExecutionTools.ts
      */
-    functions?: Record<string_javascript_name, ((value: string) => Promisable<string>) | Function>;
+    functions?: Record<string_javascript_name, PostprocessingFunction>;
 };
+/**
+ * Function that can be used to postprocess the output of the LLM
+ */
+export type PostprocessingFunction = ((value: string) => Promisable<string>) | Function;
 /**
  * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
  */

package/esm/typings/execution/utils/checkExpectations.d.ts

@@ -0,0 +1,25 @@
+import type { Expectations } from '../../types/PromptbookJson/PromptTemplateJson';
+/**
+ * Function checkExpectations will check if the expectations on given value are met
+ *
+ * Note: There are two simmilar functions:
+ * - `checkExpectations` which throws an error if the expectations are not met
+ * - `isPassingExpectations` which returns a boolean
+ *
+ * @throws {ExpectError} if the expectations are not met
+ * @returns {void} Nothing
+ */
+export declare function checkExpectations(expectations: Expectations, value: string): void;
+/**
+ * Function checkExpectations will check if the expectations on given value are met
+ *
+ * Note: There are two simmilar functions:
+ * - `checkExpectations` which throws an error if the expectations are not met
+ * - `isPassingExpectations` which returns a boolean
+ *
+ * @returns {boolean} True if the expectations are met
+ */
+export declare function isPassingExpectations(expectations: Expectations, value: string): boolean;
+/**
+ * TODO: [💝] Unite object for expecting amount and format
+ */

package/esm/typings/execution/utils/checkExpectations.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -1,5 +1,7 @@
 import type { string_name, string_prompt, string_promptbook_url_with_hashtemplate, string_title } from '.././types/typeAliases';
+import { 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.
  *
@@ -23,6 +25,17 @@ export type Prompt = {
      * Requirements for the model
      */
     readonly modelRequirements: ModelRequirements;
+    /**
+     * List of postprocessing steps that are executed after the prompt
+     */
+    readonly postprocessing?: Array<PostprocessingFunction>;
+    /**
+     * 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,14 +116,12 @@ 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
      *
      * Note: Expectations are performed after all postprocessing steps
+     * @deprecated [💝]
      */
     readonly expectFormat?: ExpectFormatCommand['format'];
     /**
@@ -122,5 +131,6 @@ interface PromptTemplateJsonCommon {
 }
 export {};
 /**
+ * TODO: [💝] Unite object for expecting amount and format - remove expectFormat
  * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.44.0-1",
+    "version": "0.44.0-11",
     "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-11"
     },
     "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/_packages/utils.index.d.ts

@@ -1,6 +1,7 @@
 import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptbookString';
 import { parseNumber } from '../conversion/utils/parseNumber';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
+import { checkExpectations, isPassingExpectations } from '../execution/utils/checkExpectations';
 import { replaceParameters } from '../execution/utils/replaceParameters';
 import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
 import { ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults } from '../types/execution-report/ExecutionReportStringOptions';
@@ -40,9 +41,9 @@ import { removeQuotes } from '../utils/removeQuotes';
 import { trimCodeBlock } from '../utils/trimCodeBlock';
 import { trimEndOfCodeBlock } from '../utils/trimEndOfCodeBlock';
 import { unwrapResult } from '../utils/unwrapResult';
-export { assertsExecutionSuccessful, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, extractAllBlocksFromMarkdown, // <- [🌻]
+export { assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, extractAllBlocksFromMarkdown, // <- [🌻]
 extractAllListItemsFromMarkdown, extractBlock, // <- [🌻]
-extractOneBlockFromMarkdown, isValidJsonString, parseNumber, // <- [🌻]
+extractOneBlockFromMarkdown, isPassingExpectations, isValidJsonString, parseNumber, // <- [🌻]
 prettifyPromptbookString, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
 export { countCharacters, countLines, countPages, countParagraphs, countSentences, CountUtils, countWords };
 export { splitIntoSentences };

package/umd/typings/config.d.ts

@@ -2,3 +2,7 @@
  * The maximum number of iterations for a loops
  */
 export declare const LOOP_LIMIT = 1000;
+/**
+ * The maximum number of iterations for a loops which adds characters one by one
+ */
+export declare const CHARACTER_LOOP_LIMIT = 100000;

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,15 @@
+import type { Expectations } from '../../../../types/PromptbookJson/PromptTemplateJson';
+import { PostprocessingFunction } from '../../script-execution-tools/javascript/JavascriptExecutionToolsOptions';
+/**
+ * Gets the expectations and creates a fake text that meets the expectations
+ *
+ * Note: You can provide postprocessing functions to modify the text before checking the expectations
+ *       The result will be the text BEFORE the postprocessing
+ *
+ * @private internal util for MockedFackedNaturalExecutionTools
+ */
+export declare function $fakeTextToExpectations(expectations: Expectations, postprocessing?: Array<PostprocessingFunction>): Promise<string>;
+/**
+ * TODO: Implement better - create FakeLLM from this
+ * TODO: [💝] Unite object for expecting amount and format - use here also a format
+ */

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

@@ -0,0 +1 @@
+export {};

package/umd/typings/execution/plugins/natural-execution-tools/mocked/faked-completion.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/typings/execution/plugins/script-execution-tools/javascript/JavascriptExecutionToolsOptions.d.ts

@@ -15,8 +15,12 @@ export type JavascriptExecutionToolsOptions = CommonExecutionToolsOptions & {
      * Note: There are also some built-in functions available:
      *      @see ./JavascriptEvalExecutionTools.ts
      */
-    functions?: Record<string_javascript_name, ((value: string) => Promisable<string>) | Function>;
+    functions?: Record<string_javascript_name, PostprocessingFunction>;
 };
+/**
+ * Function that can be used to postprocess the output of the LLM
+ */
+export type PostprocessingFunction = ((value: string) => Promisable<string>) | Function;
 /**
  * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
  */

package/umd/typings/execution/utils/checkExpectations.d.ts

@@ -0,0 +1,25 @@
+import type { Expectations } from '../../types/PromptbookJson/PromptTemplateJson';
+/**
+ * Function checkExpectations will check if the expectations on given value are met
+ *
+ * Note: There are two simmilar functions:
+ * - `checkExpectations` which throws an error if the expectations are not met
+ * - `isPassingExpectations` which returns a boolean
+ *
+ * @throws {ExpectError} if the expectations are not met
+ * @returns {void} Nothing
+ */
+export declare function checkExpectations(expectations: Expectations, value: string): void;
+/**
+ * Function checkExpectations will check if the expectations on given value are met
+ *
+ * Note: There are two simmilar functions:
+ * - `checkExpectations` which throws an error if the expectations are not met
+ * - `isPassingExpectations` which returns a boolean
+ *
+ * @returns {boolean} True if the expectations are met
+ */
+export declare function isPassingExpectations(expectations: Expectations, value: string): boolean;
+/**
+ * TODO: [💝] Unite object for expecting amount and format
+ */

package/umd/typings/execution/utils/checkExpectations.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -1,5 +1,7 @@
 import type { string_name, string_prompt, string_promptbook_url_with_hashtemplate, string_title } from '.././types/typeAliases';
+import { 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.
  *
@@ -23,6 +25,17 @@ export type Prompt = {
      * Requirements for the model
      */
     readonly modelRequirements: ModelRequirements;
+    /**
+     * List of postprocessing steps that are executed after the prompt
+     */
+    readonly postprocessing?: Array<PostprocessingFunction>;
+    /**
+     * 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,14 +116,12 @@ 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
      *
      * Note: Expectations are performed after all postprocessing steps
+     * @deprecated [💝]
      */
     readonly expectFormat?: ExpectFormatCommand['format'];
     /**
@@ -122,5 +131,6 @@ interface PromptTemplateJsonCommon {
 }
 export {};
 /**
+ * TODO: [💝] Unite object for expecting amount and format - remove expectFormat
  * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
  */