@promptbook/openai 0.61.0-1 → 0.61.0-11

package/umd/typings/src/types/PipelineJson/PipelineJson.d.ts

@@ -2,7 +2,12 @@ import type { string_file_path } from '../typeAliases';
 import type { string_markdown_text } from '../typeAliases';
 import type { string_pipeline_url } from '../typeAliases';
 import type { string_semantic_version } from '../typeAliases';
-import type { KnowledgeJson } from './KnowledgeJson';
+import type { KnowledgePiecePreparedJson } from './KnowledgePieceJson';
+import type { KnowledgeSourceJson } from './KnowledgeSourceJson';
+import type { KnowledgeSourcePreparedJson } from './KnowledgeSourceJson';
+import type { PersonaJson } from './PersonaJson';
+import type { PersonaPreparedJson } from './PersonaJson';
+import type { PreparationJson } from './PreparationJson';
 import type { PromptTemplateJson } from './PromptTemplateJson';
 import type { PromptTemplateParameterJson } from './PromptTemplateParameterJson';
 /**
@@ -50,11 +55,30 @@ export type PipelineJson = {
     readonly promptTemplates: Array<PromptTemplateJson>;
     /**
      * Set of information that are used as external knowledge in the pipeline
+     *
+     * @see https://github.com/webgptorg/promptbook/discussions/41
+     */
+    readonly knowledgeSources: Array<KnowledgeSourceJson | KnowledgeSourcePreparedJson>;
+    /**
+     * Set of information that are used as external knowledge in the pipeline
+     *
+     * @see https://github.com/webgptorg/promptbook/discussions/41
+     */
+    readonly knowledgePieces: Array<KnowledgePiecePreparedJson>;
+    /**
+     * List of prepared virtual personas that are used in the pipeline
+     *
+     * @see https://github.com/webgptorg/promptbook/discussions/22
+     */
+    readonly personas: Array<PersonaJson | PersonaPreparedJson>;
+    /**
+     * List of prepared virtual personas that are used in the pipeline
+     *
+     * @see https://github.com/webgptorg/promptbook/discussions/78
      */
-    readonly knowledge: KnowledgeJson;
+    readonly preparations: Array<PreparationJson>;
 };
 /**
- * TODO: !!!!! Implement new commands
  * Note: There was a proposal for multiple types of promptbook objects 78816ff33e2705ee1a187aa2eb8affd976d4ea1a
  *       But then immediately reverted back to the single type
  *       With knowledge as part of the promptbook and collection just as a collection of promptbooks

package/umd/typings/src/types/PipelineJson/PreparationJson.d.ts

@@ -0,0 +1,21 @@
+import type { PromptResultUsage } from '../../execution/PromptResult';
+import type { string_promptbook_version } from '../../version';
+import type { number_id } from '../typeAliases';
+export type PreparationJson = {
+    /**
+     * Incremental ID of the preparation
+     */
+    readonly id: number_id;
+    /**
+     * Version of the promptbook used for the preparation
+     */
+    readonly promptbookVersion: string_promptbook_version;
+    /**
+     * Usage of the prompt execution
+     */
+    readonly modelUsage: PromptResultUsage;
+};
+/**
+ * TODO: Maybe put here used `modelName`
+ * TODO: [🍥] When using `date` it changes all samples .ptbk.json files each time so until some more elegant solution omit the time from prepared pipeline
+ */

package/umd/typings/src/types/PipelineJson/PromptDialogJson.d.ts

