@promptbook/remote-server 0.75.0-1 → 0.75.0-4

package/esm/typings/src/formfactors/index.d.ts

@@ -6,34 +6,107 @@
 export declare const FORMFACTOR_DEFINITIONS: readonly [{
     readonly name: "GENERIC";
     readonly description: "@@@";
-    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/173";
     readonly pipelineInterface: {
-        readonly inputParameterNames: readonly [];
-        readonly outputParameterNames: readonly [];
+        readonly inputParameters: readonly [];
+        readonly outputParameters: readonly [];
     };
 }, {
     readonly name: "CHATBOT";
     readonly aliasNames: readonly ["CHAT"];
     readonly description: "@@@";
-    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/174";
     readonly pipelineInterface: {
-        readonly inputParameterNames: readonly ["previousTitle", "previousConversationSummary", "userMessage"];
-        readonly outputParameterNames: readonly ["title", "conversationSummary", "chatbotResponse"];
+        readonly inputParameters: readonly [{
+            readonly name: "previousTitle";
+            readonly description: "Previous title of the conversation"; /**
+             * All available formfactor definitions
+             *
+             * @public exported from `@promptbook/core`
+             */
+            readonly isInput: true;
+            readonly isOutput: false;
+        }, {
+            readonly name: "previousConversationSummary";
+            readonly description: "Previous conversation summary";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }, {
+            readonly name: "userMessage";
+            readonly description: "User message";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }];
+        readonly outputParameters: readonly [{
+            readonly name: "title";
+            readonly description: "Title of the conversation";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }, {
+            readonly name: "conversationSummary";
+            readonly description: "Summary of the conversation";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }, {
+            readonly name: "chatbotResponse";
+            readonly description: "Chatbot response";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }];
     };
 }, {
     readonly name: "TRANSLATOR";
     readonly description: "@@@";
-    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/175";
     readonly pipelineInterface: {
-        readonly inputParameterNames: readonly ["inputMessage"];
-        readonly outputParameterNames: readonly ["outputMessage"];
+        readonly inputParameters: readonly [{
+            readonly name: "inputMessage";
+            readonly description: "Input message to be translated";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }];
+        readonly outputParameters: readonly [{
+            readonly name: "outputMessage";
+            readonly description: "Translated output message";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }];
     };
 }, {
     readonly name: "SHEETS";
     readonly description: "@@@";
-    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/176";
     readonly pipelineInterface: {
-        readonly inputParameterNames: readonly ["inputSheet"];
-        readonly outputParameterNames: readonly ["outputSheet"];
+        readonly inputParameters: readonly [{
+            readonly name: "inputSheet";
+            readonly description: "Input sheet to be processed as csv";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }];
+        readonly outputParameters: readonly [{
+            readonly name: "outputSheet";
+            readonly description: "Output sheet as csv";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }];
+    };
+}, {
+    readonly name: "EXPERIMENTAL_MATCHER";
+    readonly description: "@@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/177";
+    readonly pipelineInterface: {
+        readonly inputParameters: readonly [];
+        readonly outputParameters: readonly [];
+    };
+}, {
+    readonly name: "GENERATOR";
+    readonly description: "@@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/184";
+    readonly pipelineInterface: {
+        readonly inputParameters: readonly [];
+        readonly outputParameters: readonly [];
     };
 }];
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/formfactors/matcher/MatcherFormfactorDefinition.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Matcher is form of app that @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const MatcherFormfactorDefinition: {
+    readonly name: "EXPERIMENTAL_MATCHER";
+    readonly description: "@@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/177";
+    readonly pipelineInterface: {
+        readonly inputParameters: readonly [];
+        readonly outputParameters: readonly [];
+    };
+};

package/esm/typings/src/formfactors/sheets/SheetsFormfactorDefinition.d.ts

