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

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

@@ -16,8 +16,8 @@ type RenameParameterOptions = {
     readonly newParameterName: string_name;
 };
 /**
- * Function `renameParameter` will find all usable parameters for given template
- * In other words, it will find all parameters that are not used in the template itseld and all its dependencies
+ * Function `renameParameter` will find all usable parameters for given task
+ * In other words, it will find all parameters that are not used in the task itseld and all its dependencies
  *
  * @throws {PipelineLogicError} If the new parameter name is already used in the pipeline
  * @public exported from `@promptbook/utils`

package/esm/typings/src/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts

@@ -13,7 +13,7 @@ export declare class SimplePromptInterfaceTools implements UserInterfaceTools {
     protected readonly options: CommonToolsOptions;
     constructor(options?: CommonToolsOptions);
     /**
-     * Trigger window.DIALOG TEMPLATE
+     * Trigger window.prompt dialog
      */
     promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
 }

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

@@ -2,7 +2,7 @@ import type { ScriptLanguage } from '../types/ScriptLanguage';
 import type { Parameters } from '../types/typeAliases';
 import type { string_script } from '../types/typeAliases';
 /**
- * Represents all the tools needed to execute SCRIPT TEMPLATE
+ * Represents all the tools needed to execute `SCRIPT` tasks
  *
  * @see https://github.com/webgptorg/promptbook#script-execution-tools
  */

package/esm/typings/src/formfactors/_boilerplate/BoilerplateFormfactorDefinition.d.ts

@@ -8,7 +8,7 @@ export declare const BoilerplateFormfactorDefinition: {
     readonly description: "@@@";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
     readonly pipelineInterface: {
-        readonly inputParameterNames: readonly [];
-        readonly outputParameterNames: readonly [];
+        readonly inputParameters: readonly [];
+        readonly outputParameters: readonly [];
     };
 };

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

@@ -35,3 +35,6 @@ export type AbstractFormfactorDefinition = {
      */
     readonly pipelineInterface: PipelineInterface;
 };
+/**
+ * TODO: [🧠][🤓] How to pass optional parameters - for example summary in FORMFACTOR Translator
+ */

package/esm/typings/src/formfactors/chatbot/ChatbotFormfactorDefinition.d.ts

@@ -9,7 +9,37 @@ export declare const ChatbotFormfactorDefinition: {
     readonly description: "@@@";
     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";
+            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;
+        }];
     };
 };

package/esm/typings/src/formfactors/generator/GeneratorFormfactorDefinition.d.ts

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

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

@@ -8,7 +8,7 @@ export declare const GenericFormfactorDefinition: {
     readonly description: "@@@";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/173";
     readonly pipelineInterface: {
-        readonly inputParameterNames: readonly [];
-        readonly outputParameterNames: readonly [];
+        readonly inputParameters: readonly [];
+        readonly outputParameters: readonly [];
     };
 };

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

@@ -8,8 +8,8 @@ export declare const FORMFACTOR_DEFINITIONS: readonly [{
     readonly description: "@@@";
     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";
@@ -17,32 +17,94 @@ export declare const FORMFACTOR_DEFINITIONS: readonly [{
     readonly description: "@@@";
     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/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/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 inputParameterNames: readonly [];
-        readonly outputParameterNames: readonly [];
+        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 [];
     };
 }];
 /**

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

@@ -8,7 +8,7 @@ export declare const MatcherFormfactorDefinition: {
     readonly description: "@@@";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/177";
     readonly pipelineInterface: {
-        readonly inputParameterNames: readonly [];
-        readonly outputParameterNames: readonly [];
+        readonly inputParameters: readonly [];
+        readonly outputParameters: readonly [];
     };
 };

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

@@ -8,7 +8,17 @@ export declare const SheetsFormfactorDefinition: {
     readonly description: "@@@";
     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

@@ -8,7 +8,17 @@ export declare const TranslatorFormfactorDefinition: {
     readonly description: "@@@";
     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/pipeline/PipelineInterface/PipelineInterface.d.ts

@@ -1,4 +1,5 @@
-import type { string_parameter_name } from '../../types/typeAliases';
+import type { InputParameterJson } from '../PipelineJson/ParameterJson';
+import type { OutputParameterJson } from '../PipelineJson/ParameterJson';
 /**
  * @@@
  *
@@ -11,15 +12,15 @@ export type PipelineInterface = {
      *
      * Note: Sorted alphabetically
      */
-    readonly inputParameterNames: ReadonlyArray<string_parameter_name>;
+    readonly inputParameters: ReadonlyArray<InputParameterJson>;
     /**
      * @@@
      *
      * Note: Sorted alphabetically
      */
-    readonly outputParameterNames: ReadonlyArray<string_parameter_name>;
+    readonly outputParameters: ReadonlyArray<OutputParameterJson>;
 };
 /**
- * TODO: !!!!!! Change inputParameterNames to inputParameters<InputParameter>
+ * 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

@@ -6,8 +6,8 @@
  * @public exported from `@promptbook/core`
  */
 export declare const GENERIC_PIPELINE_INTERFACE: {
-    readonly inputParameterNames: readonly [];
-    readonly outputParameterNames: readonly [];
+    readonly inputParameters: readonly [];
+    readonly outputParameters: readonly [];
 };
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name

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