@@ -1,6 +1,8 @@
 import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
 /**
  * Template for prompt to user
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/76
  */
 export interface PromptDialogJson extends PromptTemplateJsonCommon {
     readonly blockType: 'PROMPT_DIALOG';

package/umd/typings/src/types/PipelineJson/PromptTemplateJson.d.ts

@@ -1,4 +1,4 @@
-import type { ___ } from '../typeAliases';
+import type { ___ } from '../../utils/organization/___';
 import type { LlmTemplateJson } from './LlmTemplateJson';
 import type { PromptDialogJson } from './PromptDialogJson';
 import type { ScriptJson } from './ScriptJson';

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

@@ -15,7 +15,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;
@@ -37,6 +37,8 @@ export interface PromptTemplateJsonCommon {
     readonly dependentParameterNames: Array<string_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>;
     /**
@@ -50,6 +52,8 @@ 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>;
     /**
@@ -58,12 +62,14 @@ export interface PromptTemplateJsonCommon {
      * 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'];
@@ -74,4 +80,5 @@ export interface PromptTemplateJsonCommon {
 }
 /**
  * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
+ * TODO: [♈] Probbably move expectations from templates to parameters
  */

package/umd/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/umd/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/umd/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/umd/typings/src/types/Prompt.d.ts

@@ -2,13 +2,15 @@ import type { ExpectFormatCommand } from '../commands/EXPECT/ExpectFormatCommand
 import type { PostprocessingFunction } from '../scripting/javascript/JavascriptExecutionToolsOptions';
 import type { ModelRequirements } from './ModelRequirements';
 import type { Expectations } from './PipelineJson/Expectations';
-import type { string_name } from './typeAliases';
+import type { string_parameter_name } from './typeAliases';
+import type { string_parameter_value } from './typeAliases';
 import type { string_pipeline_url_with_hashtemplate } from './typeAliases';
 import type { string_prompt } 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 = {
@@ -58,8 +60,9 @@ export type Prompt = {
      *
      * Note: This is redundant (same information is in pipelineUrl+content) but useful for logging and debugging
      */
-    readonly parameters: Record<string_name, string>;
+    readonly parameters: Record<string_parameter_name, string_parameter_value>;
 };
 /**
  * TODO: [✔] Check ModelRequirements in runtime
+ * TODO: [🏳] Add options for translation - maybe create `TranslationPrompt`
  */

package/umd/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/umd/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/umd/typings/src/types/typeAliases.d.ts

@@ -32,6 +32,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 +79,20 @@ 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;
+/**
+ * Semantic helper
+ * Unique identifier of anything
+ *
+ * For example `"DevConf 2024"`
+ */
+export type string_parameter_value = string;
 /**
  * Semantic helper
  * Title of anything
@@ -80,6 +100,23 @@ 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"`
+ */
+export type string_knowledge_source = string_url | string_file_path | string;
 /**
  * Semantic helper
  *
@@ -428,6 +465,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 +482,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 +520,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/umd/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/umd/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/umd/typings/src/utils/markdown/addAutoGeneratedSection.d.ts

@@ -6,6 +6,6 @@ import type { string_name } from '../../types/typeAliases';
  * @private within the package
  */
 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/umd/typings/src/utils/markdown/createMarkdownChart.d.ts

@@ -1,32 +1,29 @@
 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

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

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

package/umd/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts

@@ -3,14 +3,18 @@ import type { string_markdown } from '../../types/typeAliases';
  * Single code block inside markdown.
  */
 export type CodeBlock = {
+    /**
+     * Which notation was used to open the code block
+     */
+    readonly blockNotation: '```' | '>';
     /**
      * Language of the code block OR null if the language is not specified in opening ```
      */
-    language: string | null;
+    readonly language: string | null;
     /**
      * Content of the code block (unescaped)
      */
-    content: string;
+    readonly content: string;
 };
 /**
  * Extracts all code blocks from markdown.
@@ -25,3 +29,6 @@ export type CodeBlock = {
  *
  */
 export declare function extractAllBlocksFromMarkdown(markdown: string_markdown): Array<CodeBlock>;
+/**
+ * TODO: Maybe name for `blockNotation` instead of  '```' and '>'
+ */

package/umd/typings/src/utils/markdown/extractOneBlockFromMarkdown.d.ts

@@ -15,5 +15,5 @@ import type { CodeBlock } from './extractAllBlocksFromMarkdown';
  */
 export declare function extractOneBlockFromMarkdown(markdown: string_markdown): CodeBlock;
 /***
- * TODO: [🍓][🌻] !!! Decide of this is internal util, external util OR validator/postprocessor
+ * TODO: [🍓][🌻] Decide of this is internal util, external util OR validator/postprocessor
  */

package/umd/typings/src/utils/markdown/parseMarkdownSection.d.ts

@@ -8,15 +8,15 @@ export type MarkdownSection = {
     /**
      * Title of the section
      */
-    title: string_markdown_text;
+    readonly title: string_markdown_text;
     /**
      * Level of the section like h1, h2, h3, h4, h5, h6
      */
-    level: 1 | 2 | 3 | 4 | 5 | 6;
+    readonly level: 1 | 2 | 3 | 4 | 5 | 6;
     /**
      * Content of the section with markdown formatting, blocks, lists, etc.
      */
-    content: string_markdown_section_content;
+    readonly content: string_markdown_section_content;
 };
 /**
  * Parses markdown section to title its level and content

package/umd/typings/src/utils/organization/TODO.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Organizational helper to better mark the place where the type is missing
+ */
+export type TODO = any;

package/umd/typings/src/utils/organization/TODO_USE.d.ts

@@ -0,0 +1,11 @@
+import type { really_any } from './really_any';
+/**
+ * Just marks a place of place where should be something implemented
+ * No side effects.
+ *
+ * Note: It can be usefull suppressing eslint errors of unused variables
+ *
+ * @param value any values
+ * @returns void
+ */
+export declare function TODO_USE(...value: Array<really_any>): void;

package/umd/typings/src/utils/organization/___.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Formatting helper to put void to keep longer version of prettier
+ */
+export type ___ = never;

package/umd/typings/src/utils/organization/notUsing.d.ts

@@ -0,0 +1,11 @@
+import type { really_any } from './really_any';
+/**
+ * Just says that the variable is not used
+ * No side effects.
+ *
+ * Note: It can be usefull suppressing eslint errors of unused variables in the tests
+ *
+ * @param value any values
+ * @returns void
+ */
+export declare function notUsing(...value: Array<really_any>): void;

package/umd/typings/src/utils/organization/really_any.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Organizational helper to mark a place where to really use any
+ */
+export type really_any = any;

package/umd/typings/src/utils/random/randomSeed.d.ts

@@ -0,0 +1,7 @@
+import type { number_seed } from '../../types/typeAliases';
+/**
+ * Generates random seed
+ *
+ * Warning: This function is not cryptographically secure (it uses Math.random internally)
+ */
+export declare function $randomSeed(): number_seed;

package/esm/typings/src/collection/constructors/justTestFsImport.d.ts

@@ -1,7 +0,0 @@
-/**
- * Just testing imports and compatibility
- */
-export declare function justTestFsImport(): Promise<void>;
-/**
- * TODO: !!! Remove this file
- */ 

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

@@ -1,6 +0,0 @@
-/**
- * Function personaToModelRequirements will @@@
- *
- * @private within the package
- */
-export declare function personaToModelRequirements(value: string): boolean;

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

@@ -1,6 +0,0 @@
-import type { MaterialKnowledgePieceJson } from './MaterialKnowledgePieceJson';
-export type KnowledgeJson = Array<MaterialKnowledgePieceJson>;
-/**
- * !!!! Annotate
- * TODO: [🦪] Internal links between (Material)KnowledgePieces withing the KnowledgeJson
- */

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

@@ -1,28 +0,0 @@
-import type { EmbeddingVector } from '../../execution/EmbeddingVector';
-import type { string_keyword } from '../../utils/normalization/IKeywords';
-import type { string_href } 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';
-export type MaterialKnowledgePieceJson = {
-    readonly name: string_name;
-    readonly title: string_markdown_text;
-    readonly content: string_markdown;
-    readonly keywords: Array<string_keyword>;
-    readonly index: Array<{
-        modelName: string_model_name;
-        position: EmbeddingVector;
-    }>;
-    readonly sources: Array<{
-        title: string_markdown_text;
-        href: string_href;
-    }>;
-};
-/**
- * TODO: !!! Use or uninstall xyzt
- * !!!! Annotate
- * TODO: [🧠][🦪] Maybe allow internal links between (Material)KnowledgePieces withing the KnowledgeJson and maybe require to explicitelly reference the source of the knowledge
- * TODO: [🧠] Make some non-material sources like external search engine or dialog to user
- * TODO: [🧠] Make some non-material (and maybe non-knowledge-like but tool-like) sources like calculator, code interpreter
- */

package/umd/typings/src/collection/constructors/justTestFsImport.d.ts

@@ -1,7 +0,0 @@
-/**
- * Just testing imports and compatibility
- */
-export declare function justTestFsImport(): Promise<void>;
-/**
- * TODO: !!! Remove this file
- */ 

package/umd/typings/src/personas/personaToModelRequirements.d.ts

@@ -1,6 +0,0 @@
-/**
- * Function personaToModelRequirements will @@@
- *
- * @private within the package
- */
-export declare function personaToModelRequirements(value: string): boolean;

package/umd/typings/src/types/PipelineJson/KnowledgeJson.d.ts

@@ -1,6 +0,0 @@
-import type { MaterialKnowledgePieceJson } from './MaterialKnowledgePieceJson';
-export type KnowledgeJson = Array<MaterialKnowledgePieceJson>;
-/**
- * !!!! Annotate
- * TODO: [🦪] Internal links between (Material)KnowledgePieces withing the KnowledgeJson
- */