@promptbook/openai 0.61.0-9 → 0.61.0

package/umd/typings/src/llm-providers/openai/openai-models.d.ts

@@ -10,8 +10,8 @@ import type { number_usd } from '../../types/typeAliases';
  */
 export declare const OPENAI_MODELS: Array<AvailableModel & {
     pricing?: {
-        prompt: number_usd;
-        output: number_usd;
+        readonly prompt: number_usd;
+        readonly output: number_usd;
     };
 }>;
 /**
@@ -24,4 +24,5 @@ export declare const OPENAI_MODELS: Array<AvailableModel & {
  * @see /other/playground/playground.ts
  * TODO: [🍓] Make better
  * TODO: Change model titles to human eg: "gpt-4-turbo-2024-04-09" -> "GPT-4 Turbo (2024-04-09)"
+ * TODO: [🚸] Not all models are compatible with JSON mode, add this information here and use it
  */

package/umd/typings/src/llm-providers/openai/playground/playground.d.ts

@@ -1,2 +1,5 @@
 #!/usr/bin/env ts-node
 export {};
+/**
+ * TODO: !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ */

package/umd/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts

@@ -1,9 +1,11 @@
 import type { AvailableModel } from '../../execution/LlmExecutionTools';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
-import type { PromptChatResult } from '../../execution/PromptResult';
-import type { PromptCompletionResult } from '../../execution/PromptResult';
-import type { PromptEmbeddingResult } from '../../execution/PromptResult';
-import type { Prompt } from '../../types/Prompt';
+import type { ChatPromptResult } from '../../execution/PromptResult';
+import type { CompletionPromptResult } from '../../execution/PromptResult';
+import type { EmbeddingPromptResult } from '../../execution/PromptResult';
+import type { ChatPrompt } from '../../types/Prompt';
+import type { CompletionPrompt } from '../../types/Prompt';
+import type { EmbeddingPrompt } from '../../types/Prompt';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_markdown_text } from '../../types/typeAliases';
 import type { string_title } from '../../types/typeAliases';
@@ -28,15 +30,15 @@ export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
     /**
      * Calls remote proxy server to use a chat model
      */
-    callChatModel(prompt: Prompt): Promise<PromptChatResult>;
+    callChatModel(prompt: ChatPrompt): Promise<ChatPromptResult>;
     /**
      * Calls remote proxy server to use a completion model
      */
-    callCompletionModel(prompt: Prompt): Promise<PromptCompletionResult>;
+    callCompletionModel(prompt: CompletionPrompt): Promise<CompletionPromptResult>;
     /**
      * Calls remote proxy server to use a embedding model
      */
-    callEmbeddingModel(prompt: Prompt): Promise<PromptEmbeddingResult>;
+    callEmbeddingModel(prompt: EmbeddingPrompt): Promise<EmbeddingPromptResult>;
     /**
      * Calls remote proxy server to use both completion or chat model
      */
@@ -48,5 +50,5 @@ export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
 }
 /**
  * TODO: [🍓] Allow to list compatible models with each variant
- * TODO: [🤹‍♂️] RemoteLlmExecutionTools should extend Destroyable and implement IDestroyable
+ * TODO: [🗯] RemoteLlmExecutionTools should extend Destroyable and implement IDestroyable
  */

package/umd/typings/src/llm-providers/remote/RemoteLlmExecutionToolsOptions.d.ts

