@promptbook/javascript 0.88.0-1

package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts

@@ -0,0 +1,59 @@
+import type { AvailableModel } from '../../execution/AvailableModel';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { ChatPromptResult } from '../../execution/PromptResult';
+import type { CompletionPromptResult } from '../../execution/PromptResult';
+import type { EmbeddingPromptResult } from '../../execution/PromptResult';
+import type { RemoteClientOptions } from '../../remote-server/types/RemoteClientOptions';
+import type { ChatPrompt } from '../../types/Prompt';
+import type { CompletionPrompt } from '../../types/Prompt';
+import type { EmbeddingPrompt } from '../../types/Prompt';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_title } from '../../types/typeAliases';
+/**
+ * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
+ *
+ * You can simply use `RemoteExecutionTools` on client-side javascript and connect to your remote server.
+ * This is useful to make all logic on browser side but not expose your API keys or no need to use customer's GPU.
+ *
+ * @see https://github.com/webgptorg/promptbook#remote-server
+ * @public exported from `@promptbook/remote-client`
+ */
+export declare class RemoteLlmExecutionTools<TCustomOptions = undefined> implements LlmExecutionTools {
+    protected readonly options: RemoteClientOptions<TCustomOptions>;
+    constructor(options: RemoteClientOptions<TCustomOptions>);
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    /**
+     * Check the configuration of all execution tools
+     */
+    checkConfiguration(): Promise<void>;
+    /**
+     * List all available models that can be used
+     */
+    listModels(): Promise<ReadonlyArray<AvailableModel>>;
+    /**
+     * Calls remote proxy server to use a chat model
+     */
+    callChatModel(prompt: ChatPrompt): Promise<ChatPromptResult>;
+    /**
+     * Calls remote proxy server to use a completion model
+     */
+    callCompletionModel(prompt: CompletionPrompt): Promise<CompletionPromptResult>;
+    /**
+     * Calls remote proxy server to use a embedding model
+     */
+    callEmbeddingModel(prompt: EmbeddingPrompt): Promise<EmbeddingPromptResult>;
+    /**
+     * Calls remote proxy server to use both completion or chat model
+     */
+    private callCommonModel;
+}
+/**
+ * TODO: Maybe use `$exportJson`
+ * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
+ * TODO: [🍓] Allow to list compatible models with each variant
+ * TODO: [🗯] RemoteLlmExecutionTools should extend Destroyable and implement IDestroyable
+ * TODO: [🧠][🌰] Allow to pass `title` for tracking purposes
+ * TODO: [🧠] Maybe remove `@promptbook/remote-client` and just use `@promptbook/core`
+ */

package/esm/typings/src/llm-providers/remote/playground/playground.d.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env ts-node
+import '../../openai/register-constructor';
+/**
+ * Note: [⚫] Code in this file should never be published in any package
+ */

package/esm/typings/src/llm-providers/vercel/VercelExecutionToolsOptions.d.ts

@@ -0,0 +1,23 @@
+import type { AvailableModel } from '../../execution/AvailableModel';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { VercelProvider } from './VercelProvider';
+/**
+ * Options for `createExecutionToolsFromVercelProvider`
+ *
+ * @public exported from `@promptbook/google`
+ */
+export type VercelExecutionToolsOptions = CommonToolsOptions & Pick<LlmExecutionTools, 'title' | 'description'> & {
+    /**
+     * Vercel provider for the execution tools
+     */
+    readonly vercelProvider: VercelProvider;
+    /**
+     * List of available models for given Vercel provider
+     */
+    readonly availableModels: ReadonlyArray<AvailableModel>;
+    /**
+     * Additional settings for chat models when calling `vercelProvider.chat('model-name', settings)`
+     */
+    readonly additionalChatSettings?: Partial<Parameters<VercelProvider['chat']>[1]>;
+};

package/esm/typings/src/llm-providers/vercel/VercelProvider.d.ts

@@ -0,0 +1,13 @@
+import type { createGoogleGenerativeAI } from '@ai-sdk/google';
+import type { createOpenAI } from '@ai-sdk/openai';
+/**
+ * This is common interface for all v1 Vercel providers
+ *
+ * @public exported from `@promptbook/vercel`
+ */
+export type VercelProvider = ReturnType<typeof createOpenAI> | ReturnType<typeof createGoogleGenerativeAI>;
+/**
+ * ^^^^
+ * TODO: Is there some way to get the type of the provider directly,
+ *       NOT this stupid way via inferring the return type from a specific vercel provider⁉
+ */

package/esm/typings/src/llm-providers/vercel/createExecutionToolsFromVercelProvider.d.ts

