@promptbook/node 0.61.0-9 → 0.61.0

package/umd/typings/src/commands/_common/types/CommandParser.d.ts

@@ -1,33 +1,61 @@
+import type { WritableDeep } from 'type-fest';
+import type { PromptTemplateJson } from '../../../types/PipelineJson/PromptTemplateJson';
+import type { PipelineJson } from '../../../types/PipelineJson/PipelineJson';
 import type { string_markdown_text } from '../../../types/typeAliases';
 import type { string_name } from '../../../types/typeAliases';
+import type { string_promptbook_documentation_url } from '../../../types/typeAliases';
 import type { string_SCREAMING_CASE } from '../../../utils/normalization/normalizeTo_SCREAMING_CASE';
 import type { CommandUsagePlace } from './CommandUsagePlaces';
 export type CommandParser<TCommand extends {
     type: string_name & string_SCREAMING_CASE;
 }> = {
-    name: string_name & string_SCREAMING_CASE;
-    aliasNames?: Array<string_name & string_SCREAMING_CASE>;
-    deprecatedNames?: Array<string_name & string_SCREAMING_CASE>;
-    usagePlaces: Array<CommandUsagePlace>;
-    description: string_markdown_text;
-    discussionUrl: `https://github.com/webgptorg/promptbook/discussions/${number | '@@'}`;
-    examples: Array<string_markdown_text>;
+    readonly name: string_name & string_SCREAMING_CASE;
+    readonly aliasNames?: Array<string_name & string_SCREAMING_CASE>;
+    readonly deprecatedNames?: Array<string_name & string_SCREAMING_CASE>;
+    readonly usagePlaces: Array<CommandUsagePlace>;
+    readonly description: string_markdown_text;
+    readonly documentationUrl: string_promptbook_documentation_url;
+    readonly examples: Array<string_markdown_text>;
     /**
      * @throws {ParsingError} if the parsing fails
      */
     parse(input: CommandParserInput): TCommand;
+    /**
+     * @@@ Mutated by the command
+     */
+    applyToPipelineJson?(command: TCommand, subjects: ApplyToPipelineJsonSubjects): void;
 };
 export type CommandParserInput = {
-    usagePlace: CommandUsagePlace;
-    raw: string_markdown_text;
-    rawArgs: string_markdown_text;
-    normalized: string_name & string_SCREAMING_CASE;
-    args: Array<string_name & string_SCREAMING_CASE>;
+    readonly usagePlace: CommandUsagePlace;
+    readonly raw: string_markdown_text;
+    readonly rawArgs: string_markdown_text;
+    readonly normalized: string_name & string_SCREAMING_CASE;
+    readonly args: Array<string_name & string_SCREAMING_CASE>;
+};
+/**
+ * @@@ Mutated by the command
+ */
+export type ApplyToPipelineJsonSubjects = {
+    /**
+     * @@@ Mutated by the command
+     */
+    readonly pipelineJson: WritableDeep<PipelineJson>;
+    /**
+     * @@@
+     *
+     * @@@ Mutated by the command
+     *
+     * When used in
+     * - `PIPELINE_HEAD` it is `null`
+     * - `PIPELINE_TEMPLATE` it is the prompt template
+     */
+    readonly templateJson: null | Partial<WritableDeep<PromptTemplateJson>>;
 };
 /**
- * TODO: !!!! Annotate
+ * TODO: @@@ Annotate all
+ * TODO: [🍧][♓️] Add order here
  * TODO: [🧠] Maybe put flag if it is for whole `.ptbk.md` file of just one section
- * TODO: [🍧] CommandParser should have applyToPipelineJson method
+ * TODO: [🍧] All commands must implement `applyToPipelineJson` method
  *       which will apply parsed command to the pipeline JSON
  *       it will be called from `pipelineStringToJsonSync`
  *       and replace hardcoded switch statement and [💐]

package/umd/typings/src/config.d.ts

@@ -6,11 +6,56 @@ 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;
+/**
+ * The maximum number of (LLM) tasks running in parallel
+ */
+export declare const MAX_PARALLEL_COUNT = 5;
+/**
+ * The maximum number of attempts to execute LLM task before giving up
+ */
+export declare const MAX_EXECUTION_ATTEMPTS = 3;
+/**
+ * The maximum length of the (generated) filename
+ */
+export declare const MAX_FILENAME_LENGTH = 30;
+/**
+ * @@@
+ * TODO: [🐝] !!! Use
+ */
+export declare const MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH = 3;
+/**
+ * @@@
+ * TODO: [🐝] !!! Use
+ */
+export declare const MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL = 200;
+/**
+ * Where to store the cache of executions for promptbook CLI
+ */
+export declare const EXECUTIONS_CACHE_DIRNAME = "/.promptbook/executions-cache";
 /**
  * The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createCollectionFromDirectory`
  */
 export declare const PIPELINE_COLLECTION_BASE_FILENAME = "index";