@@ -1,6 +1,6 @@
 import type { ForeachJson } from '../../commands/FOREACH/ForeachJson';
 import type { FormatCommand } from '../../commands/FORMAT/FormatCommand';
-import type { SectionType } from '../../commands/SECTION/SectionType';
+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';
@@ -13,32 +13,32 @@ import type { Expectations } from './Expectations';
 /**
  * Common properties of all tasks
  */
-export type TaskJsonCommon = {
+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 TaskJsonCommon = {
     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 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 TaskJsonCommon = {
      */
     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,7 +90,7 @@ export type TaskJsonCommon = {
      */
     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;
 };

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

@@ -1,11 +1,11 @@
-import type { TaskJsonCommon } from './TaskJsonCommon';
+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 = TaskJsonCommon & {
+export type DialogTaskJson = CommonTaskJson & {
     readonly taskType: 'DIALOG_TASK';
 };
 /**

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

@@ -90,6 +90,8 @@ export type CommonParameterJson = {
     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/pipeline/PipelineJson/PersonaJson.d.ts

@@ -11,7 +11,7 @@ import type { string_persona_description } from '../../types/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
      */

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

@@ -14,7 +14,7 @@ import type { PreparationJson } from './PreparationJson';
 import type { TaskJson } from './TaskJson';
 /**
  * Promptbook is the **core concept of this package**.
- * It represents a series of tasks chained together to form a pipeline / one big template with input and result parameters.
+ * It represents a series of tasks chained together to form a pipeline / one big task with input and result parameters.
  *
  * Note: [🚉] This is fully serializable as JSON
  *
@@ -28,7 +28,7 @@ export type PipelineJson = {
      * Note: It must use HTTPs URL
      * Tip: You can do versioning in the URL
      *      For example: https://promptbook.studio/webgpt/write-website-content-cs.book.md@1.0.0
-     * Warning: Do not hash part of the URL, hash part is used for identification of the template in the pipeline
+     * Warning: Do not hash part of the URL, hash part is used for identification of the task in the pipeline
      */
     readonly pipelineUrl?: string_pipeline_url;
     /**

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

@@ -1,12 +1,12 @@
 import type { ModelRequirements } from '../../types/ModelRequirements';
 import type { string_name } from '../../types/typeAliases';
-import type { TaskJsonCommon } from './TaskJsonCommon';
+import type { CommonTaskJson } from './CommonTaskJson';
 /**
  * Task for prompt to LLM
  *
  * Note: [🚉] This is fully serializable as JSON
  */
-export type PromptTaskJson = TaskJsonCommon & {
+export type PromptTaskJson = CommonTaskJson & {
     readonly taskType: 'PROMPT_TASK';
     /**
      * Name of the persona who will be responding to this prompt

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

@@ -1,12 +1,12 @@
 import type { ScriptLanguage } from '../../types/ScriptLanguage';
-import type { TaskJsonCommon } from './TaskJsonCommon';
+import type { CommonTaskJson } from './CommonTaskJson';
 /**
  * Task for script execution
  *
  * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook/discussions/77
  */
-export type ScriptTaskJson = TaskJsonCommon & {
+export type ScriptTaskJson = CommonTaskJson & {
     readonly taskType: 'SCRIPT_TASK';
     /**
      * Language of the script

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

@@ -1,11 +1,11 @@
-import type { TaskJsonCommon } from './TaskJsonCommon';
+import type { CommonTaskJson } from './CommonTaskJson';
 /**
  * Task for simple concatenation of strings
  *
  * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook/discussions/17
  */
-export type SimpleTaskJson = TaskJsonCommon & {
+export type SimpleTaskJson = CommonTaskJson & {
     readonly taskType: 'SIMPLE_TASK';
 };
 /**

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

@@ -4,7 +4,7 @@ import type { PromptTaskJson } from './PromptTaskJson';
 import type { ScriptTaskJson } from './ScriptTaskJson';
 import type { SimpleTaskJson } from './SimpleTaskJson';
 /**
- * Describes one (prompt) template in the promptbook
+ * Describes one (prompt) task in the pipeline
  *
  * Note: [🚉] This is fully serializable as JSON
  */

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

@@ -1,6 +1,6 @@
 /**
  * Promptbook is the **core concept of this package**.
- * It represents a series of tasks chained together to form a pipeline / one big template with input and result parameters.
+ * It represents a series of tasks chained together to form a pipeline / one big task with input and result parameters.
  *
  * @see @@@ https://github.com/webgptorg/promptbook#promptbook
  */

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

@@ -10,7 +10,7 @@ export declare function isPipelinePrepared(pipeline: PipelineJson): boolean;
  * TODO: [🐠] Maybe base this on `makeValidator`
  * TODO: [🧊] Pipeline can be partially prepared, this should return true ONLY if fully prepared
  * TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`
- *     - [🏍] ? Is context in each template
+ *     - [🏍] ? Is context in each task
  *     - [♨] Are examples prepared
  *     - [♨] Are tasks prepared
  */

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

@@ -2,13 +2,13 @@ import type { ExecutionTools } from '../execution/ExecutionTools';
 import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../pipeline/PipelineJson/TaskJson';
 import type { PrepareAndScrapeOptions } from './PrepareAndScrapeOptions';
-type PrepareTemplateInput = Pick<PipelineJson, 'tasks' | 'parameters'> & {
+type PrepareTaskInput = Pick<PipelineJson, 'tasks' | 'parameters'> & {
     /**
      * @@@
      */
     readonly knowledgePiecesCount: number;
 };
-type PreparedTemplates = {
+type PreparedTasks = {
     /**
      * @@@ Sequence of tasks that are chained together to form a pipeline
      */
@@ -19,11 +19,11 @@ type PreparedTemplates = {
  *
  * @public exported from `@promptbook/core`
  */
-export declare function prepareTasks(pipeline: PrepareTemplateInput, tools: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options: PrepareAndScrapeOptions): Promise<PreparedTemplates>;
+export declare function prepareTasks(pipeline: PrepareTaskInput, tools: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options: PrepareAndScrapeOptions): Promise<PreparedTasks>;
 export {};
 /**
- * TODO: [🧠] Add context to each template (if missing)
- * TODO: [🧠] What is better name `prepareTemplate` or `prepareTemplateAndParameters`
+ * TODO: [🧠] Add context to each task (if missing)
+ * TODO: [🧠] What is better name `prepareTask` or `prepareTaskAndParameters`
  * TODO: [♨][main] !!! Prepare index the examples and maybe tasks
  * 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/Prompt.d.ts

@@ -5,7 +5,7 @@ import type { CompletionModelRequirements } from './ModelRequirements';
 import type { EmbeddingModelRequirements } from './ModelRequirements';
 import type { ModelRequirements } from './ModelRequirements';
 import type { Parameters } from './typeAliases';
-import type { string_pipeline_url_with_hashtemplate } from './typeAliases';
+import type { string_pipeline_url_with_task_hash } from './typeAliases';
 import type { string_postprocessing_function_name } from './typeAliases';
 import type { string_prompt } from './typeAliases';
 import type { string_template } from './typeAliases';
@@ -93,11 +93,11 @@ export type CommonPrompt = {
      */
     readonly format?: FormatCommand['format'];
     /**
-     * Unique identifier of the pipeline with specific template name as hash
+     * Unique identifier of the pipeline with specific task name as hash
      *
      * @example https://promptbook.studio/webgpt/write-website-content-cs.book.md#keywords
      */
-    readonly pipelineUrl?: string_pipeline_url_with_hashtemplate;
+    readonly pipelineUrl?: string_pipeline_url_with_task_hash;
     /**
      * Parameters used in the `content`
      */

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

@@ -0,0 +1,21 @@
+import type { TupleToUnion } from 'type-fest';
+/**
+ * Type of the section
+ */
+export type SectionType = TupleToUnion<typeof SectionTypes>;
+/**
+ * All available sections which are not tasks
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const NonTaskSectionTypes: readonly ["EXAMPLE", "KNOWLEDGE", "INSTRUMENT", "ACTION"];
+/**
+ * All available section types
+ *
+ * There is is distinction between task types and section types
+ * - Every section in markdown has its SectionType
+ * - Some sections are tasks but other can be non-task sections
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const SectionTypes: readonly [...("PROMPT_TASK" | "SIMPLE_TASK" | "SCRIPT_TASK" | "DIALOG_TASK")[], "EXAMPLE", "KNOWLEDGE", "INSTRUMENT", "ACTION"];

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

@@ -1,4 +1,4 @@
-import type { SectionType } from '../commands/SECTION/SectionType';
+import type { SectionType } from './SectionType';
 import type { string_markdown_text } from './typeAliases';
 import type { string_name } from './typeAliases';
 /**

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

@@ -0,0 +1,15 @@
+import type { TupleToUnion } from 'type-fest';
+/**
+ * Type of the task
+ */
+export type TaskType = TupleToUnion<typeof TaskTypes>;
+/**
+ * All available task types
+ *
+ * There is is distinction between task types and section types
+ * - Every section in markdown has its SectionType
+ * - Some sections are tasks but other can be non-task sections
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const TaskTypes: readonly ["PROMPT", "SIMPLE", "SCRIPT", "DIALOG"];