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

package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts

@@ -1,10 +1,10 @@
 import type { ReadonlyDeep, WritableDeep } from 'type-fest';
-import type { ExecutionReportJson } from '../../types/execution-report/ExecutionReportJson';
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
-import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { Parameters } from '../../types/typeAliases';
 import type { string_parameter_name } from '../../types/typeAliases';
 import type { TODO_string } from '../../utils/organization/TODO_string';
+import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
 import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
 /**
  * @@@
@@ -25,7 +25,7 @@ export type ExecuteAttemptsOptions = Omit<CreatePipelineExecutorOptions, 'pipeli
      *
      * Note: [💂] There are two distinct variabiles
      * 1) `maxExecutionAttempts` - the amount of attempts LLM model
-     * 2) `maxAttempts` - the amount of attempts for any template - LLM, SCRIPT, DIALOG, etc.
+     * 2) `maxAttempts` - the amount of attempts for any task - LLM, SCRIPT, DIALOG, etc.
      */
     readonly maxAttempts: number;
     /**
@@ -39,7 +39,7 @@ export type ExecuteAttemptsOptions = Omit<CreatePipelineExecutorOptions, 'pipeli
     /**
      * @@@
      */
-    readonly template: ReadonlyDeep<TemplateJson>;
+    readonly task: ReadonlyDeep<TaskJson>;
     /**
      * @@@
      */

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

@@ -1,6 +1,6 @@
 import type { ReadonlyDeep } from 'type-fest';
 import { PipelineExecutionError } from '../../errors/PipelineExecutionError';
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { Parameters } from '../../types/typeAliases';
 /**
  * @@@

package/esm/typings/src/execution/createPipelineExecutor/{getContextForTemplate.d.ts → getContextForTask.d.ts}

@@ -1,5 +1,5 @@
 import type { ReadonlyDeep } from 'type-fest';
-import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
+import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_parameter_value } from '../../types/typeAliases';
 /**
@@ -7,4 +7,4 @@ import type { string_parameter_value } from '../../types/typeAliases';
  *
  * @private internal utility of `createPipelineExecutor`
  */
-export declare function getContextForTemplate(template: ReadonlyDeep<TemplateJson>): Promise<string_parameter_value & string_markdown>;
+export declare function getContextForTask(task: ReadonlyDeep<TaskJson>): Promise<string_parameter_value & string_markdown>;

package/esm/typings/src/execution/createPipelineExecutor/{getExamplesForTemplate.d.ts → getExamplesForTask.d.ts}

@@ -1,5 +1,5 @@
 import type { ReadonlyDeep } from 'type-fest';
-import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
+import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_parameter_value } from '../../types/typeAliases';
 /**
@@ -7,4 +7,4 @@ import type { string_parameter_value } from '../../types/typeAliases';
  *
  * @private internal utility of `createPipelineExecutor`
  */
-export declare function getExamplesForTemplate(template: ReadonlyDeep<TemplateJson>): Promise<string_parameter_value & string_markdown>;
+export declare function getExamplesForTask(task: ReadonlyDeep<TaskJson>): Promise<string_parameter_value & string_markdown>;

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

@@ -0,0 +1,27 @@
+import type { ReadonlyDeep } from 'type-fest';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_parameter_value } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private internal type of `getKnowledgeFoTask`
+ */
+type GetKnowledgeForTaskOptions = {
+    /**
+     * @@@
+     */
+    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
+    /**
+     * @@@
+     */
+    readonly task: ReadonlyDeep<TaskJson>;
+};
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function getKnowledgeForTask(options: GetKnowledgeForTaskOptions): Promise<string_parameter_value & string_markdown>;
+export {};

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

@@ -0,0 +1,30 @@
+import type { ReadonlyDeep } from 'type-fest';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
+import type { ReservedParameters } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private internal type of `getReservedParametersForTask`
+ */
+type GetReservedParametersForTaskOptions = {
+    /**
+     * @@@
+     */
+    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
+    /**
+     * @@@
+     */
+    readonly task: ReadonlyDeep<TaskJson>;
+    /**
+     * @@@
+     */
+    readonly pipelineIdentification: string;
+};
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function getReservedParametersForTask(options: GetReservedParametersForTaskOptions): Promise<Readonly<ReservedParameters>>;
+export {};

package/esm/typings/src/{types → execution}/execution-report/ExecutionPromptReportJson.d.ts

@@ -1,6 +1,6 @@
 import type { ErrorJson } from '../../errors/utils/ErrorJson';
-import type { PromptResult } from '../../execution/PromptResult';
-import type { Prompt } from '../Prompt';
+import type { Prompt } from '../../types/Prompt';
+import type { PromptResult } from '../PromptResult';
 /**
  * Report of single prompt execution
  *

package/esm/typings/src/{types → execution}/execution-report/ExecutionReportJson.d.ts

@@ -1,6 +1,6 @@
-import type { string_markdown_text } from '../typeAliases';
-import type { string_pipeline_url } from '../typeAliases';
-import type { string_semantic_version } from '../typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_pipeline_url } from '../../types/typeAliases';
+import type { string_semantic_version } from '../../types/typeAliases';
 import type { ExecutionPromptReportJson } from './ExecutionPromptReportJson';
 /**
  * ExecutionReport is result of executing one promptbook
@@ -35,7 +35,7 @@ export type ExecutionReportJson = {
      */
     readonly description?: string_markdown_text;
     /**
-     * Sequence of templates in order which were executed
+     * Sequence of tasks in order which were executed
      */
     readonly promptExecutions: ReadonlyArray<ExecutionPromptReportJson>;
 };