+/**
+ * Nonce which is used for replacing things in strings
+ */
+export declare const REPLACING_NONCE = "u$k42k%!V2zo34w7Fu#@QUHYPW";
 /**
  * The names of the parameters that are reserved for special purposes
  */
-export declare const RESERVED_PARAMETER_NAMES: string[];
+export declare const RESERVED_PARAMETER_NAMES: readonly ["content", "context", "knowledge", "samples", "modelName", "currentDate"];
+/**
+ * @@@
+ */
+export declare const RESERVED_PARAMETER_MISSING_VALUE: string;
+/**
+ * @@@
+ */
+export declare const RESERVED_PARAMETER_RESTRICTED: string;
+/**
+ * @@@
+ */
+export declare const DEBUG_ALLOW_PAYED_TESTING: boolean;
+/**
+ * TODO: [🔼] Export all to core
+ */

package/umd/typings/src/config.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🧠] Maybe more elegant how to prevent accidental costs
+ */

package/umd/typings/src/conversion/pipelineJsonToString.d.ts

@@ -8,7 +8,7 @@ import type { PipelineString } from '../types/PipelineString';
  */
 export declare function pipelineJsonToString(pipelineJson: PipelineJson): PipelineString;
 /**
- * TODO: !!!!! Implement new features and commands into `promptTemplateParameterJsonToString`
+ * TODO: !!!! Implement new features and commands into `promptTemplateParameterJsonToString`
  * TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
  * TODO: Escape all
  */

package/umd/typings/src/conversion/pipelineStringToJson.d.ts

@@ -2,20 +2,23 @@ import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
 import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
 import type { PipelineString } from '../types/PipelineString';
 /**
- * Options for pipelineStringToJson
+ * Options for `pipelineStringToJson`
  */
 export type PipelineStringToJsonOptions = {
     /**
-     * Tools for processing required for knowledge processing *(not for actual execution)*
+     * Tools for processing required for preparation of knowledge *(not for actual execution)*
+     *
+     * Note: If you provide `null`, the knowledge will not be prepared
      */
-    llmTools?: LlmExecutionTools;
+    readonly llmTools: LlmExecutionTools | null;
 };
 /**
- * Compile promptbook from string (markdown) format to JSON format
+ * Compile pipeline from string (markdown) format to JSON format
  *
- * Note: There are two similar functions:
+ * Note: There are 3 similar functions:
  * - `pipelineStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
  * - `pipelineStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+ * - `preparePipeline` - just one step in the compilation process
  *
  * @param pipelineString {Promptbook} in string markdown format (.ptbk.md)
  * @param options - Options and tools for the compilation
@@ -28,4 +31,5 @@ export type PipelineStringToJsonOptions = {
 export declare function pipelineStringToJson(pipelineString: PipelineString, options?: PipelineStringToJsonOptions): Promise<PipelineJson>;
 /**
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  */