@@ -6,9 +6,19 @@
 export declare const SheetsFormfactorDefinition: {
     readonly name: "SHEETS";
     readonly description: "@@@";
-    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/176";
     readonly pipelineInterface: {
-        readonly inputParameterNames: readonly ["inputSheet"];
-        readonly outputParameterNames: readonly ["outputSheet"];
+        readonly inputParameters: readonly [{
+            readonly name: "inputSheet";
+            readonly description: "Input sheet to be processed as csv";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }];
+        readonly outputParameters: readonly [{
+            readonly name: "outputSheet";
+            readonly description: "Output sheet as csv";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }];
     };
 };

package/esm/typings/src/formfactors/translator/TranslatorFormfactorDefinition.d.ts

@@ -6,9 +6,19 @@
 export declare const TranslatorFormfactorDefinition: {
     readonly name: "TRANSLATOR";
     readonly description: "@@@";
-    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/175";
     readonly pipelineInterface: {
-        readonly inputParameterNames: readonly ["inputMessage"];
-        readonly outputParameterNames: readonly ["outputMessage"];
+        readonly inputParameters: readonly [{
+            readonly name: "inputMessage";
+            readonly description: "Input message to be translated";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }];
+        readonly outputParameters: readonly [{
+            readonly name: "outputMessage";
+            readonly description: "Translated output message";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }];
     };
 };

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

