@promptbook/utils 0.61.0-13 → 0.61.0-14

package/umd/typings/src/execution/PromptResult.d.ts

@@ -1,37 +1,34 @@
-import type { KebabCase } from 'type-fest';
-import type { ExpectationUnit } from '../types/PipelineJson/Expectations';
-import type { number_positive } from '../types/typeAliases';
-import type { number_usd } from '../types/typeAliases';
 import type { string_date_iso8601 } from '../types/typeAliases';
 import type { string_model_name } from '../types/typeAliases';
+import type { TODO_object } from '../utils/organization/TODO_object';
 import type { EmbeddingVector } from './EmbeddingVector';
+import type { PromptResultUsage } from './PromptResultUsage';
 /**
  * Prompt result is the simplest concept of execution.
  * It is the result of executing one prompt _(NOT a template)_.
  *
  * @see https://github.com/webgptorg/promptbook#prompt-result
  */
-export type PromptResult = PromptCompletionResult | PromptChatResult | PromptEmbeddingResult;
+export type PromptResult = CompletionPromptResult | ChatPromptResult | EmbeddingPromptResult;
 /**
- * Prompt completion result
- * It contains only the following text NOT the whole completion
+ * Completion prompt result
  *
+ * Note:It contains only the newly generated text NOT the whole completion
  * Note: This is fully serializable as JSON
  */
-export type PromptCompletionResult = PromptCommonResult;
+export type CompletionPromptResult = CommonPromptResult;
 /**
- * Prompt chat result
+ *Chat prompt result
  *
  * Note: This is fully serializable as JSON
  */
-export type PromptChatResult = PromptCommonResult & {};
+export type ChatPromptResult = CommonPromptResult & {};
 /**
- * Prompt embedding result
- * It contains only the following text NOT the whole completion
+ * Embedding prompt  result
  *
  * Note: This is fully serializable as JSON
  */