package/umd/typings/src/conversion/pipelineStringToJsonSync.d.ts

@@ -1,14 +1,14 @@
 import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
 import type { PipelineString } from '../types/PipelineString';
 /**
- * Compile promptbook from string (markdown) format to JSON format synchronously
+ * Compile pipeline from string (markdown) format to JSON format synchronously
  *
- * Note: There are two similar functions:
+ * Note: There are 3 similar functions:
  * - `pipelineStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
  * - `pipelineStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+ * - `preparePipeline` - just one step in the compilation process
  *
  * @param pipelineString {Promptbook} in string markdown format (.ptbk.md)
- * @param options - Options and tools for the compilation
  * @returns {Promptbook} compiled in JSON format (.ptbk.json)
  * @throws {ParsingError} if the promptbook string is not valid
  *
@@ -22,4 +22,7 @@ export declare function pipelineStringToJsonSync(pipelineString: PipelineString)
  * TODO: Use spaceTrim more effectively
  * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
  * TODO: [🥞] Not optimal parsing because `splitMarkdownIntoSections` is executed twice with same string, once through `flattenMarkdown` and second directly here
+ * TODO: [♈] Probbably move expectations from templates to parameters
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
+ * TODO: [🍙] Make some standart order of json properties
  */

package/umd/typings/src/conversion/prettify/PrettifyOptions.d.ts

@@ -5,9 +5,9 @@ export type PrettifyOptions = {
     /***
      * If true, adds Mermaid graph to the Promptbook string
      */
-    isGraphAdded?: boolean;
+    readonly isGraphAdded?: boolean;
     /**
      * If true, the string is prettifyed as markdown
      */
-    isPrettifyed?: boolean;
+    readonly isPrettifyed?: boolean;
 };

package/{esm/typings/src/conversion/utils/extractParametersFromPromptTemplate.d.ts → umd/typings/src/conversion/utils/extractParameterNamesFromPromptTemplate.d.ts}

@@ -1,5 +1,5 @@
 import type { PromptTemplateJson } from '../../types/PipelineJson/PromptTemplateJson';
-import type { string_name } from '../../types/typeAliases';
+import type { string_parameter_name } from '../../types/typeAliases';
 /**
  * Parses the prompt template and returns the set of all used parameters
  *
@@ -7,7 +7,7 @@ import type { string_name } from '../../types/typeAliases';
  * @returns the set of parameter names
  * @throws {ParsingError} if the script is invalid
  */
-export declare function extractParametersFromPromptTemplate(promptTemplate: Pick<PromptTemplateJson, 'title' | 'description' | 'blockType' | 'content'>): Set<string_name>;
+export declare function extractParameterNamesFromPromptTemplate(promptTemplate: Pick<PromptTemplateJson, 'title' | 'description' | 'blockType' | 'content' | 'preparedContent' | 'jokerParameterNames'>): Set<string_parameter_name>;
 /**
  * TODO: [🔣] If script require contentLanguage
  */

package/umd/typings/src/conversion/utils/extractParameterNamesFromPromptTemplate.test.d.ts

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

package/umd/typings/src/conversion/utils/renameParameter.d.ts

@@ -5,15 +5,15 @@ type RenameParameterOptions = {
      * Pipeline to search and replace for parameters
      * This pipeline is returned as copy with replaced parameters
      */
-    pipeline: PipelineJson;
+    readonly pipeline: PipelineJson;
     /**
      * Original parameter name that should be replaced
      */
-    oldParameterName: string_name;
+    readonly oldParameterName: string_name;
     /**
      * New parameter name that should replace the original parameter name
      */
-    newParameterName: string_name;
+    readonly newParameterName: string_name;
 };
 /**
  * Function renameParameter will find all usable parameters for given prompt template

package/umd/typings/src/conversion/utils/stringifyPipelineJson.d.ts

@@ -0,0 +1,14 @@
+import type { string_json } from '../../types/typeAliases';
+/**
+ * Stringify the PipelineJson with proper formatting
+ *
+ * Note: [0] It can be used for more JSON types like whole collection of pipelines, single knowledge piece, etc.
+ * Note: In contrast to JSON.stringify, this function ensures that **embedding index** is on single line
+ */
+export declare function stringifyPipelineJson<TType>(pipeline: TType): string_json<TType>;
+/**
+ * TODO: [🐝] Not Working propperly @see https://promptbook.studio/samples/mixed-knowledge.ptbk.md
+ * TODO: [🧠][0] Maybe rename to `stringifyPipelineJson`, `stringifyIndexedJson`,...
+ * TODO: [🧠] Maybe more elegant solution than replacing via regex
+ * TODO: [🍙] Make some standart order of json properties
+ */

