@promptbook/openai 0.61.0-1 → 0.61.0-11

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

@@ -29,6 +29,6 @@ export declare class MockedEchoLlmExecutionTools implements LlmExecutionTools {
     listModels(): Array<AvailableModel>;
 }
 /**
- * TODO: [🕵️‍♀️] Maybe just remove
+ * TODO: !!! Use here `seed`
  * TODO: Allow in spaceTrim: nesting with > ${block(prompt.request)}, same as replace params
  */

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

@@ -34,5 +34,5 @@ export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools
     listModels(): Array<AvailableModel>;
 }
 /**
- * TODO: [🕵️‍♀️] Maybe just remove
+ * TODO: !!! Use here `seed`
  */

package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts

@@ -41,10 +41,12 @@ export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
     private callModelCommon;
     /**
      * List all available models that can be used
-     * This liost is a combination of all available models from all execution tools
+     * This lists is a combination of all available models from all execution tools
      */
     listModels(): Promise<Array<AvailableModel>>;
 }
 /**
  * TODO: [🧠][🎛] Aggregating multiple models - have result not only from one first aviable model BUT all of them
+ * TODO: [🏖] If no llmTools have for example not defined `callCompletionModel` this will still return object with defined `callCompletionModel` which just throws `PipelineExecutionError`, make it undefined instead
+ *       Look how `countTotalUsage` (and `cacheLlmTools`) implements it
  */

package/esm/typings/src/llm-providers/openai/OpenAiExecutionToolsOptions.d.ts

@@ -2,7 +2,7 @@ import type { ClientOptions } from 'openai';
 import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
 import type { string_token } from '../../types/typeAliases';
 /**
- * Options for OpenAiExecutionTools
+ * Options for `OpenAiExecutionTools`
  *
  * This extends OpenAI's `ClientOptions` with are directly passed to the OpenAI client.
  * Rest is used by the `OpenAiExecutionTools`.

package/esm/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/esm/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/esm/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/esm/typings/src/llm-providers/utils/cache/CacheItem.d.ts

@@ -0,0 +1,29 @@
+import type { PromptResult } from '../../../execution/PromptResult';
+import type { Prompt } from '../../../types/Prompt';
+import type { string_date_iso8601 } from '../../../types/typeAliases';
+import type { string_promptbook_version } from '../../../version';
+/**
+ * @@@
+ */
+export type CacheItem = {
+    /**
+     * @@@
+     */
+    date: string_date_iso8601;
+    /**
+     * @@@
+     */
+    promptbookVersion: string_promptbook_version;
+    /**
+     * @@@
+     */
+    prompt: Prompt;
+    /**
+     * @@@
+     */
+    promptResult: PromptResult;
+};
+/**
+ * TODO: [🧠] Should be this exported alongsite `cacheLlmTools` through `@promptbook/utils` OR through `@promptbook/types`
+ * TODO: [🛫] `prompt` is NOT fully serializable as JSON, it contains functions which are not serializable, fix it
+ */

package/esm/typings/src/llm-providers/utils/cache/CacheLlmToolsOptions.d.ts

@@ -0,0 +1,10 @@
+import type { PromptbookStorage } from '../../../storage/_common/PromptbookStorage';
+import type { CacheItem } from './CacheItem';
+export type CacheLlmToolsOptions = {
+    /**
+     * Total cost of the execution
+     *
+     * @default MemoryStorage
+     */
+    storage: PromptbookStorage<CacheItem>;
+};

package/esm/typings/src/llm-providers/utils/cache/cacheLlmTools.d.ts

@@ -0,0 +1,17 @@
+import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
+import type { CacheLlmToolsOptions } from './CacheLlmToolsOptions';
+/**
+ * Intercepts LLM tools and counts total usage of the tools
+ *
+ * @param llmTools LLM tools to be intercepted with usage counting
+ * @returns LLM tools with same functionality with added total cost counting
+ */
+export declare function cacheLlmTools(llmTools: LlmExecutionTools, options?: Partial<CacheLlmToolsOptions>): LlmExecutionTools;
+/**
+ * TODO: !!!!! Export this util
+ * TODO: !!!!! Use this for tests in promptbook project itself
+ * TODO: !!!! write discussion about this and storages
+ *            write how to combine multiple interceptors
+ * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
+ * TODO: [🧠] Is there some meaningfull way how to test this util
+ */

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