@@ -2,7 +2,7 @@ import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutio
 import type { client_id } from '../../types/typeAliases';
 import type { string_uri } from '../../types/typeAliases';
 /**
- * Options for RemoteLlmExecutionTools
+ * Options for `RemoteLlmExecutionTools`
  */
 export type RemoteLlmExecutionToolsOptions = CommonExecutionToolsOptions & {
     /**

package/umd/typings/src/llm-providers/remote/startRemoteServer.d.ts

@@ -12,8 +12,8 @@ export declare function startRemoteServer(options: RemoteServerOptions): IDestro
 /**
  * TODO: [⚖] Expose the collection to be able to connect to same collection via createCollectionFromUrl
  * TODO: Handle progress - support streaming
- * TODO: [🤹‍♂️] Do not hang up immediately but wait until client closes OR timeout
- * TODO: [🤹‍♂️] Timeout on chat to free up resources
+ * TODO: [🗯] Do not hang up immediately but wait until client closes OR timeout
+ * TODO: [🗯] Timeout on chat to free up resources
  * TODO: [🃏] Pass here some security token to prevent malitious usage and/or DDoS
  * TODO: [0] Set unavailable models as undefined in `RemoteLlmExecutionTools` NOT throw error here
  */

package/umd/typings/src/personas/preparePersona.d.ts

@@ -0,0 +1,15 @@
+import type { PrepareOptions } from '../prepare/PrepareOptions';
+import type { PersonaPreparedJson } from '../types/PipelineJson/PersonaJson';
+import type { string_persona_description } from '../types/typeAliases';
+/**
+ * Prepares the persona for the pipeline
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/22
+ */
+export declare function preparePersona(personaDescription: string_persona_description, options: PrepareOptions): Promise<PersonaPreparedJson['modelRequirements']>;
+/**
+ * TODO: [🔼] !!! Export via `@promptbook/core`
+ * TODO: [🏢] !! Check validity of `modelName` in pipeline
+ * TODO: [🏢] !! Check validity of `systemMessage` in pipeline
+ * TODO: [🏢] !! Check validity of `temperature` in pipeline
+ */

package/umd/typings/src/personas/preparePersona.test.d.ts

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

package/umd/typings/src/prepare/PrepareOptions.d.ts

@@ -0,0 +1,22 @@
+import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
+/**
+ * Options for preparation of the pipeline
+ */
+export type PrepareOptions = {
+    /**
+     * LLM tools
+     */
+    readonly llmTools: LlmExecutionTools;
+    /**
+     * Maximum number of tasks running in parallel
+     *
+     * @default MAX_PARALLEL_COUNT
+     */
+    readonly maxParallelCount?: number;
+    /**
+     * If true, the preparation logs additional information
+     *
+     * @default false
+     */
+    readonly isVerbose?: boolean;
+};

package/umd/typings/src/prepare/isPipelinePrepared.d.ts

@@ -0,0 +1,14 @@
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+/**
+ * Determine if the pipeline is fully prepared
+ */
+export declare function isPipelinePrepared(pipeline: PipelineJson): boolean;
+/**
+ * TODO: [🐠] Maybe base this on `makeValidator`
+ * TODO: [🔼] Export via core or utils
+ * TODO: [🧊] Pipeline can be partially prepared, this should return true ONLY if fully prepared
+ * TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`
+ *     - [🏍] ? Is context in each template
+ *     - [♨] Are samples prepared
+ *     - [♨] Are templates prepared
+ */

package/umd/typings/src/prepare/isPipelinePrepared.test.d.ts

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

package/umd/typings/src/prepare/preparePipeline.d.ts

@@ -0,0 +1,17 @@
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import type { PrepareOptions } from './PrepareOptions';
+/**
+ * Prepare pipeline from string (markdown) format to JSON format
+ *
+ * Note: This function does not validate logic of the pipeline
+ * Note: This function acts as part of compilation process
+ */
+export declare function preparePipeline(pipeline: PipelineJson, options: PrepareOptions): Promise<PipelineJson>;
+/**
+ * TODO: [🔼] !!! Export via `@promptbook/core`
+ * TODO: Write tests for `preparePipeline`
+ * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
+ * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
+ * TODO: [🎐] !!!!! Use here countTotalUsage
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
+ */

package/umd/typings/src/prepare/prepareTemplates.d.ts

@@ -0,0 +1,31 @@
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import type { PromptTemplateJson } from '../types/PipelineJson/PromptTemplateJson';
+import type { PrepareOptions } from './PrepareOptions';
+type PrepareTemplateInput = Pick<PipelineJson, 'promptTemplates' | 'parameters'> & {
+    /**
+     * @@@
+     */
+    readonly knowledgePiecesCount: number;
+};
+type PreparedTemplates = {
+    /**
+     * @@@ Sequence of prompt templates that are chained together to form a pipeline
+     */
+    readonly promptTemplatesPrepared: Array<PromptTemplateJson>;
+};
+/**
+ * @@@
+ */
+export declare function prepareTemplates(pipeline: PrepareTemplateInput, options: PrepareOptions): Promise<PreparedTemplates>;
+export {};
+/**
+ * TODO: [🧠] Add context to each template (if missing)
+ * TODO: [🧠] What is better name `prepareTemplate` or `prepareTemplateAndParameters`
+ * TODO: [♨] !!! Prepare index the samples and maybe templates
+ * TODO: [🔼] !!! Export via `@promptbook/core`
+ * TODO: Write tests for `preparePipeline`
+ * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
+ * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
+ * TODO: [🧠][🥜]
+ */

package/umd/typings/src/prepare/unpreparePipeline.d.ts

@@ -0,0 +1,11 @@
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+/**
+ * Unprepare just strips the preparation data of the pipeline
+ */
+export declare function unpreparePipeline(pipeline: PipelineJson): PipelineJson;
+/**
+ * TODO: [🔼] !!! Export via `@promptbook/core`
+ * TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`
+ * TODO: Write tests for `preparePipeline`
+ * TODO: [🍙] Make some standart order of json properties
+ */

package/umd/typings/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts

@@ -2,7 +2,7 @@ import type { Promisable } from 'type-fest';
 import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
 import type { string_javascript_name } from '../../types/typeAliases';
 /**
- * Options for javascript execution
+ * Options for `JavascriptExecutionTools`
  */
 export type JavascriptExecutionToolsOptions = CommonExecutionToolsOptions & {
     /**

package/umd/typings/src/scripting/javascript/utils/preserve.d.ts

@@ -1,4 +1,4 @@
-import type { really_any } from '../../../types/typeAliases';
+import type { really_any } from '../../../utils/organization/really_any';
 /**
  * Does nothing, but preserves the function in the bundle
  * Compiler is tricked into thinking the function is used

package/umd/typings/src/scripting/javascript/utils/unknownToString.d.ts

@@ -1,7 +1,8 @@
+import type { really_unknown } from '../../../utils/organization/really_unknown';
 /**
  * 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;
+export declare function unknownToString(value: really_unknown): string;

package/umd/typings/src/storage/_common/PromptbookStorage.d.ts

@@ -0,0 +1,25 @@
+import { Promisable } from 'type-fest';
+/**
+ * Storage of objects with asynchronous API
+ *
+ * Note: Naming `PromptbookStorage` not `Storage` to avoid name collision with global `Storage` interface.
+ * Note: This is simmilar to Web Storage API interface but everything is asynchronous and can store JSON objects.
+ */
+export type PromptbookStorage<TItem> = {
+    /**
+     * Returns the current value associated with the given key, or null if the given key does not exist in the list associated with the object
+     */
+    getItem(key: string): Promisable<TItem | null>;
+    /**
+     * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously
+     */
+    setItem(key: string, value: TItem): Promisable<void>;
+    /**
+     * Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists
+     */
+    removeItem(key: string): Promisable<void>;
+};
+/**
+ * TODO: [🔼] !!! Export via `@promptbook/types`
+ * TODO: [🧠][🛫] Constrain `TItem` to JSON-serializable objects only
+ */

package/umd/typings/src/storage/_common/PromptbookStorage.test-type.d.ts

@@ -0,0 +1,5 @@
+export {};
+/**
+ * Note: [⚪] This should never be in any released package
+ * TODO: Is this a good pattern to do type testing?
+ */

package/umd/typings/src/storage/files-storage/FilesStorage.d.ts

@@ -0,0 +1,30 @@
+import type { PromptbookStorage } from '../_common/PromptbookStorage';
+import type { FilesStorageOptions } from './FilesStorageOptions';
+/**
+ * @@@
+ */
+export declare class FilesStorage<TItem> implements PromptbookStorage<TItem> {
+    private readonly options;
+    constructor(options: FilesStorageOptions);
+    /**
+     * @@@
+     */
+    private getFilenameForKey;
+    /**
+     * @@@ Returns the current value associated with the given key, or null if the given key does not exist in the list associated with the object.
+     */
+    getItem(key: string): Promise<TItem | null>;
+    /**
+     * @@@ Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
+     */
+    setItem(key: string, value: TItem): Promise<void>;
+    /**
+     * @@@ Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists.
+     */
+    removeItem(key: string): Promise<void>;
+}
+/**
+ * TODO: [🔼] !!! Export via `@promptbook/node`
+ * TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
+ * Note: [🟢] This code should never be published outside of `@promptbook/node`
+ */

package/umd/typings/src/storage/files-storage/FilesStorageOptions.d.ts

@@ -0,0 +1,13 @@
+import type { string_folder_path } from '../../types/typeAliases';
+/**
+ * @@@
+ */
+export type FilesStorageOptions = {
+    /**
+     * @@@
+     */
+    cacheFolderPath: string_folder_path;
+};
+/**
+ * TODO: [🔼] !!! Export via `@promptbook/types`
+ */

package/umd/typings/src/storage/files-storage/utils/nameToSubfolderPath.d.ts

@@ -0,0 +1,7 @@
+import type { string_name } from '../../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private for `FilesStorage`
+ */
+export declare function nameToSubfolderPath(name: string_name): Array<string>;

package/umd/typings/src/storage/files-storage/utils/nameToSubfolderPath.test.d.ts

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

package/umd/typings/src/storage/local-storage/getLocalStorage.d.ts

@@ -0,0 +1,9 @@
+import type { PromptbookStorage } from '../_common/PromptbookStorage';
+/**
+ * Gets wrapper around `localStorage` object which can be used as `PromptbookStorage`
+ */
+export declare function getLocalStorage<TItem>(): PromptbookStorage<TItem>;
+/**
+ * TODO: [🔼] !!! Export via `@promptbook/browser`
+ * Note: [🔵] This code should never be published outside of `@promptbook/browser`
+ */

package/umd/typings/src/storage/local-storage/getSessionStorage.d.ts

@@ -0,0 +1,9 @@
+import type { PromptbookStorage } from '../_common/PromptbookStorage';
+/**
+ * Gets wrapper around `sessionStorage` object which can be used as `PromptbookStorage`
+ */
+export declare function getSessionStorage<TItem>(): PromptbookStorage<TItem>;
+/**
+ * TODO: [🔼] !!! Export via `@promptbook/browser`
+ * Note: [🔵] This code should never be published outside of `@promptbook/browser`
+ */

package/umd/typings/src/storage/memory/MemoryStorage.d.ts

@@ -0,0 +1,34 @@
+import type { PromptbookStorage } from '../_common/PromptbookStorage';
+/**
+ * Stores
+ */
+export declare class MemoryStorage<TItem> implements PromptbookStorage<TItem> {
+    private storage;
+    /**
+     * Returns the number of key/value pairs currently present in the list associated with the object.
+     */
+    get length(): number;
+    /**
+     * Empties the list associated with the object of all key/value pairs, if there are any.
+     */
+    clear(): void;
+    /**
+     * Returns the current value associated with the given key, or null if the given key does not exist in the list associated with the object.
+     */
+    getItem(key: string): TItem | null;
+    /**
+     * Returns the name of the nth key in the list, or null if n is greater than or equal to the number of key/value pairs in the object.
+     */
+    key(index: number): string | null;
+    /**
+     * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
+     */
+    setItem(key: string, value: TItem): void;
+    /**
+     * Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists.
+     */
+    removeItem(key: string): void;
+}
+/**
+ * TODO: [🔼] !!! Export via `@promptbook/core`
+ */

package/umd/typings/src/storage/utils/PrefixStorage.d.ts

@@ -0,0 +1,26 @@
+import { Promisable } from 'type-fest';
+import type { PromptbookStorage } from '../_common/PromptbookStorage';
+/**
+ * This class behaves like LocalStorage but separates keys by prefix
+ */
+export declare class PrefixStorage<TItem> implements PromptbookStorage<TItem> {
+    private baseStorage;
+    private keyPrefix;
+    private separator;
+    constructor(baseStorage: PromptbookStorage<TItem>, keyPrefix: string, separator?: string);
+    /**
+     * Returns the current value associated with the given key, or null if the given key does not exist in the list associated with the object.
+     */
+    getItem(key: string): Promisable<TItem | null>;
+    /**
+     * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
+     */
+    setItem(key: string, value: TItem): Promisable<void>;
+    /**
+     * Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists.
+     */
+    removeItem(key: string): void;
+}
+/**
+ * TODO: [🔼] !!! Export via `@promptbook/core`
+ */

package/umd/typings/src/storage/utils/makePromptbookStorageFromWebStorage.d.ts

@@ -0,0 +1,11 @@
+import type { PromptbookStorage } from '../_common/PromptbookStorage';
+/**
+ * @@@
+ *
+ * @private for `getLocalStorage` and `getSessionStorage`
+ */
+export declare function makePromptbookStorageFromWebStorage<TValue>(webStorage: Storage): PromptbookStorage<TValue>;
+/**
+ * TODO: [🧠] Should this be named `makePromptbookStorageFromWebStorage` vs `createPromptbookStorageFromWebStorage`
+ * TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
+ */

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

@@ -1,25 +1,67 @@
+import type { ModelVariant } from './ModelVariant';
+import type { number_model_temperature } from './typeAliases';
+import type { number_seed } from './typeAliases';
 import type { string_model_name } from './typeAliases';
-export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT", "EMBEDDING"];
+import type { string_system_message } from './typeAliases';
 /**
- * Model variant describes the very general type of the model
+ * Abstract way to specify the LLM.
+ * It does not specify the LLM with concrete version itself, only the requirements for the LLM.
  *
- * There are two variants:
- * - **COMPLETION** - model that takes prompt and writes the rest of the text
- * - **CHAT** - model that takes prompt and previous messages and returns response
+ * Note: This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook#model-requirements
  */
-export type ModelVariant = typeof MODEL_VARIANTS[number];
+export type ModelRequirements = CompletionModelRequirements | ChatModelRequirements | EmbeddingModelRequirements;
 /**
- * Abstract way to specify the LLM. It does not specify the LLM with concrete version itself, only the requirements for the LLM.
+ * Model requirements for the completion variant
  *
- * @see https://github.com/webgptorg/promptbook#model-requirements
+ * Note: This is fully serializable as JSON
+ */
+export type CompletionModelRequirements = CommonModelRequirements & {
+    /**
+     * Completion model variant
+     */
+    modelVariant: 'COMPLETION';
+};
+/**
+ * Model requirements for the chat variant
+ *
+ * Note: This is fully serializable as JSON
+ */
+export type ChatModelRequirements = CommonModelRequirements & {
+    /**
+     * Chat model variant
+     */
+    modelVariant: 'CHAT';
+    /**
+     * System message to be used in the model
+     */
+    readonly systemMessage?: string_system_message;
+};
+/**
+ * Model requirements for the embedding variant
+ *
+ * Note: This is fully serializable as JSON
+ */
+export type EmbeddingModelRequirements = CommonModelRequirements & {
+    /**
+     * Embedding model variant
+     */
+    modelVariant: 'EMBEDDING';
+};
+/**
+ * Common properties for all model requirements variants
+ *
+ * Note: This is fully serializable as JSON
  */
-export type ModelRequirements = {
+export type CommonModelRequirements = {
     /**
      * Model variant describes the very general type of the model
      *
-     * There are two variants:
+     * There are 3 variants:
      * - **COMPLETION** - model that takes prompt and writes the rest of the text
      * - **CHAT** - model that takes prompt and previous messages and returns response
+     * - **EMBEDDING** - model that takes prompt and returns embedding
+     * <- [🤖]
      */
     readonly modelVariant: ModelVariant;
     /**
@@ -31,13 +73,31 @@ export type ModelRequirements = {
      * @example 'gpt-4', 'gpt-4-32k-0314', 'gpt-3.5-turbo-instruct',...
      */
     readonly modelName?: string_model_name;
+    /**
+     * The temperature of the model
+     *
+     * Note: [💱] Promptbook is using just `temperature` (not `top_k` and `top_p`)
+     */
+    readonly temperature?: number_model_temperature;
+    /**
+     * Seed for the model
+     */
+    readonly seed?: number_seed;
     /**
      * Maximum number of tokens that can be generated by the model
+     *
+     * Note: [🌾]
      */
     readonly maxTokens?: number;
 };
 /**
+ * TODO: [🔼] !!!!! (<- To all [🔼]) Export all from `@promptbook/types`
+ * TODO: [🧠][🈁] `seed` should maybe be somewhere else (not in `ModelRequirements`) (simmilar that `user` identification is not here)
+ * TODO: [🧠][💱] Add more model options: `stop_token`, `logit_bias`, `logprobs` (`top_logprobs`), `top_k`, `top_p`, `presence_penalty`, `frequency_penalty`, `bestOf`, `logitBias`, `logitBiasType`,...
+ *       [💱] Probbably keep using just `temperature` in Promptbook (not `top_k` and `top_p`)
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  * TODO: Maybe figure out better word than "variant"
  * TODO: Add here more requirement options like max context size, max tokens, etc.
- * TODO: [👙][🧠] Just selecting gpt3 or gpt4 level of model
+ * TODO: [💕][🧠] Just selecting gpt3 or gpt4 level of model
+ * TODO: [🧄] Replace all "github.com/webgptorg/promptbook#xxx" with "ptbk.io/xxx"
  */

package/umd/typings/src/types/ModelVariant.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @@@
+ *
+ * @private for `ModelVariant` and `modelCommandParser`
+ */
+export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT", "EMBEDDING"];
+/**
+ * Model variant describes the very general type of the model
+ *
+ * There are two variants:
+ * - **COMPLETION** - model that takes prompt and writes the rest of the text
+ * - **CHAT** - model that takes prompt and previous messages and returns response
+ */
+export type ModelVariant = typeof MODEL_VARIANTS[number];

package/umd/typings/src/types/PipelineJson/Expectations.d.ts

@@ -6,21 +6,25 @@ import type { number_positive } from '../typeAliases';
  * For example 5 words, 3 sentences, 2 paragraphs, ...
  *
  * Note: Expectations are performed after all postprocessing steps
+ * @see https://github.com/webgptorg/promptbook/discussions/30
  */
 export type Expectations = Partial<Record<Lowercase<ExpectationUnit>, {
-    min?: ExpectationAmount;
-    max?: ExpectationAmount;
+    readonly min?: ExpectationAmount;
+    readonly max?: ExpectationAmount;
 }>>;
 /**
  * Units of text measurement
+ * @see https://github.com/webgptorg/promptbook/discussions/30
  */
 export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTENCES", "LINES", "PARAGRAPHS", "PAGES"];
 /**
  * Unit of text measurement
+ * @see https://github.com/webgptorg/promptbook/discussions/30
  */
 export type ExpectationUnit = typeof EXPECTATION_UNITS[number];
 /**
  * Amount of text measurement
+ * @see https://github.com/webgptorg/promptbook/discussions/30
  */
 export type ExpectationAmount = number_integer & (number_positive | 0);
 /**