@promptbook/openai 0.61.0-1 → 0.61.0-10

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

@@ -0,0 +1,67 @@
+import type { EmbeddingVector } from '../../execution/EmbeddingVector';
+import type { string_keyword } from '../../utils/normalization/IKeywords';
+import type { number_id } from '../typeAliases';
+import type { number_linecol_number } from '../typeAliases';
+import type { string_markdown } from '../typeAliases';
+import type { string_markdown_text } from '../typeAliases';
+import type { string_model_name } from '../typeAliases';
+import type { string_name } from '../typeAliases';
+/**
+ * Defines one piece of knowledge in the pipeline
+ *
+ * Note: Knowledge piece is by definition prepared
+ *
+ * @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: Array<{
+        /**
+         * 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: Array<string_keyword>;
+    /**
+     * List of models embeddings that are associated with the knowledge piece
+     */
+    readonly index: Array<{
+        /**
+         * 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: Array<number_id>;
+};

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

@@ -0,0 +1,24 @@
+import type { number_id } from '../typeAliases';
+import type { string_knowledge_source } from '../typeAliases';
+import type { string_name } from '../typeAliases';
+/**
+ * Defines one source of knowledge in the pipeline
+ * For example, a source of information, a fact, a quote, a definition, website, etc.
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/41
+ */
+export type KnowledgeSourceJson = {
+    readonly name: string_name;
+    readonly source: string_knowledge_source;
+};
+/**
+ * Defines one source of knowledge in the pipeline after it has been prepared
+ *
+ * @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: Array<number_id>;
+};

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

@@ -1,10 +1,15 @@
 import type { ModelRequirements } from '../ModelRequirements';
+import type { string_name } from '../typeAliases';
 import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
 /**
  * Template for prompt to LLM
  */
 export type LlmTemplateJson = PromptTemplateJsonCommon & {
     readonly blockType: 'PROMPT_TEMPLATE';
+    /**
+     * Name of the persona who will be responding to this prompt
+     */
+    readonly personaName: string_name | null;
     /**
      * Requirements for the model
      * - This is required only for blockType PROMPT_TEMPLATE
@@ -12,5 +17,7 @@ export type LlmTemplateJson = PromptTemplateJsonCommon & {
     readonly modelRequirements: ModelRequirements;
 };
 /**
- * TODO: [👙][🧠] Just selecting gpt3 or gpt4 level of modelT
+ * TODO: [👙][🧠] Maybe add `knowledge`, `actions` and `instruments` to be available granularly for each template
+ *       @see https://github.com/webgptorg/promptbook/discussions/79
+ * TODO: [💕][🧠] Just selecting gpt3 or gpt4 level of model
  */

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

@@ -0,0 +1,40 @@
+import type { ModelRequirements } from '../ModelRequirements';
+import type { number_id } from '../typeAliases';
+import type { string_name } from '../typeAliases';
+import type { string_persona_description } from '../typeAliases';
+/**
+ * Defines a persona in the pipeline
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/22
+ */
+export type PersonaJson = {
+    /**
+     * Name of the template
+     * - It must be unique across the pipeline
+     * - It should start uppercase and can contain letters and numbers
+     */
+    readonly name: string_name;
+    /**
+     * Description of persona
+     */
+    readonly description: string_persona_description;
+};
+/**
+ * Defines a persona in the pipeline after it has been prepared
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/22
+ */
+export type PersonaPreparedJson = PersonaJson & {
+    /**
+     * Model requirements for the persona
+     *
+     * Note: The model must be CHAT variant to be usable through persona
+     */
+    readonly modelRequirements: ModelRequirements & {
+        readonly modelVariant: 'CHAT';
+    };
+    /**
+     * List of preparation ids that were used to prepare this persona
+     */
+    readonly preparationIds: Array<number_id>;
+};

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,8 +55,28 @@ 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

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

@@ -0,0 +1,25 @@
+import type { PromptResultUsage } from '../../execution/PromptResult';
+import type { string_promptbook_version } from '../../version';
+import type { number_id } from '../typeAliases';
+import type { string_date_iso8601 } from '../typeAliases';
+export type PreparationJson = {
+    /**
+     * Incremental ID of the preparation
+     */
+    readonly id: number_id;
+    /**
+     * Date and time of the preparation
+     */
+    readonly date: string_date_iso8601;
+    /**
+     * 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`
+ */

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'];

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

@@ -80,6 +80,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 +445,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
  */
@@ -462,19 +487,8 @@ 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
  */

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.d.ts

@@ -6,11 +6,11 @@ export type CodeBlock = {
     /**
      * 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.

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

package/umd/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
- */