@@ -20,4 +20,5 @@ export declare const ANTHROPIC_CLAUDE_MODELS: ReadonlyArray<AvailableModel & {
  * TODO: [🧠] Some mechanism to propagate unsureness
  * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths (	Top-level performance, intelligence, fluency, and understanding), contextWindow,...
  * TODO: [🎰] Some mechanism to auto-update available models
+ * Note: [💞] Ignore a discrepancy between file name and entity name
  */

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

@@ -8,3 +8,6 @@ import type { Registration } from '../../utils/$Register';
  * @public exported from `@promptbook/cli`
  */
 export declare const _AnthropicClaudeMetadataRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */ 

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

@@ -10,4 +10,5 @@ import type { Registration } from '../../utils/$Register';
 export declare const _AnthropicClaudeRegistration: Registration;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ * Note: [💞] Ignore a discrepancy between file name and entity name
  */

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

@@ -8,3 +8,6 @@ import type { Registration } from '../../utils/$Register';
  * @public exported from `@promptbook/cli`
  */
 export declare const _AzureOpenAiMetadataRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */ 

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

@@ -10,4 +10,5 @@ import type { Registration } from '../../utils/$Register';
 export declare const _AzureOpenAiRegistration: Registration;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ * Note: [💞] Ignore a discrepancy between file name and entity name
  */

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

@@ -1,4 +1,4 @@
-import type { Expectations } from '../../types/PipelineJson/Expectations';
+import type { Expectations } from '../../pipeline/PipelineJson/Expectations';
 import type { string_postprocessing_function_name } from '../../types/typeAliases';
 /**
  * Gets the expectations and creates a fake text that meets the expectations

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

@@ -27,4 +27,5 @@ export declare const OPENAI_MODELS: ReadonlyArray<AvailableModel & {
  * 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
+ * Note: [💞] Ignore a discrepancy between file name and entity name
  */

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

@@ -17,3 +17,6 @@ export declare const _OpenAiMetadataRegistration: Registration;
  * @public exported from `@promptbook/cli`
  */
 export declare const _OpenAiAssistantMetadataRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */ 

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

@@ -19,4 +19,5 @@ export declare const _OpenAiRegistration: Registration;
 export declare const _OpenAiAssistantRegistration: Registration;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ * Note: [💞] Ignore a discrepancy between file name and entity name
  */

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

@@ -1,6 +1,6 @@
 import type { ExecutionTools } from '../execution/ExecutionTools';
+import type { PersonaPreparedJson } from '../pipeline/PipelineJson/PersonaJson';
 import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
-import type { PersonaPreparedJson } from '../types/PipelineJson/PersonaJson';
 import type { string_persona_description } from '../types/typeAliases';
 /**
  * Prepares the persona for the pipeline

package/esm/typings/src/pipeline/PipelineInterface/PipelineInterface.d.ts

@@ -0,0 +1,26 @@
+import type { InputParameterJson } from '../PipelineJson/ParameterJson';
+import type { OutputParameterJson } from '../PipelineJson/ParameterJson';
+/**
+ * @@@
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ */
+export type PipelineInterface = {
+    /**
+     * @@@
+     *
+     * Note: Sorted alphabetically
+     */
+    readonly inputParameters: ReadonlyArray<InputParameterJson>;
+    /**
+     * @@@
+     *
+     * Note: Sorted alphabetically
+     */
+    readonly outputParameters: ReadonlyArray<OutputParameterJson>;
+};
+/**
+ * TODO: [🧠][🤓] How to pass optional parameters - for example summary in FORMFACTOR Translator
+ * TODO: [🧠] Better name than `PipelineInterface` to avoid confusion with typescript `interface`
+ */

package/esm/typings/src/pipeline/PipelineInterface/constants.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @@@
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const GENERIC_PIPELINE_INTERFACE: {
+    readonly inputParameters: readonly [];
+    readonly outputParameters: readonly [];
+};
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/pipeline/{pipeline-interface → PipelineInterface}/getPipelineInterface.d.ts

@@ -1,8 +1,10 @@
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { PipelineJson } from '../PipelineJson/PipelineJson';
 import type { PipelineInterface } from './PipelineInterface';
 /**
  * @@@
  *
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function getPipelineInterface(pipeline: PipelineJson): PipelineInterface;

package/esm/typings/src/pipeline/{pipeline-interface → PipelineInterface}/isPipelineImplementingInterface.d.ts

@@ -1,7 +1,9 @@
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { PipelineJson } from '../PipelineJson/PipelineJson';
 import type { PipelineInterface } from './PipelineInterface';
 /**
  * @@@
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/171
  */
 export type IsPipelineImplementingInterfaceOptions = {
     /**
@@ -16,6 +18,8 @@ export type IsPipelineImplementingInterfaceOptions = {
 /**
  * @@@
  *
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function isPipelineImplementingInterface(options: IsPipelineImplementingInterfaceOptions): boolean;

package/esm/typings/src/pipeline/{pipeline-interface → PipelineInterface}/isPipelineInterfacesEqual.d.ts

@@ -2,6 +2,8 @@ import type { PipelineInterface } from './PipelineInterface';
 /**
  * @@@
  *
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function isPipelineInterfacesEqual(pipelineInterface1: PipelineInterface, pipelineInterface2: PipelineInterface): boolean;

package/esm/typings/src/{types/PipelineJson/TemplateJsonCommon.d.ts → pipeline/PipelineJson/CommonTaskJson.d.ts}

@@ -1,44 +1,44 @@
 import type { ForeachJson } from '../../commands/FOREACH/ForeachJson';
 import type { FormatCommand } from '../../commands/FORMAT/FormatCommand';
-import type { TemplateType } from '../../commands/TEMPLATE/TemplateTypes';
-import type { string_javascript } 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_postprocessing_function_name } from '../typeAliases';
-import type { string_prompt } from '../typeAliases';
-import type { string_template } from '../typeAliases';
+import type { SectionType } from '../../types/SectionType';
+import type { string_javascript } from '../../types/typeAliases';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_name } from '../../types/typeAliases';
+import type { string_parameter_name } from '../../types/typeAliases';
+import type { string_postprocessing_function_name } from '../../types/typeAliases';
+import type { string_prompt } from '../../types/typeAliases';
+import type { string_template } from '../../types/typeAliases';
 import type { Expectations } from './Expectations';
 /**
- * Common properties of all templates
+ * Common properties of all tasks
  */
-export type TemplateJsonCommon = {
+export type CommonTaskJson = {
     /**
-     * Name of the template
+     * Name of the task
      * - It must be unique across the pipeline
      * - It should start uppercase and can contain letters and numbers
-     * - The pipelineUrl together with hash and name are used to identify the template in the pipeline
+     * - The pipelineUrl together with hash and name are used to identify the task in the pipeline
      */
     readonly name: string_name;
     /**
-     * Title of the template
+     * Title of the task
      * It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
      */
     readonly title: string;
     /**
-     * Description of the template
+     * Description of the task
      * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
      */
     readonly description?: string_markdown_text;
     /**
-     * List of parameter names that are used in the template and must be defined before the template is executed
+     * List of parameter names that are used in the task and must be defined before the task is executed
      *
      * Note: Joker is one of the dependent parameters
      */
     readonly dependentParameterNames: Array<string_parameter_name>;
     /**
-     * If theese parameters meet the expectations requirements, they are used instead of executing this template
+     * If theese parameters meet the expectations requirements, they are used instead of executing this task
      *
      * @see https://github.com/webgptorg/promptbook/discussions/66
      */
@@ -49,17 +49,17 @@ export type TemplateJsonCommon = {
     readonly foreach?: ForeachJson;
     /**
      * Type of the execution
-     * This determines if the template is send to LLM, user or some scripting evaluation
+     * This determines if the task is send to LLM, user or some scripting evaluation
      */
-    readonly templateType: TemplateType;
+    readonly taskType: SectionType;
     /**
-     * Content of the template with {placeholders} for parameters
+     * Content of the task with {placeholders} for parameters
      *
      * @@@ content vs preparedContent
      */
     readonly content: (string_prompt | string_javascript | string_markdown) & string_template;
     /**
-     * @@@ Content of the template with {placeholders} for parameters
+     * @@@ Content of the task with {placeholders} for parameters
      *
      * @@@ content vs preparedContent
      *
@@ -67,7 +67,7 @@ export type TemplateJsonCommon = {
      */
     readonly preparedContent?: (string_prompt | string_javascript | string_markdown) & string_template;
     /**
-     * List of postprocessing steps that are executed after the template
+     * List of postprocessing steps that are executed after the task
      *
      * @see https://github.com/webgptorg/promptbook/discussions/31
      */
@@ -90,11 +90,11 @@ export type TemplateJsonCommon = {
      */
     readonly format?: FormatCommand['format'];
     /**
-     * Name of the parameter that is the result of the template
+     * Name of the parameter that is the result of the task
      */
     readonly resultingParameterName: string_name;
 };
 /**
  * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
- * TODO: [♈] Probbably move expectations from templates to parameters
+ * TODO: [♈] Probbably move expectations from tasks to parameters
  */

package/esm/typings/src/pipeline/PipelineJson/DialogTaskJson.d.ts

@@ -0,0 +1,13 @@
+import type { CommonTaskJson } from './CommonTaskJson';
+/**
+ * Task for prompt to user
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook/discussions/76
+ */
+export type DialogTaskJson = CommonTaskJson & {
+    readonly taskType: 'DIALOG_TASK';
+};
+/**
+ * TODO: [🍙] Make some standard order of json properties
+ */

package/esm/typings/src/{types → pipeline}/PipelineJson/Expectations.d.ts

@@ -1,6 +1,6 @@
 import type { TupleToUnion } from 'type-fest';
-import type { number_integer } from '../typeAliases';
-import type { number_positive } from '../typeAliases';
+import type { number_integer } from '../../types/typeAliases';
+import type { number_positive } from '../../types/typeAliases';
 /**
  * Expect this amount of each unit in the answer
  *

package/esm/typings/src/{types → pipeline}/PipelineJson/KnowledgePieceJson.d.ts

@@ -1,11 +1,11 @@
 import type { EmbeddingVector } from '../../execution/EmbeddingVector';
+import type { number_id } from '../../types/typeAliases';
+import type { number_linecol_number } from '../../types/typeAliases';
+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_name } from '../../types/typeAliases';
 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
  *
@@ -69,4 +69,5 @@ export type KnowledgePiecePreparedJson = {
 };
 /**
  * TODO: [🍙] Make some standard order of json properties
+ * Note: [💞] Ignore a discrepancy between file name and entity name
  */

package/esm/typings/src/{types → pipeline}/PipelineJson/KnowledgeSourceJson.d.ts

@@ -1,6 +1,6 @@
-import type { number_id } from '../typeAliases';
-import type { string_knowledge_source_content } from '../typeAliases';
-import type { string_name } from '../typeAliases';
+import type { number_id } from '../../types/typeAliases';
+import type { string_knowledge_source_content } from '../../types/typeAliases';
+import type { string_name } from '../../types/typeAliases';
 /**
  * Defines one source of knowledge in the pipeline
  * For example, a source of information, a fact, a quote, a definition, website, etc.

package/esm/typings/src/pipeline/PipelineJson/ParameterJson.d.ts

@@ -0,0 +1,98 @@
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_parameter_name } from '../../types/typeAliases';
+import type { string_parameter_value } from '../../types/typeAliases';
+/**
+ * Describes one parameter of the pipeline
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type ParameterJson = InputParameterJson | IntermediateParameterJson | OutputParameterJson;
+/**
+ * Describes input parameter of the pipeline
+ *
+ * 🔴 -> ⚪ -> ⚪
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type InputParameterJson = CommonParameterJson & {
+    /**
+     * The parameter is input of the pipeline
+     */
+    readonly isInput: true;
+    /**
+     * The parameter is NOT output of the pipeline
+     */
+    readonly isOutput: false;
+};
+/**
+ * Describes intermediate parameter of the pipeline
+ *
+ * ⚪ -> 🔴 -> ⚪
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type IntermediateParameterJson = CommonParameterJson & {
+    /**
+     * The parameter is NOT input of the pipeline
+     */
+    readonly isInput: false;
+    /**
+     * The parameter is NOT output of the pipeline
+     */
+    readonly isOutput: false;
+};
+/**
+ * Describes output parameter of the pipeline
+ *
+ * ⚪ -> ⚪ -> 🔴
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type OutputParameterJson = CommonParameterJson & {
+    /**
+     * The parameter is NOT input of the pipeline
+     */
+    readonly isInput: false;
+    /**
+     * The parameter is output of the pipeline
+     */
+    readonly isOutput: true;
+};
+/**
+ * Describes commons of one parameter of the pipeline
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type CommonParameterJson = {
+    /**
+     * Name of the parameter
+     * - It must be unique across the pipeline
+     * - It should start lowercase and contain letters and numbers
+     */
+    readonly name: string_parameter_name;
+    /**
+     * The parameter is input of the pipeline
+     */
+    readonly isInput: boolean;
+    /**
+     * The parameter is output of the pipeline
+     */
+    readonly isOutput: boolean;
+    /**
+     * Description of the parameter
+     * - It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
+     */
+    readonly description?: string_markdown_text;
+    /**
+     * Example values of the parameter
+     * Note: This values won't be actually used as some default values, but they are just for better understanding of the parameter
+     */
+    readonly exampleValues?: Array<string_parameter_value>;
+};
+/**
+ * TODO: [🧠][🛴][♈] Maybe add type + expectations into the intefrace, like "a person name"
+ *       [🛴] @see https://github.com/webgptorg/promptbook/discussions/53
+ * TODO: [🧠] Should be here registered subparameters from foreach or not?
+ * TODO: [♈] Probbably move expectations from tasks to parameters
+ * TODO: [🍙] Make some standard order of json properties
+ */

package/esm/typings/src/{types → pipeline}/PipelineJson/PersonaJson.d.ts

@@ -1,7 +1,7 @@
-import type { ChatModelRequirements } from '../ModelRequirements';
-import type { number_id } from '../typeAliases';
-import type { string_name } from '../typeAliases';
-import type { string_persona_description } from '../typeAliases';
+import type { ChatModelRequirements } from '../../types/ModelRequirements';
+import type { number_id } from '../../types/typeAliases';
+import type { string_name } from '../../types/typeAliases';
+import type { string_persona_description } from '../../types/typeAliases';
 /**
  * Defines a persona in the pipeline
  *
@@ -11,7 +11,7 @@ import type { string_persona_description } from '../typeAliases';
  */
 export type PersonaJson = {
     /**
-     * Name of the template
+     * Name of the persona
      * - It must be unique across the pipeline
      * - It should start uppercase and can contain letters and numbers
      */