package/umd/typings/src/conversion/utils/stringifyPipelineJson.test.d.ts

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

package/umd/typings/src/conversion/validation/_importPipeline.d.ts

@@ -1,7 +1,8 @@
 import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
 import type { PipelineString } from '../../types/PipelineString';
+import type { string_json } from '../../types/typeAliases';
 /**
- * Import the text file
+ * Import the pipeline.ptbk.md or pipeline.ptbk.json file
  *
  * Note: Using here custom import to work in jest tests
  * Note: Using sync version is 💩 in the production code, but it's ok here in tests
@@ -9,5 +10,13 @@ import type { PipelineString } from '../../types/PipelineString';
  * @param path - The path to the file relative to samples/templates directory
  * @private
  */
-export declare function importPipeline(path: `${string}.ptbk.md`): PipelineString;
-export declare function importPipeline(path: `${string}.ptbk.json`): PipelineJson;
+export declare function importPipelineWithoutPreparation(path: `${string}.ptbk.md`): PipelineString;
+export declare function importPipelineWithoutPreparation(path: `${string}.ptbk.json`): PipelineJson;
+/**
+ * Import the pipeline.ptbk.json file as parsed JSON
+ */
+export declare function importPipelineJson(path: `${string}.ptbk.json`): PipelineJson;
+/**
+ * Import the pipeline.ptbk.json file as string
+ */
+export declare function importPipelineJsonAsString(path: `${string}.ptbk.json`): string_json<PipelineJson>;

package/umd/typings/src/conversion/validation/validatePipeline.d.ts

@@ -23,5 +23,14 @@ export declare function validatePipeline(pipeline: PipelineJson): PipelineJson;
  *     >  * It checks:
  *     >  * -   it has a valid structure
  *     >  * -   ...