@@ -0,0 +1,11 @@
+import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
+import type { PromptResultUsage } from '../../../execution/PromptResult';
+/**
+ * LLM tools with option to get total cost of the execution
+ */
+export type LlmExecutionToolsWithTotalCost = LlmExecutionTools & {
+    /**
+     * Total cost of the execution
+     */
+    totalUsage: PromptResultUsage;
+};

package/esm/typings/src/llm-providers/utils/count-total-cost/countTotalCost.d.ts

@@ -0,0 +1,14 @@
+import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
+import type { LlmExecutionToolsWithTotalCost } from './LlmExecutionToolsWithTotalCost';
+/**
+ * Intercepts LLM tools and counts total usage of the tools
+ *
+ * @param llmTools LLM tools to be intercepted with usage counting
+ * @returns LLM tools with same functionality with added total cost counting
+ */
+export declare function countTotalUsage(llmTools: LlmExecutionTools): LlmExecutionToolsWithTotalCost;
+/**
+ * TODO: !!!!! Export this utils
+ * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
+ * TODO: [🧠] Is there some meaningfull way how to test this util
+ */

package/esm/typings/src/llm-providers/utils/createLlmToolsFromEnv.d.ts

@@ -0,0 +1,21 @@
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+/**
+ * @@@
+ *
+ * Note: This function is not cached, every call creates new instance of LlmExecutionTools
+ *
+ * It looks for environment variables:
+ * - `process.env.OPENAI_API_KEY`
+ * - `process.env.ANTHROPIC_CLAUDE_API_KEY`
+ *
+ * @returns @@@
+ */
+export declare function createLlmToolsFromEnv(): LlmExecutionTools;
+/**
+ * TODO: !!!!! Export this util
+ * TODO: !!!! write discussion about this - wizzard
+ * TODO: Add Azure
+ * TODO: [🧠] Which name is better `createLlmToolsFromEnv` or `createLlmToolsFromEnvironment`?
+ * TODO: [🧠] Is there some meaningfull way how to test this util
+ * TODO: [🧠] Maybe pass env as argument
+ */

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

@@ -0,0 +1,10 @@
+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
+ * @private within the package
+ */
+export declare function preparePersona(personaDescription: string_persona_description, options: PrepareOptions): Promise<PersonaPreparedJson['modelRequirements']>;

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

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

package/esm/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/esm/typings/src/prepare/preparePipeline.d.ts

@@ -0,0 +1,16 @@
+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: 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/esm/typings/src/prepare/unpreparePipeline.d.ts

@@ -0,0 +1,8 @@
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+/**
+ * Unprepare just strips the preparation data of the pipeline
+ */
+export declare function unpreparePipeline(pipeline: PipelineJson): PipelineJson;
+/**
+ * TODO: Write tests for `preparePipeline`
+ */

package/esm/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/esm/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/esm/typings/src/storage/_common/PromptbookStorage.d.ts

@@ -0,0 +1,24 @@
+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: [🧠][🛫] Constrain `TItem` to JSON-serializable objects only
+ */

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

@@ -0,0 +1,5 @@
+export {};
+/**
+ * TODO: !!!!! Check that this files is not exported into build
+ * TODO: Is this a good pattern to do type testing?
+ */

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

@@ -0,0 +1,28 @@
+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: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
+ */

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

@@ -0,0 +1,10 @@
+import type { string_folder_path } from '../../types/typeAliases';
+/**
+ * @@@
+ */
+export type FilesStorageOptions = {
+    /**
+     * @@@
+     */
+    cacheFolderPath: string_folder_path;
+};

package/esm/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/esm/typings/src/storage/files-storage/utils/nameToSubfolderPath.test.d.ts

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

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

@@ -0,0 +1,8 @@
+import type { PromptbookStorage } from '../_common/PromptbookStorage';
+/**
+ * Gets wrapper around `localStorage` object which can be used as `PromptbookStorage`
+ */
+export declare function getLocalStorage<TItem>(): PromptbookStorage<TItem>;
+/**
+ * Export through `@promptbook/browser`
+ */

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

@@ -0,0 +1,8 @@
+import type { PromptbookStorage } from '../_common/PromptbookStorage';
+/**
+ * Gets wrapper around `sessionStorage` object which can be used as `PromptbookStorage`
+ */
+export declare function getSessionStorage<TItem>(): PromptbookStorage<TItem>;
+/**
+ * Export through `@promptbook/browser`
+ */

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

@@ -0,0 +1,31 @@
+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;
+}

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