@@ -0,0 +1,8 @@
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { VercelExecutionToolsOptions } from './VercelExecutionToolsOptions';
+/**
+ * Adapter which creates Promptbook execution tools from Vercel provider
+ *
+ * @public exported from `@promptbook/vercel`
+ */
+export declare function createExecutionToolsFromVercelProvider(options: VercelExecutionToolsOptions): LlmExecutionTools;

package/esm/typings/src/llm-providers/vercel/playground/playground.d.ts

@@ -0,0 +1,6 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * TODO: [main] !!3 Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ * Note: [⚫] Code in this file should never be published in any package
+ */

package/esm/typings/src/other/templates/getBookTemplates.d.ts

@@ -0,0 +1,24 @@
+import { SetRequired } from 'type-fest';
+import type { string_formfactor_name } from '../../formfactors/_common/string_formfactor_name';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { NonEmptyReadonlyArray } from '../../types/NonEmptyArray';
+/**
+ * @@@
+ *
+ * @singleton
+ * @private internal cache of `getBookTemplate`
+ */
+export declare let pipelines: Array<SetRequired<PipelineJson, 'pipelineUrl'>> | null;
+/**
+ * Get template for new book
+ *
+ * @param formfactorName - optional filter for FORMFACTOR - get only pipelines for this formfactor
+ * @returns list of pipelines
+ * @public exported from `@promptbook/templates`
+ */
+export declare function getBookTemplates(formfactorName?: string_formfactor_name): NonEmptyReadonlyArray<SetRequired<PipelineJson, 'pipelineUrl'>>;
+/**
+ * TODO: Unit test + test that what we guarantee - always return non-empty array is true for e
+ * TODO: [🧠] Which is the best place for this function
+ * TODO: !!6 For GENERIC template ensure at least one pipeline is present for typescript in `getBookTemplates`
+ */

package/esm/typings/src/other/templates/getTemplatesPipelineCollection.d.ts

@@ -0,0 +1,10 @@
+import type { PipelineCollection } from '../../collection/PipelineCollection';
+/**
+ * Get pipeline collection for Untitled Promptbook project
+ *
+ * ⚠️ WARNING: This code has been generated by `@promptbook/cli` so that any manual changes will be overwritten
+ *
+ * @generated
+ * @returns {PipelineCollection} Library of promptbooks for Untitled Promptbook project
+ */
+export declare function getTemplatesPipelineCollection(): PipelineCollection;

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

@@ -0,0 +1,17 @@
+import type { ExecutionTools } from '../execution/ExecutionTools';
+import type { PersonaPreparedJson } from '../pipeline/PipelineJson/PersonaJson';
+import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
+import type { string_persona_description } from '../types/typeAliases';
+/**
+ * Prepares the persona for the pipeline
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/22
+ * @public exported from `@promptbook/core`
+ */
+export declare function preparePersona(personaDescription: string_persona_description, tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions): Promise<PersonaPreparedJson['modelRequirements']>;
+/**
+ * TODO: [🔃][main] If the persona was prepared with different version or different set of models, prepare it once again
+ * TODO: [🏢] Check validity of `modelName` in pipeline
+ * TODO: [🏢] Check validity of `systemMessage` in pipeline
+ * TODO: [🏢] Check validity of `temperature` in pipeline
+ */

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

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

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/PipelineInterface/getPipelineInterface.d.ts

