@promptbook/remote-client 0.61.0-2 → 0.61.0-20

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

@@ -5,6 +5,7 @@ import type { string_javascript_name } from '../typeAliases';
 import type { string_markdown } from '../typeAliases';
 import type { string_markdown_text } from '../typeAliases';
 import type { string_name } from '../typeAliases';
+import type { string_parameter_name } from '../typeAliases';
 import type { string_prompt } from '../typeAliases';
 import type { string_template } from '../typeAliases';
 import type { Expectations } from './Expectations';
@@ -15,7 +16,7 @@ export interface PromptTemplateJsonCommon {
     /**
      * Name of the template
      * - It must be unique across the pipeline
-     * - It should start uppercase and contain letters and numbers
+     * - It should start uppercase and can contain letters and numbers
      * - The pipelineUrl together with hash and name are used to identify the prompt template in the pipeline
      */
     readonly name: string_name;
@@ -34,11 +35,13 @@ export interface PromptTemplateJsonCommon {
      *
      * Note: Joker is one of the dependent parameters
      */
-    readonly dependentParameterNames: Array<string_name>;
+    readonly dependentParameterNames: Array<string_parameter_name>;
     /**
      * If theese parameters meet the expectations requirements, they are used instead of executing this prompt template
+     *
+     * @see https://github.com/webgptorg/promptbook/discussions/66
      */
-    readonly jokers?: Array<string>;
+    readonly jokerParameterNames?: Array<string_parameter_name>;
     /**
      * Type of the execution
      * This determines if the prompt template is send to LLM, user or some scripting evaluation
@@ -50,20 +53,24 @@ export interface PromptTemplateJsonCommon {
     readonly content: (string_prompt | string_javascript | string_markdown) & string_template;
     /**
      * List of postprocessing steps that are executed after the prompt template
+     *
+     * @see https://github.com/webgptorg/promptbook/discussions/31
      */
-    readonly postprocessing?: Array<string_javascript_name>;
+    readonly postprocessingFunctionNames?: Array<string_javascript_name>;
     /**
      * Expect this amount of each unit in the answer
      *
      * 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 expectFormat?: ExpectFormatCommand['format'];
@@ -73,5 +80,7 @@ export interface PromptTemplateJsonCommon {
     readonly resultingParameterName: string_name;
 }
 /**
+ * TODO: [🧠][🥜]
  * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
+ * TODO: [♈] Probbably move expectations from templates to parameters
  */

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

@@ -1,5 +1,6 @@
 import type { string_markdown_text } from '../typeAliases';
-import type { string_name } from '../typeAliases';
+import type { string_parameter_name } from '../typeAliases';
+import type { string_parameter_value } from '../typeAliases';
 /**
  * Describes one parameter of the promptbook
  */
@@ -9,7 +10,7 @@ export type PromptTemplateParameterJson = {
      * - It must be unique across the pipeline
      * - It should start lowercase and contain letters and numbers
      */
-    readonly name: string_name;
+    readonly name: string_parameter_name;
     /**
      * The parameter is input of the pipeline
      */
@@ -23,4 +24,12 @@ export type PromptTemplateParameterJson = {
      * - It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
      */
     readonly description?: string_markdown_text;
+    /**
+     * Sample 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 sampleValues?: Array<string_parameter_value>;
 };
+/**
+ * TODO: [♈] Probbably move expectations from templates to parameters
+ */

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

@@ -2,6 +2,8 @@ import type { ScriptLanguage } from '../ScriptLanguage';
 import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
 /**
  * Template for script execution
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/77
  */
 export interface ScriptJson extends PromptTemplateJsonCommon {
     readonly blockType: 'SCRIPT';

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

@@ -1,6 +1,8 @@
 import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
 /**
  * Template for simple concatenation of strings
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/17
  */
 export interface SimpleTemplateJson extends PromptTemplateJsonCommon {
     readonly blockType: 'SIMPLE_TEMPLATE';

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

@@ -2,7 +2,7 @@
  * Promptbook is the **core concept of this package**.
  * It represents a series of prompt templates chained together to form a pipeline / one big prompt template with input and result parameters.
  *
- * @see !!! https://github.com/webgptorg/promptbook#promptbook
+ * @see @@@ https://github.com/webgptorg/promptbook#promptbook
  */
 export type PipelineString = string & {
     readonly _type: 'Promptbook';

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

@@ -1,17 +1,61 @@
 import type { ExpectFormatCommand } from '../commands/EXPECT/ExpectFormatCommand';
 import type { PostprocessingFunction } from '../scripting/javascript/JavascriptExecutionToolsOptions';
+import type { ChatModelRequirements } from './ModelRequirements';
+import type { CompletionModelRequirements } from './ModelRequirements';
+import type { EmbeddingModelRequirements } from './ModelRequirements';
 import type { ModelRequirements } from './ModelRequirements';
 import type { Expectations } from './PipelineJson/Expectations';
-import type { string_name } from './typeAliases';
+import type { Parameters } from './typeAliases';
 import type { string_pipeline_url_with_hashtemplate } from './typeAliases';
 import type { string_prompt } from './typeAliases';
+import type { string_template } from './typeAliases';
 import type { string_title } from './typeAliases';
 /**
  * Prompt in a text along with model requirements, but without any execution or templating logic.
  *
+ * Note: [🛫] This is NOT fully serializable as JSON, it contains functions which are not serializable
  * @see https://github.com/webgptorg/promptbook#prompt
  */
-export type Prompt = {
+export type Prompt = CompletionPrompt | ChatPrompt | EmbeddingPrompt;
+/**
+ * Completion prompt
+ *
+ * Note: [🛫] This is NOT fully serializable as JSON, it contains functions which are not serializable
+ */
+export type CompletionPrompt = CommonPrompt & {
+    /**
+     * Requirements for completion model
+     */
+    modelRequirements: CompletionModelRequirements;
+};
+/**
+ * Chat prompt
+ *
+ * Note: [🛫] This is NOT fully serializable as JSON, it contains functions which are not serializable
+ */
+export type ChatPrompt = CommonPrompt & {
+    /**
+     * Requirements for chat model
+     */
+    modelRequirements: ChatModelRequirements;
+};
+/**
+ * Embedding prompt
+ *
+ * Note: [🛫] This is NOT fully serializable as JSON, it contains functions which are not serializable
+ */
+export type EmbeddingPrompt = CommonPrompt & {
+    /**
+     * Requirements for chat model
+     */
+    modelRequirements: EmbeddingModelRequirements;
+};
+/**
+ * Common properties for all prompt results
+ *
+ * Note: This is fully serializable as JSON
+ */
+export type CommonPrompt = {
     /**
      * The title of the prompt
      *
@@ -19,12 +63,11 @@ export type Prompt = {
      */
     readonly title: string_title;
     /**
-     * The text of the prompt
+     * The text of the prompt with placeholders for parameters
      *
-     * Note: This is not a template, this is exactly the text that will be sent to the model
-     * @example "What is the capital of France?"
+     * @example "What is the capital of {country}?"
      */
-    readonly content: string_prompt;
+    readonly content: string_prompt & string_template;
     /**
      * Requirements for the model
      */
@@ -54,12 +97,13 @@ export type Prompt = {
      */
     readonly pipelineUrl?: string_pipeline_url_with_hashtemplate;
     /**
-     * Parameters used in the prompt
-     *
-     * Note: This is redundant (same information is in pipelineUrl+content) but useful for logging and debugging
+     * Parameters used in the `content`
      */
-    readonly parameters: Record<string_name, string>;
+    readonly parameters: Parameters;
 };
 /**
+ * TODO: [🔼] !!!! Export all from `@promptbook/types`
+ * TODO: [🧄] Replace all "github.com/webgptorg/promptbook#xxx" with "ptbk.io/xxx"
  * TODO: [✔] Check ModelRequirements in runtime
+ * TODO: [🏳] Add options for translation - maybe create `TranslationPrompt`
  */

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

@@ -41,18 +41,18 @@ export type ExecutionReportJson = {
         /**
          * The prompt wich was executed
          */
-        prompt: Omit<Prompt, 'pipelineUrl' | 'parameters'>;
+        readonly prompt: Omit<Prompt, 'pipelineUrl' | 'parameters'>;
         /**
          * Result of the prompt execution (if not failed during LLM execution)
          */
-        result?: PromptResult;
+        readonly result?: PromptResult;
         /**
          * The error which occured during LLM execution or during postprocessing or expectation checking
          *
          * Note: It makes sense to have both error and result defined, for example when the result not pass expectations
          */
-        error?: {
-            message: string;
+        readonly error?: {
+            readonly message: string;
         };
     }>;
 };

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

@@ -1,16 +1,16 @@
 import type { number_percent } from '../typeAliases';
 /**
- * Options for generating an execution report string
+ * Options for `executionReportJsonToString`
  */
 export type ExecutionReportStringOptions = {
     /**
      * The tax rate to be applied, expressed as a percentage from 0 to 1 (=100%) or even more
      */
-    taxRate: number_percent;
+    readonly taxRate: number_percent;
     /**
      * The width of the charts in the report
      */
-    chartsWidth: number;
+    readonly chartsWidth: number;
 };
 /**
  * Default options for generating an execution report string

package/esm/typings/src/types/execution-report/countWorkingDuration.d.ts

@@ -2,6 +2,6 @@ import type { FromtoItems } from '../../utils/FromtoItems';
 /**
  * Count the duration of working time
  *
- * @private within the package
+ * @private within the repository
  */
 export declare function countWorkingDuration(items: FromtoItems): number;

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

@@ -1,3 +1,4 @@
+import { RESERVED_PARAMETER_NAMES } from '../config';
 /**
  * Semantic helper
  */
@@ -17,7 +18,7 @@ export type string_prompt = string;
 /**
  * Semantic helper
  *
- * For example `"A cat wearing a {ITEM}"`
+ * For example `"A cat wearing a {item}"`
  */
 export type string_template = string;
 /**
@@ -32,6 +33,12 @@ export type string_text_prompt = string_prompt;
  * For example `"How many hats does the cat wear?"`
  */
 export type string_chat_prompt = string_text_prompt;
+/**
+ * Semantic helper
+ *
+ * For example `"You are an AI assistant. You are here to help me with my work."`
+ */
+export type string_system_message = string_text_prompt;
 /**
  * Semantic helper
  *
@@ -73,6 +80,42 @@ export type string_char = string;
  * For example `"ainautes"`
  */
 export type string_name = string;
+/**
+ * Semantic helper
+ * Unique identifier of anything
+ *
+ * For example `"eventName"`
+ */
+export type string_parameter_name = string_name;
+/**
+ * Semantic helper
+ * Unique identifier of parameter
+ *
+ * For example `"DevConf 2024"`
+ */
+export type string_parameter_value = string;
+/**
+ * Parameters of the pipeline
+ *
+ * There are three types of parameters:
+ * - **INPUT PARAMETERs** are required to execute the pipeline.
+ * - **Intermediate parameters** are used internally in the pipeline.
+ * - **OUTPUT PARAMETERs** are not used internally in the pipeline, but are returned as the result of the pipeline execution.
+ *
+ * @see https://ptbk.io/parameters
+ */
+export type Parameters = Exclude<Record<string_parameter_name, string_parameter_value>, ReservedParameters>;
+/**
+ * Semantic helper
+ * Unique identifier of reserved parameter
+ *
+ * For example `"context"`
+ */
+export type string_reserved_parameter_name = typeof RESERVED_PARAMETER_NAMES[number];
+/**
+ * @@@
+ */
+export type ReservedParameters = Record<string_reserved_parameter_name, string_parameter_value>;
 /**
  * Semantic helper
  * Title of anything
@@ -80,6 +123,36 @@ export type string_name = string;
  * For example `"Ai*nautes"`
  */
 export type string_title = string;
+/**
+ * Description of persona
+ *
+ * For example `"Skilled copywriter"`
+ */
+export type string_persona_description = string;
+/**
+ * Source of one knowledge
+ *
+ * It can be a link, a relative path to file or direct text
+ *
+ * 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"`
+ *
+ * @@@ string_knowledge_source vs string_knowledge_source_link
+ */
+export type string_knowledge_source = string_knowledge_source_link | string_markdown;
+/**
+ * One link to knowledge source
+ *
+ * It can be a link or relative path
+ *
+ * For example `"https://pavolhejny.com/"`
+ * For example `"./pavol-hejny-cv.pdf"`
+ *
+ * @@@ string_knowledge_source vs string_knowledge_source_link
+ */
+export type string_knowledge_source_link = string_url | string_file_path;
 /**
  * Semantic helper
  *
@@ -123,6 +196,10 @@ export type string_markdown_section_content = string;
  * For example `"**Hello** World!"`
  */
 export type string_markdown_text = string;
+/**
+ * @@@
+ */
+export type string_promptbook_documentation_url = `https://github.com/webgptorg/promptbook/discussions/${number | '@@'}`;
 /**
  * Semantic helper
  *
@@ -159,6 +236,17 @@ export type string_script = string;
  * For example `console.info("Hello World!")`
  */
 export type string_javascript = string;
+/**
+ * Semantic helper for JSON strings
+ *
+ * Note: TType is a type of the JSON object inside the string
+ *
+ * For example `{"foo": "bar"}`
+ */
+export type string_json<TType> = string & {
+    _type: 'string_json';
+    scheme: TType;
+};
 /**
  * Semantic helper
  *
@@ -428,6 +516,14 @@ export type string_date_iso8601 = `${number}-${number}-${number}${string}${numbe
  * Semantic helper for US Dollars
  */
 export type number_usd = number;
+/**
+ * Semantic helper for incremental IDs
+ */
+export type number_id = number_integer & (number_positive | 0);
+/**
+ * Semantic helper for number of rows and columns
+ */
+export type number_linecol_number = number_integer & number_positive;
 /**
  * Semantic helper for number of tokens
  */
@@ -437,9 +533,22 @@ export type number_negative = number;
 export type number_integer = number;
 /**
  * Semantic helper;
- * Percentage from 0 to 1 (100%)
+ * Percentage from 0 to 1 (100%) (and bellow and above)
  */
 export type number_percent = number;
+/**
+ * Semantic helper;
+ * Model temperature
+ */
+export type number_model_temperature = number_percent;
+/**
+ * Semantic helper;
+ * Seed for random generator
+ *
+ * Percentage from 0 to 1 (100%)
+ * TODO: Is seed (in OpenAI) number from 0 to 1?
+ */
+export type number_seed = number_percent;
 /**
  * Likeness of the wallpaper
  *
@@ -462,19 +571,9 @@ export type number_kilobytes = number_positive;
 export type number_megabytes = number_positive;
 export type number_gigabytes = number_positive;
 export type number_terabytes = number_positive;
-/**
- * Formatting helper to put void to keep longer version of prettier
- */
-export type ___ = never;
-/**
- * Organizational helper to better mark the place where the type is missing
- */
-export type TODO = any;
-/**
- * Organizational helper to mark a place where to really use any
- */
-export type really_any = any;
-/**
+/**.
+ * TODO: !!! Change "For example" to @example
  * TODO: !! Cleanup
  * TODO: !! Change to branded types
+ * TODO: [📂] Export all this file through `@promptbook/types`
  */

package/esm/typings/src/utils/FromtoItems.d.ts

@@ -5,15 +5,15 @@ export type FromtoItems = Array<{
     /**
      * The title of the item
      */
-    title: string;
+    readonly title: string;
     /**
      * The start of the item
      *
      * This can mean anything, like seconds, milliseconds, dollars, etc.
      */
-    from: number;
+    readonly from: number;
     /**
      * The end of the item
      */
-    to: number;
+    readonly to: number;
 }>;

package/esm/typings/src/utils/currentDate.d.ts

@@ -0,0 +1,7 @@
+import type { string_date_iso8601 } from '../types/typeAliases';
+/**
+ * Simple wrapper `new Date().toISOString()`
+ *
+ * @returns string_date branded type
+ */
+export declare function $currentDate(): string_date_iso8601;

package/esm/typings/src/utils/deepClone.d.ts

@@ -0,0 +1,9 @@
+import type { WritableDeep } from 'type-fest';
+/**
+ * @@@
+ */
+export declare function deepClone<TObject>(objectValue: TObject): WritableDeep<TObject>;
+/**
+ * TODO: [🔼] Export from `@promptbook/utils`
+ * TODO: [🧠] Is there a way how to meaningfully test this utility
+ */

package/esm/typings/src/utils/deepFreeze.d.ts

@@ -0,0 +1,22 @@
+import type { ReadonlyDeep } from 'type-fest';
+/**
+ * @@@
+ *
+ * @returns The same object as the input, but deeply frozen
+ *
+ * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
+ */
+export declare function deepFreeze<TObject>(objectValue: TObject): ReadonlyDeep<TObject>;
+/**
+ * @@@
+ * @@@
+ *
+ * @returns The same object as the input, but deeply frozen
+ *
+ * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
+ */
+export declare function deepFreezeWithSameType<TObject>(objectValue: TObject): TObject;
+/**
+ * TODO: [🔼] Export from `@promptbook/utils`
+ * TODO: [🧠] Is there a way how to meaningfully test this utility
+ */

package/esm/typings/src/utils/emojis.d.ts

@@ -5,7 +5,7 @@ import type { string_char_emoji } from '../types/typeAliasEmoji';
  *
  * @see https://getemoji.com/
  *
- * @private within the package
+ * @private within the repository
  * @deprecated Use /\p{Extended_Pictographic}/ instead
  */
 export declare const EMOJIS_IN_CATEGORIES: Record<string, Array<string_char_emoji>>;
@@ -13,7 +13,7 @@ export declare const EMOJIS_IN_CATEGORIES: Record<string, Array<string_char_emoj
  *
  * All possible emoji chars like "🍆", "🍡", "🍤"...
  *
- * @private within the package
+ * @private within the repository
  * @deprecated Use /\p{Extended_Pictographic}/ instead
  */
 export declare const EMOJIS: Set<string_char_emoji>;

package/esm/typings/src/utils/extractParameters.d.ts

@@ -1,4 +1,4 @@
-import type { string_name } from '../types/typeAliases';
+import type { string_parameter_name } from '../types/typeAliases';
 import type { string_template } from '../types/typeAliases';
 /**
  * Parses the template and returns the list of all parameter names
@@ -6,4 +6,4 @@ import type { string_template } from '../types/typeAliases';
  * @param template the template with parameters in {curly} braces
  * @returns the list of parameter names
  */
-export declare function extractParameters(template: string_template): Set<string_name>;
+export declare function extractParameters(template: string_template): Set<string_parameter_name>;

package/esm/typings/src/utils/formatNumber.d.ts

@@ -1,6 +1,6 @@
 /**
  * Format either small or big number
  *
- * @private within the package
+ * @private within the repository
  */
 export declare function formatNumber(value: number): string;

package/esm/typings/src/utils/isRunningInWhatever.d.ts

@@ -10,3 +10,6 @@ export declare const isRunningInNode: Function;
  * Detects if the code is running in a web worker
  */
 export declare const isRunningInWebWorker: Function;
+/**
+ * TODO: [🔼] !!! Export via `@promptbook/utils`
+ */

package/esm/typings/src/utils/markdown/addAutoGeneratedSection.d.ts

@@ -3,9 +3,9 @@ import type { string_name } from '../../types/typeAliases';
 /**
  * Add or modify an auto-generated section in a markdown file
  *
- * @private within the package
+ * @private within the repository
  */
 export declare function addAutoGeneratedSection(content: string_markdown, options: {
-    sectionName: string_name;
-    sectionContent: string_markdown;
+    readonly sectionName: string_name;
+    readonly sectionContent: string_markdown;
 }): string_markdown;

package/esm/typings/src/utils/markdown/createMarkdownChart.d.ts

@@ -1,37 +1,34 @@
 import type { string_markdown } from '../../types/typeAliases';
 import type { FromtoItems } from '../FromtoItems';
 /**
- * Options for creating a markdown chart
- */
-/**
- * Options for creating a markdown chart.
+ * Options for `CreateMarkdownChartOptions`
  */
 type CreateMarkdownChartOptions = {
     /**
      * The header for the first column - the name of the item
      */
-    nameHeader: string;
+    readonly nameHeader: string;
     /**
      * The header for the second column - the value of the item
      */
-    valueHeader: string;
+    readonly valueHeader: string;
     /**
      * The items to be charted
      */
-    items: FromtoItems;
+    readonly items: FromtoItems;
     /**
      * The width of the chart in squares
      */
-    width: number;
+    readonly width: number;
     /**
      * The name of the unit shown in the chart
      */
-    unitName: string;
+    readonly unitName: string;
 };
 /**
  * Function createMarkdownChart will draw a chart in markdown from ⬛+🟦 tiles
  *
- * @private within the package
+ * @private within the repository
  */
 export declare function createMarkdownChart(options: CreateMarkdownChartOptions): string_markdown;
 export {};

package/esm/typings/src/utils/markdown/createMarkdownTable.d.ts

@@ -3,6 +3,6 @@ import type { string_markdown_text } from '../../types/typeAliases';
 /**
  * Create a markdown table from a 2D array of strings
  *
- * @private within the package
+ * @private within the repository
  */
 export declare function createMarkdownTable(table: Array<Array<string_markdown_text>>): string_markdown;

package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown-real.test.d.ts

@@ -0,0 +1 @@
+export {};