package/esm/typings/src/{types → execution}/execution-report/ExecutionReportStringOptions.d.ts

@@ -1,4 +1,4 @@
-import type { number_percent } from '../typeAliases';
+import type { number_percent } from '../../types/typeAliases';
 /**
  * Options for `executionReportJsonToString`
  *

package/esm/typings/src/execution/utils/checkExpectations.d.ts

@@ -1,4 +1,4 @@
-import type { Expectations } from '../../types/PipelineJson/Expectations';
+import type { Expectations } from '../../pipeline/PipelineJson/Expectations';
 /**
  * Function checkExpectations will check if the expectations on given value are met
  *

package/esm/typings/src/execution/utils/usage-constants.d.ts

@@ -125,3 +125,6 @@ export declare const UNCERTAIN_USAGE: import("type-fest/source/readonly-deep").R
         };
     };
 }>;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -4,3 +4,6 @@
  * @private internal index of `...` <- TODO [🏢]
  */
 export declare const FORMAT_DEFINITIONS: readonly [import("./_common/FormatDefinition").FormatDefinition<string, string, any, any>, import("./_common/FormatDefinition").FormatDefinition<string, string, any, any>, import("./_common/FormatDefinition").FormatDefinition<string, string, any, any>, import("./_common/FormatDefinition").FormatDefinition<string, string, import("./csv/CsvSettings").CsvSettings, any>];
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */ 

package/esm/typings/src/formfactors/_common/AbstractFormfactorDefinition.d.ts

@@ -1,10 +1,13 @@
-import type { PipelineInterface } from '../../pipeline/pipeline-interface/PipelineInterface';
+import type { PipelineInterface } from '../../pipeline/PipelineInterface/PipelineInterface';
 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';
 /**
  * @@@
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook/discussions/172
  */
 export type AbstractFormfactorDefinition = {
     /**

package/esm/typings/src/formfactors/_common/FormfactorDefinition.d.ts

@@ -1,5 +1,8 @@
 import { FORMFACTOR_DEFINITIONS } from '../index';
 /**
  * @@@
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook/discussions/172
  */
 export type FormfactorDefinition = typeof FORMFACTOR_DEFINITIONS[number];

package/esm/typings/src/formfactors/{chat/ChatFormfactorDefinition.d.ts → chatbot/ChatbotFormfactorDefinition.d.ts}

@@ -3,11 +3,11 @@
  *
  * @public exported from `@promptbook/core`
  */
-export declare const ChatFormfactorDefinition: {
+export declare const ChatbotFormfactorDefinition: {
     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"];

package/esm/typings/src/formfactors/generic/GenericFormfactorDefinition.d.ts

@@ -6,7 +6,7 @@
 export declare const GenericFormfactorDefinition: {
     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 [];

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

@@ -6,7 +6,7 @@
 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 [];
@@ -15,7 +15,7 @@ export declare const FORMFACTOR_DEFINITIONS: 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"];
@@ -23,7 +23,7 @@ export declare const FORMFACTOR_DEFINITIONS: readonly [{
 }, {
     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"];
@@ -31,9 +31,20 @@ export declare const FORMFACTOR_DEFINITIONS: readonly [{
 }, {
     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 name: "EXPERIMENTAL_MATCHER";
+    readonly description: "@@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/177";
+    readonly pipelineInterface: {
+        readonly inputParameterNames: readonly [];
+        readonly outputParameterNames: 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 inputParameterNames: readonly [];
+        readonly outputParameterNames: readonly [];
+    };
+};

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

@@ -6,7 +6,7 @@
 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"];

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

@@ -6,7 +6,7 @@
 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"];

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/{pipeline-interface → PipelineInterface}/PipelineInterface.d.ts

@@ -1,6 +1,9 @@
 import type { string_parameter_name } from '../../types/typeAliases';
 /**
  * @@@
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook/discussions/171
  */
 export type PipelineInterface = {
     /**

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

@@ -1,9 +1,14 @@
 /**
  * @@@
  *
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ *
  * @public exported from `@promptbook/core`
  */
 export declare const GENERIC_PIPELINE_INTERFACE: {
     readonly inputParameterNames: readonly [];
     readonly outputParameterNames: 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/pipeline/PipelineJson/DialogTaskJson.d.ts

@@ -0,0 +1,13 @@
+import type { TaskJsonCommon } from './TaskJsonCommon';
+/**
+ * Task for prompt to user
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook/discussions/76
+ */
+export type DialogTaskJson = TaskJsonCommon & {
+    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,96 @@
+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: [🧠] 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
+ */