@promptbook/openai 0.44.0-9 → 0.45.0

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

@@ -1,3 +1,4 @@
+import { spaceTrim } from 'spacetrim';
 import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptbookString';
 import { parseNumber } from '../conversion/utils/parseNumber';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
@@ -44,17 +45,18 @@ import { unwrapResult } from '../utils/unwrapResult';
 export { assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, extractAllBlocksFromMarkdown, // <- [🌻]
 extractAllListItemsFromMarkdown, extractBlock, // <- [🌻]
 extractOneBlockFromMarkdown, isPassingExpectations, isValidJsonString, parseNumber, // <- [🌻]
-prettifyPromptbookString, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
+prettifyPromptbookString, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, spaceTrim, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
 export { countCharacters, countLines, countPages, countParagraphs, countSentences, CountUtils, countWords };
 export { splitIntoSentences };
 export declare const normalizeTo: {
     camelCase: typeof normalizeTo_camelCase;
     PascalCase: typeof normalizeTo_PascalCase;
-    'SCREAMING-CASE': typeof normalizeTo_SCREAMING_CASE;
+    SCREAMING_CASE: typeof normalizeTo_SCREAMING_CASE;
     snake_case: typeof normalizeTo_snake_case;
     'kebab-case': typeof normalizeToKebabCase;
 };
 export { capitalize, decapitalize, DIACRITIC_VARIANTS_LETTERS, IKeywords, isValidKeyword, nameToUriPart, nameToUriParts, normalizeTo_camelCase, normalizeTo_PascalCase, normalizeTo_SCREAMING_CASE, normalizeTo_snake_case, normalizeToKebabCase, normalizeWhitespaces, parseKeywords, parseKeywordsFromString, removeDiacritics, searchKeywords, string_keyword, };
 /**
  * TODO: [🧠] Maybe create some indipendent package like `markdown-tools` from both here exported and @private utilities
+ * Note: [🕙] It does not make sence to have simple lower / UPPER case normalization
  */

package/umd/typings/conversion/promptbookStringToJson.d.ts

@@ -1,5 +1,5 @@
-import { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
-import { PromptbookString } from '../types/PromptbookString';
+import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
+import type { PromptbookString } from '../types/PromptbookString';
 /**
  * Parse promptbook from string format to JSON format
  *

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

@@ -1,6 +1,6 @@
-import { NaturalExecutionTools } from './NaturalExecutionTools';
-import { ScriptExecutionTools } from './ScriptExecutionTools';
-import { UserInterfaceTools } from './UserInterfaceTools';
+import type { NaturalExecutionTools } from './NaturalExecutionTools';
+import type { ScriptExecutionTools } from './ScriptExecutionTools';
+import type { UserInterfaceTools } from './UserInterfaceTools';
 /**
  * All the tools needed to execute prompts (template pipelines).
  *

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

@@ -1,5 +1,5 @@
-import { Prompt } from '../types/Prompt';
-import { PromptChatResult, PromptCompletionResult } from './PromptResult';
+import type { Prompt } from '../types/Prompt';
+import type { PromptChatResult, PromptCompletionResult } from './PromptResult';
 /**
  * Vontainer for all the tools needed to execute prompts to large language models like GPT-4
  * On its interface it exposes common methods for prompt execution.

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

@@ -1,5 +1,5 @@
-import { string_name, string_script } from '.././types/typeAliases';
-import { ScriptLanguage } from '../types/ScriptLanguage';
+import type { string_name, string_script } from '.././types/typeAliases';
+import type { ScriptLanguage } from '../types/ScriptLanguage';
 /**
  * Represents all the tools needed to EXECUTE SCRIPTs
  *

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

@@ -1,4 +1,4 @@
-import { number_integer, number_positive } from '../types/typeAliases';
+import type { number_integer, number_positive } from '../types/typeAliases';
 /**
  * Represents all the tools needed to interact with the user.
  *

package/umd/typings/execution/plugins/natural-execution-tools/langtail/LangtailExecutionTools.d.ts

@@ -0,0 +1,10 @@
+import type { NaturalExecutionTools } from '../../../NaturalExecutionTools';
+import { OpenAiExecutionTools } from '../openai/OpenAiExecutionTools';
+/**
+ * Execution Tools for calling OpenAI API.
+ */
+export declare class LangtailExecutionTools extends OpenAiExecutionTools implements NaturalExecutionTools {
+}
+/**
+ * TODO: !!! Make lib which exports this
+ */

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

@@ -1,11 +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): string;
+export declare function $fakeTextToExpectations(expectations: Expectations, postprocessing?: Array<PostprocessingFunction>): Promise<string>;
 /**
- * TODO: Implement better
+ * 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/openai/OpenAiExecutionTools.d.ts

@@ -11,6 +11,11 @@ export declare class OpenAiExecutionTools implements NaturalExecutionTools {
      * OpenAI API client.
      */
     private readonly openai;
+    /**
+     * Creates OpenAI Execution Tools.
+     *
+     * @param options which are relevant are directly passed to the OpenAI client
+     */
     constructor(options: OpenAiExecutionToolsOptions);
     /**
      * Calls OpenAI API to use a chat model.

package/umd/typings/execution/plugins/natural-execution-tools/openai/OpenAiExecutionToolsOptions.d.ts

@@ -1,13 +1,13 @@
-import { string_token } from '../../../.././types/typeAliases';
-import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+import type { ClientOptions } from 'openai';
+import type { string_token } from '../../../.././types/typeAliases';
+import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
 /**
  * Options for OpenAiExecutionTools
+ *
+ * This extends OpenAI's `ClientOptions` with are directly passed to the OpenAI client.
+ * Rest is used by the `OpenAiExecutionTools`.
  */
-export type OpenAiExecutionToolsOptions = CommonExecutionToolsOptions & {
-    /**
-     * OpenAI API key
-     */
-    openAiApiKey: string_token;
+export type OpenAiExecutionToolsOptions = CommonExecutionToolsOptions & ClientOptions & {
     /**
      * A unique identifier representing your end-user, which can help OpenAI to monitor
      * and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).

package/umd/typings/execution/plugins/natural-execution-tools/remote/RemoteNaturalExecutionToolsOptions.d.ts

@@ -1,5 +1,5 @@
 import type { client_id, string_uri } from '../../../.././types/typeAliases';
-import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
 /**
  * Options for RemoteNaturalExecutionTools
  */

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/plugins/script-execution-tools/javascript/utils/unknownToString.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Converts anything to string that can be used for debugging and logging
+ *
+ * @param value String value for logging
+ * @private Internal util
+ */
+export declare function unknownToString(value: unknown): string;

package/umd/typings/execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceToolsOptions.d.ts

@@ -1,6 +1,6 @@
-import { Promisable } from 'type-fest';
-import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
-import { UserInterfaceToolsPromptDialogOptions } from '../../../UserInterfaceTools';
+import type { Promisable } from 'type-fest';
+import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+import type { UserInterfaceToolsPromptDialogOptions } from '../../../UserInterfaceTools';
 /**
  * Options for CallbackInterfaceTools
  */

package/umd/typings/execution/translation/automatic-translate/automatic-translators/AutomaticTranslator.d.ts

@@ -1,4 +1,4 @@
-import { Promisable } from 'type-fest';
+import type { Promisable } from 'type-fest';
 export type AutomaticTranslator = {
     translate(message: string): Promisable<string>;
 };

package/umd/typings/library/PromptbookLibrary.d.ts

@@ -1,4 +1,4 @@
-import { Promisable } from 'type-fest';
+import type { Promisable } from 'type-fest';
 import type { Prompt } from '../types/Prompt';
 import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
 import type { string_promptbook_url } from '../types/typeAliases';

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

@@ -1,4 +1,4 @@
-import { TupleToUnion } from 'type-fest';
+import type { TupleToUnion } from 'type-fest';
 /**
  * Execution type describes the way how the block is executed
  *

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

@@ -1,4 +1,4 @@
-import { string_model_name } from './typeAliases';
+import type { string_model_name } from './typeAliases';
 export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT"];
 /**
  * Model variant describes the very general type of the model

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

@@ -1,4 +1,5 @@
 import type { string_name, string_prompt, string_promptbook_url_with_hashtemplate, string_title } from '.././types/typeAliases';
+import type { PostprocessingFunction } from '../execution/plugins/script-execution-tools/javascript/JavascriptExecutionToolsOptions';
 import type { ModelRequirements } from './ModelRequirements';
 import type { Expectations } from './PromptbookJson/PromptTemplateJson';
 /**
@@ -24,6 +25,10 @@ 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
      *

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

@@ -1,8 +1,8 @@
-import { ExpectFormatCommand } from '../Command';
-import { ExecutionType } from '../ExecutionTypes';
-import { ModelRequirements } from '../ModelRequirements';
-import { ScriptLanguage } from '../ScriptLanguage';
-import { number_integer, number_positive_or_zero, string_javascript, string_javascript_name, string_markdown, string_name, string_prompt, string_template } from '../typeAliases';
+import type { ExpectFormatCommand } from '../Command';
+import type { ExecutionType } from '../ExecutionTypes';
+import type { ModelRequirements } from '../ModelRequirements';
+import type { ScriptLanguage } from '../ScriptLanguage';
+import type { number_integer, number_positive_or_zero, string_javascript, string_javascript_name, string_markdown, string_name, string_prompt, string_template } from '../typeAliases';
 /**
  * Describes one prompt template in the promptbook
  */
@@ -121,6 +121,7 @@ interface PromptTemplateJsonCommon {
      * Expect this format of the answer
      *
      * Note: Expectations are performed after all postprocessing steps
+     * @deprecated [💝]
      */
     readonly expectFormat?: ExpectFormatCommand['format'];
     /**

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

@@ -1,4 +1,4 @@
-import { string_name } from '../typeAliases';
+import type { string_name } from '../typeAliases';
 /**
  * Describes one parameter of the promptbook
  */

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

@@ -1,6 +1,6 @@
-import { string_promptbook_url, string_version } from '../typeAliases';
-import { PromptTemplateJson } from './PromptTemplateJson';
-import { PromptTemplateParameterJson } from './PromptTemplateParameterJson';
+import type { string_promptbook_url, string_version } from '../typeAliases';
+import type { PromptTemplateJson } from './PromptTemplateJson';
+import type { PromptTemplateParameterJson } from './PromptTemplateParameterJson';
 /**
  * Promptbook is the **core concept of this library**.
  * It represents a series of prompt templates chained together to form a pipeline / one big prompt template with input and result parameters.

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

@@ -1,4 +1,4 @@
-import { TupleToUnion } from 'type-fest';
+import type { TupleToUnion } from 'type-fest';
 /**
  * Supported script languages
  */

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

@@ -1,5 +1,5 @@
-import { ExecutionType } from './ExecutionTypes';
-import { string_markdown_text, string_name } from './typeAliases';
+import type { ExecutionType } from './ExecutionTypes';
+import type { string_markdown_text, string_name } from './typeAliases';
 /**
  * TaskProgress represents the progress of a Promptbook execution.
  */

package/umd/typings/types/execution-report/ExecutionReportStringOptions.d.ts

@@ -1,4 +1,4 @@
-import { number_percent } from '../typeAliases';
+import type { number_percent } from '../typeAliases';
 /**
  * Options for generating an execution report string
  */

package/umd/typings/utils/markdown/extractAllBlocksFromMarkdown.d.ts

@@ -1,4 +1,4 @@
-import { string_markdown } from '../../types/typeAliases';
+import type { string_markdown } from '../../types/typeAliases';
 /**
  * Single code block inside markdown.
  */