- *     >  ex port function validatePipeline(promptbook: unknown): asserts promptbook is PipelineJson {
+ *     >  ex port function validatePipeline(promptbook: really_unknown): asserts promptbook is PipelineJson {
+ */
+/**
+ * TODO: [🐣] !!!! Validate that all samples match expectations
+ * TODO: [🐣][🐝] !!!! Validate that knowledge is valid (non-void)
+ * TODO: [🐣] !!!! Validate that persona can be used only with CHAT variant
+ * TODO: [🐣] !!!! Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
+ * TODO: [🐣] !!!! Validate that reserved parameter is not used as joker
+ * TODO: [🧠] Validation not only logic itself but imports around - files and websites and rerefenced pipelines exists
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  */

package/umd/typings/src/errors/EnvironmentMismatchError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This error type indicates that you try to use a feature that is not available in the current environment
+ */
+export declare class EnvironmentMismatchError extends Error {
+    readonly name = "EnvironmentMismatchError";
+    constructor(message: string);
+}

package/umd/typings/src/errors/LimitReachedError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This error type indicates that some limit was reached
+ */
+export declare class LimitReachedError extends Error {
+    readonly name = "LimitReachedError";
+    constructor(message: string);
+}

package/umd/typings/src/errors/VersionMismatchError.d.ts

@@ -0,0 +1,8 @@
+import type { string_semantic_version } from '../types/typeAliases';
+/**
+ * This error type indicates that the version of the pipeline is not matching the expected version
+ */
+export declare class VersionMismatchError extends Error {
+    readonly name = "UnexpectedError";
+    constructor(message: string, expectedVersion: string_semantic_version);
+}

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

@@ -5,5 +5,6 @@ export type CommonExecutionToolsOptions = {
     readonly isVerbose?: boolean;
 };
 /**
+ * TODO: [🈁] Maybe add here `isDeterministic`
  * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
  */

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

@@ -1,13 +1,13 @@
 import type { Promisable } from 'type-fest';
-import type { ModelVariant } from '../types/ModelRequirements';
+import type { ModelVariant } from '../types/ModelVariant';
 import type { Prompt } from '../types/Prompt';
 import type { string_markdown } from '../types/typeAliases';
 import type { string_markdown_text } from '../types/typeAliases';
 import type { string_model_name } from '../types/typeAliases';
 import type { string_title } from '../types/typeAliases';
-import type { PromptChatResult } from './PromptResult';
-import type { PromptCompletionResult } from './PromptResult';
-import type { PromptEmbeddingResult } from './PromptResult';
+import type { ChatPromptResult } from './PromptResult';
+import type { CompletionPromptResult } from './PromptResult';
+import type { EmbeddingPromptResult } from './PromptResult';
 /**
  * Container 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.
@@ -31,15 +31,15 @@ export type LlmExecutionTools = {
     /**
      * Calls a chat model
      */
-    callChatModel?(prompt: Prompt): Promise<PromptChatResult>;
+    callChatModel?(prompt: Prompt): Promise<ChatPromptResult>;
     /**
      * Calls a completion model
      */
-    callCompletionModel?(prompt: Prompt): Promise<PromptCompletionResult>;
+    callCompletionModel?(prompt: Prompt): Promise<CompletionPromptResult>;
     /**
      * Calls an embedding model
      */
-    callEmbeddingModel?(prompt: Prompt): Promise<PromptEmbeddingResult>;
+    callEmbeddingModel?(prompt: Prompt): Promise<EmbeddingPromptResult>;
     /**
      * List all available models that can be used
      */
@@ -63,8 +63,10 @@ export type AvailableModel = {
     readonly modelVariant: ModelVariant;
 };
 /**
- * TODO: !!!! Translation model
+ * TODO: [🏳] Add `callTranslationModel`
+ * TODO: Maybe reorder `listModels` and put it befor `callChatModel`, `callCompletionModel`, `callEmbeddingModel`
  * TODO: [🧠] Emulation of one type of model with another one - emuate chat with completion; emulate translation with chat
  * TODO: [🍓][♐] Some heuristic to pick the best model in listed models
  * TODO: [🧠] Should or should not there be a word "GPT" in both callCompletionModel and callChatModel
+ * TODO: [🧠][🪐] Should be common things like types, utils in folder containing A,B,C,.. or else outside this listing folder?
  */

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

@@ -1,42 +1,64 @@
 import type { Promisable } from 'type-fest';
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import { PipelineExecutionError } from '../errors/PipelineExecutionError';
 import type { TaskProgress } from '../types/TaskProgress';
 import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
-import type { string_name } from '../types/typeAliases';
-import type { PromptResultUsage } from './PromptResult';
+import type { Parameters } from '../types/typeAliases';
+import type { PromptResultUsage } from './PromptResultUsage';
 /**
  * Executor is a simple async function that takes INPUT  PARAMETERs and returns result parameters _(along with all intermediate parameters and INPUT  PARAMETERs = it extends input object)_.
  * Executor is made by combining execution tools and pipeline collection.
  *
  * It can be created with `createPipelineExecutor` function.
  *
+ * @@@ almost-JSON (what about errors)
+ *
  * @see https://github.com/webgptorg/promptbook#executor
  */
 export type PipelineExecutor = {
-    (inputParameters: Record<string_name, string>, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<{
-        /**
-         * Whether the execution was successful, details are aviable in `executionReport`
-         */
-        isSuccessful: boolean;
-        /**
-         * Added usage of whole execution, detailed usage is aviable in `executionReport`
-         */
-        usage: PromptResultUsage;
-        /**
-         * Errors that occured during the execution, details are aviable in `executionReport`
-         */
-        errors: Array<Error>;
-        /**
-         * The report of the execution with all details
-         */
-        executionReport: ExecutionReportJson;
-        /**
-         * Result parameters of the execution
-         *
-         * Note: If the execution was not successful, there are only some of the result parameters
-         */
-        outputParameters: Record<string_name, string>;
-    }>;
+    (inputParameters: Parameters, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<PipelineExecutorResult>;
+};
+/**
+ * @@@
+ *
+ * @@@ almost-JSON (what about errors)
+ */
+export type PipelineExecutorResult = {
+    /**
+     * Result parameters of the execution
+     *
+     * Note: If the execution was not successful, there are only some of the result parameters
+     */
+    readonly outputParameters: Parameters;
+    /**
+     * Whether the execution was successful, details are aviable in `executionReport`
+     */
+    readonly isSuccessful: boolean;
+    /**
+     * Added usage of whole execution, detailed usage is aviable in `executionReport`
+     */
+    readonly usage: PromptResultUsage;
+    /**
+     * Errors that occured during the execution, details are aviable in `executionReport`
+     */
+    readonly errors: Array<PipelineExecutionError | Error>;
+    /**
+     * Warnings that occured during the execution, details are aviable in `executionReport`
+     */
+    readonly warnings: Array<PipelineExecutionError | Error>;
+    /**
+     * The report of the execution with all details
+     */
+    readonly executionReport: ExecutionReportJson;
+    /**
+     * The prepared pipeline that was used for the execution
+     *
+     * Note: If you called `createPipelineExecutor` with fully prepared pipeline, this is the same object as this pipeline
+     *       If you passed not fully prepared pipeline, this is same pipeline but fully prepared
+     */
+    readonly preparedPipeline: PipelineJson;
 };
 /**
  * TODO: [🧠] Should this file be in /execution or /types folder?
+ * TODO: [💷] `assertsExecutionSuccessful` should be the method of `PipelineExecutor` result - BUT maybe NOT?
  */

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

@@ -1,37 +1,46 @@
-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 { string_prompt } 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
      */
     content: EmbeddingVector;
 };
-export type PromptCommonResult = {
+/**
+ * Common properties for all prompt results
+ *
+ * Note: This is fully serializable as JSON
+ */
+export type CommonPromptResult = {
     /**
      * Exact text response from the model
      */
@@ -47,68 +56,44 @@ export type PromptCommonResult = {
         /**
          * Start of the execution
          */
-        start: string_date_iso8601;
+        readonly start: string_date_iso8601;
         /**
          * First token generated
          */
-        firstToken?: string_date_iso8601;
+        readonly firstToken?: string_date_iso8601;
         /**
          * End of the execution
          */
-        complete: string_date_iso8601;
+        readonly complete: string_date_iso8601;
     };
     /**
      * Usage of the prompt execution
      */
     readonly usage: PromptResultUsage;
     /**
-     * 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
+     * Exact text of the prompt (with all replacements)
      *
-     * Note: If the cost is unknown, the value 0 and isUncertain is true
+     * Note: This contains redundant information
      */
-    price: UncertainNumber;
+    readonly rawPromptContent: string_prompt;
     /**
-     * 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
+     * Raw request to the model
+     *
+     * Note: This contains redundant information
      */
-    value: number_usd & (number_positive | 0);
+    readonly rawRequest: TODO_object | null;
     /**
-     * Is the value uncertain
+     * Raw response from the model
+     *
+     * Note: This contains redundant information
      */
-    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 `TranslationPromptResult`
  */