@@ -0,0 +1,23 @@
+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;
+}

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

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

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

@@ -1,4 +1,7 @@
+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
@@ -31,13 +34,31 @@ 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
+     *
+     * 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
      */
     readonly maxTokens?: number;
 };
 /**
+ * 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
  */

package/esm/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);
 /**

package/esm/typings/src/types/PipelineJson/KnowledgePieceJson.d.ts

@@ -0,0 +1,67 @@
+import type { EmbeddingVector } from '../../execution/EmbeddingVector';
+import type { string_keyword } from '../../utils/normalization/IKeywords';
+import type { number_id } from '../typeAliases';
+import type { number_linecol_number } from '../typeAliases';
+import type { string_markdown } from '../typeAliases';
+import type { string_markdown_text } from '../typeAliases';
+import type { string_model_name } from '../typeAliases';
+import type { string_name } from '../typeAliases';
+/**
+ * Defines one piece of knowledge in the pipeline
+ *
+ * Note: Knowledge piece is by definition prepared
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/41
+ */
+export type KnowledgePiecePreparedJson = {
+    /**
+     * Unique name of the knowledge piece based on the title
+     */
+    readonly name?: string_name;
+    /**
+     * Short title for the information
+     */
+    readonly title?: string_markdown_text;
+    /**
+     * The information in markdown format
+     */
+    readonly content?: string_markdown;
+    /**
+     * List of sources where the information comes from
+     */
+    readonly sources: Array<{
+        /**
+         * Identifier of the source
+         */
+        readonly name: string_name;
+        /**
+         * Line number
+         */
+        readonly line?: number_linecol_number;
+        /**
+         * Column number
+         */
+        readonly column?: number_linecol_number;
+    }>;
+    /**
+     * List of keywords that are associated with the knowledge piece
+     */
+    readonly keywords: Array<string_keyword>;
+    /**
+     * List of models embeddings that are associated with the knowledge piece
+     */
+    readonly index: Array<{
+        /**
+         * Model name which generated the embedding
+         */
+        readonly modelName: string_model_name;
+        /**
+         * Embedding vector of the knowledge piece
+         */
+        readonly position: EmbeddingVector;
+    }>;
+    /**
+     * List of preparation ids that were used to prepare this knowledge piece
+     */
+    readonly preparationIds: Array<number_id>;
+};

package/esm/typings/src/types/PipelineJson/KnowledgeSourceJson.d.ts

@@ -0,0 +1,24 @@
+import type { number_id } from '../typeAliases';
+import type { string_knowledge_source } from '../typeAliases';
+import type { string_name } from '../typeAliases';
+/**
+ * Defines one source of knowledge in the pipeline
+ * For example, a source of information, a fact, a quote, a definition, website, etc.
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/41
+ */
+export type KnowledgeSourceJson = {
+    readonly name: string_name;
+    readonly source: string_knowledge_source;
+};
+/**
+ * Defines one source of knowledge in the pipeline after it has been prepared
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/41
+ */
+export type KnowledgeSourcePreparedJson = KnowledgeSourceJson & {
+    /**
+     * List of preparation ids that were used to prepare this knowledge source to knowledge pieces
+     */
+    readonly preparationIds: Array<number_id>;
+};

package/esm/typings/src/types/PipelineJson/LlmTemplateJson.d.ts

@@ -1,10 +1,15 @@
 import type { ModelRequirements } from '../ModelRequirements';
+import type { string_name } from '../typeAliases';
 import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
 /**
  * Template for prompt to LLM
  */
 export type LlmTemplateJson = PromptTemplateJsonCommon & {
     readonly blockType: 'PROMPT_TEMPLATE';
+    /**
+     * Name of the persona who will be responding to this prompt
+     */
+    readonly personaName: string_name | null;
     /**
      * Requirements for the model
      * - This is required only for blockType PROMPT_TEMPLATE
@@ -12,5 +17,7 @@ export type LlmTemplateJson = PromptTemplateJsonCommon & {
     readonly modelRequirements: ModelRequirements;
 };
 /**
- * TODO: [👙][🧠] Just selecting gpt3 or gpt4 level of modelT
+ * TODO: [👙][🧠] Maybe add `knowledge`, `actions` and `instruments` to be available granularly for each template
+ *       @see https://github.com/webgptorg/promptbook/discussions/79
+ * TODO: [💕][🧠] Just selecting gpt3 or gpt4 level of model
  */