@@ -0,0 +1,11 @@
+import type { PipelineJson } from '../PipelineJson/PipelineJson';
+import type { PipelineInterface } from './PipelineInterface';
+/**
+ * @@@
+ *
+ * @deprecated https://github.com/webgptorg/promptbook/pull/186
+ * @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/PipelineInterface/isPipelineImplementingInterface.d.ts

@@ -0,0 +1,26 @@
+import type { PipelineJson } from '../PipelineJson/PipelineJson';
+import type { PipelineInterface } from './PipelineInterface';
+/**
+ * @@@
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ */
+export type IsPipelineImplementingInterfaceOptions = {
+    /**
+     * @@@
+     */
+    pipeline: PipelineJson;
+    /**
+     * @@@
+     */
+    pipelineInterface: PipelineInterface;
+};
+/**
+ * @@@
+ *
+ * @deprecated https://github.com/webgptorg/promptbook/pull/186
+ * @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/PipelineInterface/isPipelineInterfacesEqual.d.ts

@@ -0,0 +1,10 @@
+import type { PipelineInterface } from './PipelineInterface';
+/**
+ * @@@
+ *
+ * @deprecated https://github.com/webgptorg/promptbook/pull/186
+ * @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/CommonTaskJson.d.ts

@@ -0,0 +1,100 @@
+import type { ForeachJson } from '../../commands/FOREACH/ForeachJson';
+import type { FormatCommand } from '../../commands/FORMAT/FormatCommand';
+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 tasks
+ */
+export type CommonTaskJson = {
+    /**
+     * 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 task in the pipeline
+     */
+    readonly name: string_name;
+    /**
+     * 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 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 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 task
+     *
+     * @see https://github.com/webgptorg/promptbook/discussions/66
+     */
+    readonly jokerParameterNames?: Array<string_parameter_name>;
+    /**
+     * @@@
+     */
+    readonly foreach?: ForeachJson;
+    /**
+     * Type of the execution
+     * This determines if the task is send to LLM, user or some scripting evaluation
+     */
+    readonly taskType: SectionType;
+    /**
+     * Content of the task with {placeholders} for parameters
+     *
+     * @@@ content vs preparedContent
+     */
+    readonly content: (string_prompt | string_javascript | string_markdown) & string_template;
+    /**
+     * @@@ Content of the task with {placeholders} for parameters
+     *
+     * @@@ content vs preparedContent
+     *
+     * @default "{content}"
+     */
+    readonly preparedContent?: (string_prompt | string_javascript | string_markdown) & string_template;
+    /**
+     * List of postprocessing steps that are executed after the task
+     *
+     * @see https://github.com/webgptorg/promptbook/discussions/31
+     */
+    readonly postprocessingFunctionNames?: Array<string_postprocessing_function_name>;
+    /**
+     * Expect this amount of each unit in the answer
+     *
+     * For example 5 words, 3 sentences, 2 paragraphs, ...
+     *
+     * Note: Expectations are performed after all postprocessing steps
+     * @see https://github.com/webgptorg/promptbook/discussions/30
+     */
+    readonly expectations?: Expectations;
+    /**
+     * Expect this format of the answer
+     *
+     * Note: Expectations are performed after all postprocessing steps
+     * @see https://github.com/webgptorg/promptbook/discussions/30
+     * @deprecated [💝]
+     */
+    readonly format?: FormatCommand['format'];
+    /**
+     * 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 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/pipeline/PipelineJson/Expectations.d.ts

@@ -0,0 +1,40 @@
+import type { TupleToUnion } from 'type-fest';
+import type { number_integer } from '../../types/typeAliases';
+import type { number_positive } from '../../types/typeAliases';
+/**
+ * Expect this amount of each unit in the answer
+ *
+ * For example 5 words, 3 sentences, 2 paragraphs, ...
+ *
+ * Note: Expectations are performed after all postprocessing steps
+ * Note: [🚉] This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook/discussions/30
+ */
+export type Expectations = Partial<Record<Lowercase<ExpectationUnit>, {
+    readonly min?: ExpectationAmount;
+    readonly max?: ExpectationAmount;
+}>>;
+/**
+ * Unit of text measurement
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook/discussions/30
+ */
+export type ExpectationUnit = TupleToUnion<typeof EXPECTATION_UNITS>;
+/**
+ * Units of text measurement
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/30
+ * @public exported from `@promptbook/core`
+ */
+export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTENCES", "LINES", "PARAGRAPHS", "PAGES"];
+/**
+ * Amount of text measurement
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook/discussions/30
+ */
+export type ExpectationAmount = number_integer & (number_positive | 0);
+/**
+ * TODO: [💝] Unite object for expecting amount and format - remove format
+ */

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

@@ -0,0 +1,73 @@
+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';
+/**
+ * Defines one piece of knowledge in the pipeline
+ *
+ * Note: Knowledge piece is by definition prepared
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ *
+ * @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: ReadonlyArray<{
+        /**
+         * 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: ReadonlyArray<string_keyword>;
+    /**
+     * List of models embeddings that are associated with the knowledge piece
+     */
+    readonly index: ReadonlyArray<{
+        /**
+         * 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: ReadonlyArray<number_id>;
+};
+/**
+ * TODO: [🍙] Make some standard order of json properties
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,44 @@
+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.
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/41
+ */
+export type KnowledgeSourceJson = {
+    /**
+     * Unique identifier of the knowledge source
+     */
+    readonly name: string_name;
+    /**
+     * Source of one knowledge
+     *
+     * It can be a link, a relative path to file or direct text or combination of those
+     *
+     * For example `"https://pavolhejny.com/"`
+     * 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"`
+     */
+    readonly knowledgeSourceContent: string_knowledge_source_content;
+};
+/**
+ * Defines one source of knowledge in the pipeline after it has been prepared
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ *
+ * @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: ReadonlyArray<number_id>;
+};
+/**
+ * TODO: [🍙] Make some standard order of json properties
+ */

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
+ */