-export type PromptEmbeddingResult = Omit<PromptCommonResult, 'content'> & {
+export type EmbeddingPromptResult = Omit<CommonPromptResult, 'content'> & {
     /**
      * The response from the model
      */
@@ -42,7 +39,7 @@ export type PromptEmbeddingResult = Omit<PromptCommonResult, 'content'> & {
  *
  * Note: This is fully serializable as JSON
  */
-export type PromptCommonResult = {
+export type CommonPromptResult = {
     /**
      * Exact text response from the model
      */
@@ -75,52 +72,13 @@ export type PromptCommonResult = {
     /**
      * Raw response from the model
      */
-    readonly rawResponse: object;
-};
-/**
- * Usage statistics for one or many prompt results
- */
-export type PromptResultUsage = {
-    /**
-     * Cost of the execution in USD
-     *
-     * Note: If the cost is unknown, the value 0 and isUncertain is true
-     */
-    price: UncertainNumber;
-    /**
-     * Number of whatever used in the input aka. `prompt_tokens`
-     */
-    input: PromptResultUsageCounts;
-    /**
-     * Number of tokens used in the output aka. `completion_tokens`
-     */
-    output: PromptResultUsageCounts;
-};
-/**
- * Record of all possible measurable units
- */
-export type PromptResultUsageCounts = Record<`${KebabCase<'TOKENS' | ExpectationUnit>}Count`, UncertainNumber>;
-/**
- * Number which can be uncertain
- *
- * Note: If the value is completelly unknown, the value 0 and isUncertain is true
- * Note: Not using NaN or null because it looses the value which is better to be uncertain then not to be at all
- */
-export type UncertainNumber = {
-    /**
-     * The numeric value
-     */
-    readonly value: number_usd & (number_positive | 0);
-    /**
-     * Is the value uncertain
-     */
-    readonly isUncertain?: true;
+    readonly rawResponse: TODO_object;
 };
 /**
  * TODO: [🧠] Maybe timing more accurate then seconds?
  * TODO: [🧠] Should here be link to the prompt?
- * TODO: [🧠] Maybe type raw properly - not onject but OpenAI.result.whatever
+ * TODO: [🧠] Maybe type `rawResponse` properly - not onject but OpenAI.result.whatever
  * TODO: [🧠] Maybe remove redundant raw.choices.text
  * TODO: Log raw even if prompt failed - log the raw error
- * TODO: [🏳] Add `PromptTranslationResult`
+ * TODO: [🏳] Add `TranslationPromptResult`
  */

package/umd/typings/src/execution/PromptResultUsage.d.ts

@@ -0,0 +1,26 @@
+import type { KebabCase } from 'type-fest';
+import type { ExpectationUnit } from '../types/PipelineJson/Expectations';
+import type { UncertainNumber } from './UncertainNumber';
+/**
+ * Usage statistics for one or many prompt results
+ */
+export type PromptResultUsage = {
+    /**
+     * Cost of the execution in USD
+     *
+     * Note: If the cost is unknown, the value 0 and isUncertain is true
+     */
+    price: UncertainNumber;
+    /**
+     * Number of whatever used in the input aka. `prompt_tokens`
+     */
+    input: PromptResultUsageCounts;
+    /**
+     * Number of tokens used in the output aka. `completion_tokens`
+     */
+    output: PromptResultUsageCounts;
+};
+/**
+ * Record of all possible measurable units
+ */
+export type PromptResultUsageCounts = Record<`${KebabCase<'TOKENS' | ExpectationUnit>}Count`, UncertainNumber>;

package/umd/typings/src/execution/UncertainNumber.d.ts

@@ -0,0 +1,18 @@
+import type { number_positive } from '../types/typeAliases';
+import type { number_usd } from '../types/typeAliases';
+/**
+ * Number which can be uncertain
+ *
+ * Note: If the value is completelly unknown, the value 0 and isUncertain is true
+ * Note: Not using NaN or null because it looses the value which is better to be uncertain then not to be at all
+ */
+export type UncertainNumber = {
+    /**
+     * The numeric value
+     */
+    readonly value: number_usd & (number_positive | 0);
+    /**
+     * Is the value uncertain
+     */
+    readonly isUncertain?: true;
+};

package/umd/typings/src/execution/utils/addUsage.d.ts

@@ -1,4 +1,4 @@
-import type { PromptResultUsage } from '../PromptResult';
+import type { PromptResultUsage } from '../PromptResultUsage';
 /**
  * @@@
  *

package/umd/typings/src/execution/utils/computeUsageCounts.d.ts

@@ -1,4 +1,4 @@
-import type { PromptResultUsageCounts } from '../PromptResult';
+import type { PromptResultUsageCounts } from '../PromptResultUsage';
 /**
  * Helper of usage compute
  *

package/umd/typings/src/execution/utils/uncertainNumber.d.ts

@@ -1,4 +1,4 @@
-import type { UncertainNumber } from '../PromptResult';
+import type { UncertainNumber } from '../UncertainNumber';
 /**
  * Make UncertainNumber
  *

package/umd/typings/src/execution/utils/usageToWorktime.d.ts

@@ -1,5 +1,5 @@
-import type { PromptResultUsage } from '../PromptResult';
-import type { UncertainNumber } from '../PromptResult';
+import type { PromptResultUsage } from '../PromptResultUsage';
+import type { UncertainNumber } from '../UncertainNumber';
 /**
  * Function usageToWorktime will take usage and estimate saved worktime in hours of reading / writing
  *

package/umd/typings/src/llm-providers/_common/createLlmToolsFromEnv.d.ts

@@ -1,8 +1,16 @@
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+export type CreateLlmToolsFromEnvOptions = {
+    /**
+     * This will will be passed to the created `LlmExecutionTools`
+     *
+     * @default false
+     */
+    isVerbose?: boolean;
+};
 /**
  * @@@
  *
- * Note: This function is not cached, every call creates new instance of LlmExecutionTools
+ * Note: This function is not cached, every call creates new instance of `LlmExecutionTools`
  *
  * It looks for environment variables:
  * - `process.env.OPENAI_API_KEY`
@@ -10,7 +18,7 @@ import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
  *
  * @returns @@@
  */
-export declare function createLlmToolsFromEnv(): LlmExecutionTools;
+export declare function createLlmToolsFromEnv(options?: CreateLlmToolsFromEnvOptions): LlmExecutionTools;
 /**
  * TODO: [🔼] !!! Export via `@promptbook/node`
  * TODO: @@@ write discussion about this - wizzard

package/umd/typings/src/llm-providers/_common/getLlmToolsForTestingAndScriptsAndPlayground.d.ts

@@ -1,10 +1,11 @@
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { CreateLlmToolsFromEnvOptions } from './createLlmToolsFromEnv';
 /**
  * Returns LLM tools for testing purposes
  *
  * @private within the repository - JUST FOR TESTS, SCRIPTS AND PLAYGROUND
  */
-export declare function getLlmToolsForTestingAndScriptsAndPlayground(): LlmExecutionTools;
+export declare function getLlmToolsForTestingAndScriptsAndPlayground(options?: CreateLlmToolsFromEnvOptions): LlmExecutionTools;
 /**
  * Note: [⚪] This should never be in any released package
  */

package/umd/typings/src/llm-providers/_common/utils/count-total-cost/LlmExecutionToolsWithTotalCost.d.ts

@@ -1,5 +1,5 @@
 import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
-import type { PromptResultUsage } from '../../../../execution/PromptResult';
+import type { PromptResultUsage } from '../../../../execution/PromptResultUsage';
 /**
  * LLM tools with option to get total cost of the execution
  */

package/umd/typings/src/llm-providers/_common/utils/count-total-cost/limitTotalCost.d.ts

@@ -1,7 +1,7 @@
 import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
-import type { PromptResultUsage } from '../../../../execution/PromptResult';
+import type { PromptResultUsage } from '../../../../execution/PromptResultUsage';
 import type { PromptbookStorage } from '../../../../storage/_common/PromptbookStorage';
-import type { TODO } from '../../../../utils/organization/TODO';
+import type { TODO_any } from '../../../../utils/organization/TODO_any';
 import type { LlmExecutionToolsWithTotalCost } from './LlmExecutionToolsWithTotalCost';
 /**
  * Options for `limitTotalCost`
@@ -18,7 +18,7 @@ type LimitTotalCostOptions = {
      *
      * @default MemoryStorage
      */
-    storage: PromptbookStorage<TODO>;
+    storage: PromptbookStorage<TODO_any>;
 };
 /**
  * @@@

package/umd/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts

@@ -1,6 +1,6 @@
 import type { AvailableModel } from '../../execution/LlmExecutionTools';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
-import type { PromptChatResult } from '../../execution/PromptResult';
+import type { ChatPromptResult } from '../../execution/PromptResult';
 import type { Prompt } from '../../types/Prompt';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_markdown_text } from '../../types/typeAliases';
@@ -26,7 +26,7 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
     /**
      * Calls Anthropic Claude API to use a chat model.
      */
-    callChatModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptChatResult>;
+    callChatModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<ChatPromptResult>;
     /**
      * Get the model that should be used as default
      */

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

@@ -1,7 +1,7 @@
 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 { ChatPromptResult } from '../../execution/PromptResult';
+import type { CompletionPromptResult } from '../../execution/PromptResult';
 import type { Prompt } from '../../types/Prompt';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_markdown_text } from '../../types/typeAliases';
@@ -27,11 +27,11 @@ export declare class AzureOpenAiExecutionTools implements LlmExecutionTools {
     /**
      * Calls OpenAI API to use a chat model.
      */
-    callChatModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptChatResult>;
+    callChatModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<ChatPromptResult>;
     /**
      * Calls Azure OpenAI API to use a complete model.
      */
-    callCompletionModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptCompletionResult>;
+    callCompletionModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<CompletionPromptResult>;
     /**
      * Changes Azure error (which is not propper Error but object) to propper Error
      */

package/umd/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts

@@ -1,8 +1,8 @@
 import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
 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 { ChatPromptResult } from '../../execution/PromptResult';
+import type { CompletionPromptResult } from '../../execution/PromptResult';
 import type { Prompt } from '../../types/Prompt';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_markdown_text } from '../../types/typeAliases';
@@ -18,11 +18,11 @@ export declare class MockedEchoLlmExecutionTools implements LlmExecutionTools {
     /**
      * Mocks chat model
      */
-    callChatModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptChatResult>;
+    callChatModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<ChatPromptResult>;
     /**
      * Mocks completion model
      */
-    callCompletionModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptCompletionResult>;
+    callCompletionModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<CompletionPromptResult>;
     /**
      * List all available mocked-models that can be used
      */

package/umd/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts

@@ -1,9 +1,9 @@
 import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
 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 { ChatPromptResult } from '../../execution/PromptResult';
+import type { CompletionPromptResult } from '../../execution/PromptResult';
+import type { EmbeddingPromptResult } from '../../execution/PromptResult';
 import type { Prompt } from '../../types/Prompt';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_markdown_text } from '../../types/typeAliases';
@@ -19,15 +19,15 @@ export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools
     /**
      * Fakes chat model
      */
-    callChatModel(prompt: Pick<Prompt, 'content' | 'modelRequirements' | 'expectations' | 'postprocessing'>): Promise<PromptChatResult & PromptCompletionResult>;
+    callChatModel(prompt: Pick<Prompt, 'content' | 'modelRequirements' | 'expectations' | 'postprocessing'>): Promise<ChatPromptResult & CompletionPromptResult>;
     /**
      * Fakes completion model
      */
-    callCompletionModel(prompt: Pick<Prompt, 'content' | 'modelRequirements' | 'expectations' | 'postprocessing'>): Promise<PromptCompletionResult>;
+    callCompletionModel(prompt: Pick<Prompt, 'content' | 'modelRequirements' | 'expectations' | 'postprocessing'>): Promise<CompletionPromptResult>;
     /**
      * Fakes embedding model
      */
-    callEmbeddingModel(prompt: Pick<Prompt, 'content' | 'modelRequirements' | 'expectations' | 'postprocessing'>): Promise<PromptEmbeddingResult>;
+    callEmbeddingModel(prompt: Pick<Prompt, 'content' | 'modelRequirements' | 'expectations' | 'postprocessing'>): Promise<EmbeddingPromptResult>;
     /**
      * List all available fake-models that can be used
      */

package/umd/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.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';
@@ -26,15 +28,15 @@ export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
     /**
      * Calls the best available chat model
      */
-    callChatModel(prompt: Prompt): Promise<PromptChatResult>;
+    callChatModel(prompt: ChatPrompt): Promise<ChatPromptResult>;
     /**
      * Calls the best available completion model
      */
-    callCompletionModel(prompt: Prompt): Promise<PromptCompletionResult>;
+    callCompletionModel(prompt: CompletionPrompt): Promise<CompletionPromptResult>;
     /**
      * Calls the best available embedding model
      */
-    callEmbeddingModel(prompt: Prompt): Promise<PromptEmbeddingResult>;
+    callEmbeddingModel(prompt: EmbeddingPrompt): Promise<EmbeddingPromptResult>;
     /**
      * Calls the best available model
      */

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

@@ -1,8 +1,8 @@
 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 { ChatPromptResult } from '../../execution/PromptResult';
+import type { CompletionPromptResult } from '../../execution/PromptResult';
+import type { EmbeddingPromptResult } from '../../execution/PromptResult';
 import type { Prompt } from '../../types/Prompt';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_markdown_text } from '../../types/typeAliases';
@@ -28,15 +28,15 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
     /**
      * Calls OpenAI API to use a chat model.
      */
-    callChatModel(prompt: Pick<Prompt, 'content' | 'modelRequirements' | 'expectFormat'>): Promise<PromptChatResult>;
+    callChatModel(prompt: Pick<Prompt, 'content' | 'modelRequirements' | 'expectFormat'>): Promise<ChatPromptResult>;
     /**
      * Calls OpenAI API to use a complete model.
      */
-    callCompletionModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptCompletionResult>;
+    callCompletionModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<CompletionPromptResult>;
     /**
      * Calls OpenAI API to use a embedding model
      */
-    callEmbeddingModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptEmbeddingResult>;
+    callEmbeddingModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<EmbeddingPromptResult>;
     /**
      * Get the model that should be used as default
      */

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

@@ -1,5 +1,5 @@
 import type OpenAI from 'openai';
-import type { PromptResultUsage } from '../../execution/PromptResult';
+import type { PromptResultUsage } from '../../execution/PromptResultUsage';
 import type { Prompt } from '../../types/Prompt';
 /**
  * Computes the usage of the OpenAI API based on the response from OpenAI

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
      */

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/types/ModelRequirements.d.ts

@@ -1,28 +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';
 import type { string_system_message } from './typeAliases';
-export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT", "EMBEDDING"];
 /**
- * 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 ModelRequirements = {
+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 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;
     /**
@@ -34,10 +73,6 @@ export type ModelRequirements = {
      * @example 'gpt-4', 'gpt-4-32k-0314', 'gpt-3.5-turbo-instruct',...
      */
     readonly modelName?: string_model_name;
-    /**
-     * System message to be used in the model
-     */
-    readonly systemMessage?: string_system_message;
     /**
      * The temperature of the model
      *
@@ -50,10 +85,13 @@ export type ModelRequirements = {
     readonly seed?: number_seed;
     /**
      * Maximum number of tokens that can be generated by the model
+     *
+     * Note: [🌾]
      */
     readonly maxTokens?: number;
 };
 /**
+ * TODO: [🔼] !!!! 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`)
@@ -61,4 +99,5 @@ export type ModelRequirements = {
  * 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: [🧄] 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/PersonaJson.d.ts

@@ -1,4 +1,4 @@
-import type { ModelRequirements } from '../ModelRequirements';
+import type { ChatModelRequirements } from '../ModelRequirements';
 import type { number_id } from '../typeAliases';
 import type { string_name } from '../typeAliases';
 import type { string_persona_description } from '../typeAliases';
@@ -30,9 +30,7 @@ export type PersonaPreparedJson = PersonaJson & {
      *
      * Note: The model must be CHAT variant to be usable through persona
      */
-    readonly modelRequirements: ModelRequirements & {
-        readonly modelVariant: 'CHAT';
-    };
+    readonly modelRequirements: ChatModelRequirements;
     /**
      * List of preparation ids that were used to prepare this persona
      */

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

@@ -1,4 +1,4 @@
-import type { PromptResultUsage } from '../../execution/PromptResult';
+import type { PromptResultUsage } from '../../execution/PromptResultUsage';
 import type { string_promptbook_version } from '../../version';
 import type { number_id } from '../typeAliases';
 export type PreparationJson = {