@promptbook/openai 0.61.0-14 → 0.61.0-16

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

@@ -1,7 +1,9 @@
 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 {
@@ -12,13 +14,16 @@ export type CommandParser<TCommand extends {
     readonly deprecatedNames?: Array<string_name & string_SCREAMING_CASE>;
     readonly usagePlaces: Array<CommandUsagePlace>;
     readonly description: string_markdown_text;
-    readonly discussionUrl: `https://github.com/webgptorg/promptbook/discussions/${number | '@@'}`;
+    readonly documentationUrl: string_promptbook_documentation_url;
     readonly examples: Array<string_markdown_text>;
     /**
      * @throws {ParsingError} if the parsing fails
      */
     parse(input: CommandParserInput): TCommand;
-    applyToPipelineJson?(pipelineJson: WritableDeep<PipelineJson>, personaCommand: TCommand): void;
+    /**
+     * @@@ Mutated by the command
+     */
+    applyToPipelineJson?(command: TCommand, subjects: ApplyToPipelineJsonSubjects): void;
 };
 export type CommandParserInput = {
     readonly usagePlace: CommandUsagePlace;
@@ -27,10 +32,30 @@ export type CommandParserInput = {
     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 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/esm/typings/src/config.d.ts

@@ -10,10 +10,28 @@ 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`
  */
@@ -21,8 +39,15 @@ export declare const PIPELINE_COLLECTION_BASE_FILENAME = "index";
 /**
  * The names of the parameters that are reserved for special purposes
  */
-export declare const RESERVED_PARAMETER_NAMES: readonly string[];
+export declare const RESERVED_PARAMETER_NAMES: readonly ["context", "currentDate"];
+/**
+ * @@@
+ */
+export declare const DEBUG_ALLOW_PAYED_TESTING: boolean;
 /**
  * Nonce which is used for replacing things in strings
  */
 export declare const REPLACING_NONCE = "u$k42k%!V2zo34w7Fu#@QUHYPW";
+/**
+ * TODO: [🔼] Export all to core
+ */

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

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

package/esm/typings/src/conversion/utils/extractParametersFromPromptTemplate.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 extractParametersFromPromptTemplate(promptTemplate: Pick<PromptTemplateJson, 'title' | 'description' | 'blockType' | 'content' | 'jokerParameterNames'>): Set<string_parameter_name>;
 /**
  * TODO: [🔣] If script require contentLanguage
  */

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

@@ -7,7 +7,7 @@ import type { string_json } from '../../types/typeAliases';
  */
 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: [🔼] Export alongside pipelineStringToJson
  * TODO: [🧠] Maybe more elegant solution than replacing via regex
  */

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

@@ -28,6 +28,9 @@ export declare function validatePipeline(pipeline: PipelineJson): 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: [🧠] !!! Validationg not only logic itself but imports around - files and websites and rerefenced pipelines exists
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  */

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

@@ -1,8 +1,8 @@
 import type { Promisable } from 'type-fest';
+import { PipelineExecutionError } from '../errors/PipelineExecutionError';
 import type { TaskProgress } from '../types/TaskProgress';
 import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
-import type { string_parameter_name } from '../types/typeAliases';
-import type { string_parameter_value } from '../types/typeAliases';
+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)_.
@@ -13,7 +13,7 @@ import type { PromptResultUsage } from './PromptResultUsage';
  * @see https://github.com/webgptorg/promptbook#executor
  */
 export type PipelineExecutor = {
-    (inputParameters: Record<string_parameter_name, string_parameter_value>, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<{
+    (inputParameters: Parameters, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<{
         /**
          * Whether the execution was successful, details are aviable in `executionReport`
          */
@@ -25,7 +25,7 @@ export type PipelineExecutor = {
         /**
          * Errors that occured during the execution, details are aviable in `executionReport`
          */
-        readonly errors: Array<Error>;
+        readonly errors: Array<PipelineExecutionError | Error>;
         /**
          * The report of the execution with all details
          */
@@ -35,7 +35,7 @@ export type PipelineExecutor = {
          *
          * Note: If the execution was not successful, there are only some of the result parameters
          */
-        readonly outputParameters: Record<string_parameter_name, string_parameter_value>;
+        readonly outputParameters: Parameters;
     }>;
 };
 /**

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

@@ -10,15 +10,15 @@ export type PromptResultUsage = {
      *
      * Note: If the cost is unknown, the value 0 and isUncertain is true
      */
-    price: UncertainNumber;
+    readonly price: UncertainNumber;
     /**
      * Number of whatever used in the input aka. `prompt_tokens`
      */
-    input: PromptResultUsageCounts;
+    readonly input: PromptResultUsageCounts;
     /**
      * Number of tokens used in the output aka. `completion_tokens`
      */
-    output: PromptResultUsageCounts;
+    readonly output: PromptResultUsageCounts;
 };
 /**
  * Record of all possible measurable units

package/esm/typings/src/execution/ScriptExecutionTools.d.ts

@@ -1,6 +1,5 @@
 import type { ScriptLanguage } from '../types/ScriptLanguage';
-import type { string_parameter_name } from '../types/typeAliases';
-import type { string_parameter_value } from '../types/typeAliases';
+import type { Parameters } from '../types/typeAliases';
 import type { string_script } from '../types/typeAliases';
 /**
  * Represents all the tools needed to EXECUTE SCRIPTs
@@ -23,7 +22,7 @@ export type ScriptExecutionToolsExecuteOptions = {
      * Theese parameters are passed to the script as variables
      * For example: { "name": "John" } => const name = "John";
      */
-    readonly parameters: Record<string_parameter_name, string_parameter_value>;
+    readonly parameters: Parameters;
     /**
      * The content of the script to execute
      * - It can be a single statement

package/esm/typings/src/execution/createPipelineExecutor.d.ts

@@ -5,9 +5,21 @@ type CreatePipelineExecutorSettings = {
     /**
      * When executor does not satisfy expectations it will be retried this amount of times
      *
-     * @default 3
+     * @default MAX_EXECUTION_ATTEMPTS
      */
-    readonly maxExecutionAttempts: number;
+    readonly maxExecutionAttempts?: number;
+    /**
+     * 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;
 };
 /**
  * Options for `createPipelineExecutor`
@@ -35,7 +47,8 @@ interface CreatePipelineExecutorOptions {
 export declare function createPipelineExecutor(options: CreatePipelineExecutorOptions): PipelineExecutor;
 export {};
 /**
- * TODO: [🪂] Pass maxParallelCount here
+ * TODO: Use isVerbose here (not only pass to `preparePipeline`)
+ * TODO: [🪂] Use maxParallelCount here (not only pass to `preparePipeline`)
  * TODO: [♈] Probbably move expectations from templates to parameters
  * TODO: [🧠] When not meet expectations in PROMPT_DIALOG, make some way to tell the user
  * TODO: [👧] Strongly type the executors to avoid need of remove nullables whtn noUncheckedIndexedAccess in tsconfig.json

package/esm/typings/src/formats/_common/FormatDefinition.d.ts

@@ -65,5 +65,5 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
  * TODO: [🍓][👨‍⚖️] Compute TPartialValue dynamically - PartialString<TValue>
  * TODO: [🍓][🧠] Should execution tools be aviable to heal, canBeValid and isValid?
  * TODO: [🍓][🧠] llm Provider Bindings
- * TODO: [🍓]Export via some package
+ * TODO: [🍓][🔼] Export via some package
  */ 

package/esm/typings/src/knowledge/prepare-knowledge/_common/Scraper.d.ts

@@ -0,0 +1,27 @@
+import type { Promisable } from 'type-fest';
+import type { string_file_path } from '../../../types/typeAliases';
+import type { string_knowledge_source_link } from '../../../types/typeAliases';
+import type { string_markdown } from '../../../types/typeAliases';
+import type { string_markdown_text } from '../../../types/typeAliases';
+import type { string_mime_type } from '../../../types/typeAliases';
+import type { string_mime_type_with_wildcard } from '../../../types/typeAliases';
+import type { string_promptbook_documentation_url } from '../../../types/typeAliases';
+import type { really_unknown } from '../../../utils/organization/really_unknown';
+export type Scraper = {
+    readonly description: string_markdown_text;
+    readonly documentationUrl: string_promptbook_documentation_url;
+    readonly examples: Array<string_file_path>;
+    readonly mimeTypes: Array<string_mime_type_with_wildcard>;
+    scrape(source: ScraperSourceOptions): Promisable<string_markdown>;
+};
+export type ScraperSourceOptions = {
+    readonly source: string_knowledge_source_link;
+    readonly mimeType: string_mime_type;
+    asJson(): Promise<really_unknown>;
+    asText(): Promise<really_unknown>;
+    asBlob(): Promise<really_unknown>;
+};
+/**
+ * TODO: [🐝] @@@ Annotate all
+ * TODO: [🔼] Export via types
+ */

package/esm/typings/src/knowledge/prepare-knowledge/_common/prepareKnowledgePieces.d.ts

@@ -8,7 +8,7 @@ import type { KnowledgeSourceJson } from '../../../types/PipelineJson/KnowledgeS
  */
 export declare function prepareKnowledgePieces(knowledgeSources: Array<KnowledgeSourceJson>, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'preparationIds'>>>;
 /**
- * TODO: [🔼] !!! Export via `@promptbook/core`
+ * TODO: [🐝][🔼] !!! Export via `@promptbook/core`
  * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
  *       Put `knowledgePieces` into `PrepareKnowledgeOptions`
  * TODO: [🪂] More than max things can run in parallel by acident [1,[2a,2b,_],[3a,3b,_]]

package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts

@@ -6,7 +6,7 @@ import type { string_markdown } from '../../../types/typeAliases';
  */
 export declare function prepareKnowledgeFromMarkdown(content: string_markdown, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
 /**
- * TODO: [🔼] !!! Export via `@promptbook/markdown`
+ * TODO: [🐝][🔼] !!! Export via `@promptbook/markdown`
  * TODO: [🪂] Do it in parallel 11:11
  * Note: No need to aggregate usage here, it is done by intercepting the llmTools
  */

package/esm/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts

@@ -6,7 +6,7 @@ import type { string_base64 } from '../../../types/typeAliases';
  */
 export declare function prepareKnowledgeFromPdf(content: string_base64, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
 /**
- * TODO: [🔼] !!! Export via `@promptbook/pdf`
+ * TODO: [🐝][🔼] !!! Export via `@promptbook/pdf`
  * TODO: [🧺] In future, content can be alse File or Blob BUT for now for wider compatibility its only base64
  *       @see https://stackoverflow.com/questions/14653349/node-js-cant-create-blobs
  * TODO: [🪂] Do it in parallel

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

@@ -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<ChatPromptResult>;
+    callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<ChatPromptResult>;
     /**
      * Get the model that should be used as default
      */

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

@@ -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<ChatPromptResult>;
+    callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<ChatPromptResult>;
     /**
      * Calls Azure OpenAI API to use a complete model.
      */
-    callCompletionModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<CompletionPromptResult>;
+    callCompletionModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<CompletionPromptResult>;
     /**
      * Changes Azure error (which is not propper Error but object) to propper Error
      */

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

@@ -18,11 +18,11 @@ export declare class MockedEchoLlmExecutionTools implements LlmExecutionTools {
     /**
      * Mocks chat model
      */
-    callChatModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<ChatPromptResult>;
+    callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<ChatPromptResult>;
     /**
      * Mocks completion model
      */
-    callCompletionModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<CompletionPromptResult>;
+    callCompletionModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<CompletionPromptResult>;
     /**
      * List all available mocked-models that can be used
      */

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

@@ -19,15 +19,15 @@ export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools
     /**
      * Fakes chat model
      */
-    callChatModel(prompt: Pick<Prompt, 'content' | 'modelRequirements' | 'expectations' | 'postprocessing'>): Promise<ChatPromptResult & CompletionPromptResult>;
+    callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'expectations' | 'postprocessing'>): Promise<ChatPromptResult & CompletionPromptResult>;
     /**
      * Fakes completion model
      */
-    callCompletionModel(prompt: Pick<Prompt, 'content' | 'modelRequirements' | 'expectations' | 'postprocessing'>): Promise<CompletionPromptResult>;
+    callCompletionModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'expectations' | 'postprocessing'>): Promise<CompletionPromptResult>;
     /**
      * Fakes embedding model
      */
-    callEmbeddingModel(prompt: Pick<Prompt, 'content' | 'modelRequirements' | 'expectations' | 'postprocessing'>): Promise<EmbeddingPromptResult>;
+    callEmbeddingModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'expectations' | 'postprocessing'>): Promise<EmbeddingPromptResult>;
     /**
      * List all available fake-models that can be used
      */

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

@@ -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<ChatPromptResult>;
+    callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'expectFormat'>): Promise<ChatPromptResult>;
     /**
      * Calls OpenAI API to use a complete model.
      */
-    callCompletionModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<CompletionPromptResult>;
+    callCompletionModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<CompletionPromptResult>;
     /**
      * Calls OpenAI API to use a embedding model
      */
-    callEmbeddingModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<EmbeddingPromptResult>;
+    callEmbeddingModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<EmbeddingPromptResult>;
     /**
      * Get the model that should be used as default
      */

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

@@ -0,0 +1,9 @@
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+/**
+ * Determine if the pipeline is fully prepared
+ */
+export declare function isPipelinePrepared(pipeline: PipelineJson): boolean;
+/**
+ * TODO: [🔼] Export via core or utils
+ * TODO: [🧊] Pipeline can be partially prepared, this should return true ONLY if fully prepared
+ */

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

@@ -8,6 +8,7 @@ import type { PrepareOptions } from './PrepareOptions';
  */
 export declare function preparePipeline(pipeline: PipelineJson, options: PrepareOptions): Promise<PipelineJson>;
 /**
+ * TODO: !!!!! 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

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

@@ -9,7 +9,7 @@ export type LlmTemplateJson = PromptTemplateJsonCommon & {
     /**
      * Name of the persona who will be responding to this prompt
      */
-    readonly personaName: string_name | null;
+    readonly personaName?: string_name;
     /**
      * Requirements for the model
      * - This is required only for blockType PROMPT_TEMPLATE
@@ -17,6 +17,7 @@ export type LlmTemplateJson = PromptTemplateJsonCommon & {
     readonly modelRequirements: ModelRequirements;
 };
 /**
+ * TODO: [🧠][🥜]
  * 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

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

@@ -79,6 +79,7 @@ export type PipelineJson = {
     readonly preparations: Array<PreparationJson>;
 };
 /**
+ * TODO: [🧠] Maybe wrap all {parameterNames} in brackets for example { "resultingParameterName": "{foo}" }
  * Note: There was a proposal for multiple types of promptbook objects 78816ff33e2705ee1a187aa2eb8affd976d4ea1a
  *       But then immediately reverted back to the single type
  *       With knowledge as part of the promptbook and collection just as a collection of promptbooks

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

@@ -7,3 +7,6 @@ import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
 export interface PromptDialogJson extends PromptTemplateJsonCommon {
     readonly blockType: 'PROMPT_DIALOG';
 }
+/**
+ * TODO: [🧠][🥜]
+ */ 

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

@@ -7,3 +7,7 @@ import type { SimpleTemplateJson } from './SimpleTemplateJson';
  * Describes one prompt template in the promptbook
  */
 export type PromptTemplateJson = LlmTemplateJson | SimpleTemplateJson | ScriptJson | PromptDialogJson | ___ | ___ | ___ | ___;
+/**
+ * TODO: [🧠][🥜] What is propper name for this - "Template", "Prompt template",...
+ * TODO: [🧠][🥜] Reduce confusion of `PromptTemplateJson` vs (`LlmTemplateJson` which is 'PROMPT_TEMPLATE')
+ */

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

@@ -5,6 +5,7 @@ import type { string_javascript_name } from '../typeAliases';
 import type { string_markdown } from '../typeAliases';
 import type { string_markdown_text } from '../typeAliases';
 import type { string_name } from '../typeAliases';
+import type { string_parameter_name } from '../typeAliases';
 import type { string_prompt } from '../typeAliases';
 import type { string_template } from '../typeAliases';
 import type { Expectations } from './Expectations';
@@ -34,13 +35,13 @@ export interface PromptTemplateJsonCommon {
      *
      * Note: Joker is one of the dependent parameters
      */
-    readonly dependentParameterNames: Array<string_name>;
+    readonly dependentParameterNames: Array<string_parameter_name>;
     /**
      * If theese parameters meet the expectations requirements, they are used instead of executing this prompt template
      *
      * @see https://github.com/webgptorg/promptbook/discussions/66
      */
-    readonly jokers?: Array<string>;
+    readonly jokerParameterNames?: Array<string_parameter_name>;
     /**
      * Type of the execution
      * This determines if the prompt template is send to LLM, user or some scripting evaluation
@@ -55,7 +56,7 @@ export interface PromptTemplateJsonCommon {
      *
      * @see https://github.com/webgptorg/promptbook/discussions/31
      */
-    readonly postprocessing?: Array<string_javascript_name>;
+    readonly postprocessingFunctionNames?: Array<string_javascript_name>;
     /**
      * Expect this amount of each unit in the answer
      *
@@ -79,6 +80,7 @@ export interface PromptTemplateJsonCommon {
     readonly resultingParameterName: string_name;
 }
 /**
+ * TODO: [🧠][🥜]
  * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
  * TODO: [♈] Probbably move expectations from templates to parameters
  */

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

@@ -5,10 +5,10 @@ import type { CompletionModelRequirements } from './ModelRequirements';
 import type { EmbeddingModelRequirements } from './ModelRequirements';
 import type { ModelRequirements } from './ModelRequirements';
 import type { Expectations } from './PipelineJson/Expectations';
-import type { string_parameter_name } from './typeAliases';
-import type { string_parameter_value } from './typeAliases';
+import type { Parameters } from './typeAliases';
 import type { string_pipeline_url_with_hashtemplate } from './typeAliases';
 import type { string_prompt } from './typeAliases';
+import type { string_template } from './typeAliases';
 import type { string_title } from './typeAliases';
 /**
  * Prompt in a text along with model requirements, but without any execution or templating logic.
@@ -63,12 +63,11 @@ export type CommonPrompt = {
      */
     readonly title: string_title;
     /**
-     * The text of the prompt
+     * The text of the prompt with placeholders for parameters
      *
-     * Note: This is not a template, this is exactly the text that will be sent to the model
-     * @example "What is the capital of France?"
+     * @example "What is the capital of {country}?"
      */
-    readonly content: string_prompt;
+    readonly content: string_prompt & string_template;
     /**
      * Requirements for the model
      */
@@ -98,11 +97,9 @@ export type CommonPrompt = {
      */
     readonly pipelineUrl?: string_pipeline_url_with_hashtemplate;
     /**
-     * Parameters used in the prompt
-     *
-     * Note: This is redundant (same information is in pipelineUrl+content) but useful for logging and debugging
+     * Parameters used in the `content`
      */
-    readonly parameters: Record<string_parameter_name, string_parameter_value>;
+    readonly parameters: Parameters;
 };
 /**
  * TODO: [🔼] !!!! Export all from `@promptbook/types`

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

@@ -1,3 +1,4 @@
+import { RESERVED_PARAMETER_NAMES } from '../config';
 /**
  * Semantic helper
  */
@@ -17,7 +18,7 @@ export type string_prompt = string;
 /**
  * Semantic helper
  *
- * For example `"A cat wearing a {ITEM}"`
+ * For example `"A cat wearing a {item}"`
  */
 export type string_template = string;
 /**
@@ -85,14 +86,36 @@ export type string_name = string;
  *
  * For example `"eventName"`
  */
-export type string_parameter_name = string;
+export type string_parameter_name = string_name;
 /**
  * Semantic helper
- * Unique identifier of anything
+ * Unique identifier of parameter
  *
  * For example `"DevConf 2024"`
  */
 export type string_parameter_value = string;
+/**
+ * Parameters of the pipeline
+ *
+ * There are three types of parameters:
+ * - **INPUT PARAMETERs** are required to execute the pipeline.
+ * - **Intermediate parameters** are used internally in the pipeline.
+ * - **OUTPUT PARAMETERs** are not used internally in the pipeline, but are returned as the result of the pipeline execution.
+ *
+ * @see https://ptbk.io/parameters
+ */
+export type Parameters = Exclude<Record<string_parameter_name, string_parameter_value>, ReservedParameters>;
+/**
+ * Semantic helper
+ * Unique identifier of reserved parameter
+ *
+ * For example `"context"`
+ */
+export type string_reserved_parameter_name = typeof RESERVED_PARAMETER_NAMES[number];
+/**
+ * @@@
+ */
+export type ReservedParameters = Record<string_reserved_parameter_name, string_parameter_value>;
 /**
  * Semantic helper
  * Title of anything
@@ -115,8 +138,21 @@ export type string_persona_description = string;
  * For example `"./pavol-hejny-cv.pdf"`
  * For example `"Pavol Hejný has web https://pavolhejny.com/"`
  * For example `"Pavol Hejný is web developer and creator of Promptbook and Collboard"`
+ *
+ * @@@ string_knowledge_source vs string_knowledge_source_link
+ */
+export type string_knowledge_source = string_knowledge_source_link | string_markdown;
+/**
+ * One link to knowledge source
+ *
+ * It can be a link or relative path
+ *
+ * For example `"https://pavolhejny.com/"`
+ * For example `"./pavol-hejny-cv.pdf"`
+ *
+ * @@@ string_knowledge_source vs string_knowledge_source_link
  */
-export type string_knowledge_source = string_url | string_file_path | string;
+export type string_knowledge_source_link = string_url | string_file_path;
 /**
  * Semantic helper
  *
@@ -160,6 +196,10 @@ export type string_markdown_section_content = string;
  * For example `"**Hello** World!"`
  */
 export type string_markdown_text = string;
+/**
+ * @@@
+ */
+export type string_promptbook_documentation_url = `https://github.com/webgptorg/promptbook/discussions/${number | '@@'}`;
 /**
  * Semantic helper
  *