@promptbook/openai 0.61.0-9 → 0.61.0

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

@@ -0,0 +1,27 @@
+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>;
+};
+/**
+ * TODO: [🍙] Make some standart order of json properties
+ */

package/esm/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;
     /**
      * Requirements for the model
      * - This is required only for blockType PROMPT_TEMPLATE
@@ -12,5 +17,9 @@ export type LlmTemplateJson = PromptTemplateJsonCommon & {
     readonly modelRequirements: ModelRequirements;
 };
 /**
- * TODO: [👙][🧠] Just selecting gpt3 or gpt4 level of modelT
+ * TODO: [🧠][🥜]
+ * 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
+ * TODO: [🍙] Make some standart order of json properties
  */

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

@@ -0,0 +1,41 @@
+import type { ChatModelRequirements } 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: ChatModelRequirements;
+    /**
+     * List of preparation ids that were used to prepare this persona
+     */
+    readonly preparationIds: Array<number_id>;
+};
+/**
+ * TODO: [🍙] Make some standart order of json properties
+ */

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

@@ -2,14 +2,19 @@ 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';
 /**
  * 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 PipelineJson = {
     /**
@@ -50,12 +55,33 @@ 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
+ * TODO: [🍙] Make some standart order of json properties
+ * TODO: [🧠] Maybe wrap all {parameterNames} in brackets for example { "resultingParameterName": "{foo}" }
+ * 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/esm/typings/src/types/PipelineJson/PreparationJson.d.ts

@@ -0,0 +1,22 @@
+import type { PromptResultUsage } from '../../execution/PromptResultUsage';
+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: [🍙] Make some standart order of json properties
+ * 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/esm/typings/src/types/PipelineJson/PromptDialogJson.d.ts

@@ -1,7 +1,13 @@
 import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
 /**
  * Template for prompt to user
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/76
  */
-export interface PromptDialogJson extends PromptTemplateJsonCommon {
+export type PromptDialogJson = PromptTemplateJsonCommon & {
     readonly blockType: 'PROMPT_DIALOG';
-}
+};
+/**
+ * TODO: [🧠][🥜]
+ * TODO: [🍙] Make some standart order of json properties
+ */

package/esm/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';
@@ -7,3 +7,7 @@ import type { SimpleTemplateJson } from './SimpleTemplateJson';
  * Describes one prompt template in the promptbook
  */
 export type PromptTemplateJson = LlmTemplateJson | SimpleTemplateJson | ScriptJson | PromptDialogJson | ___ | ___ | ___ | ___;
+/**
+ * TODO: [🧠][🥜] What is propper name for this - "Template", "Prompt template",...
+ * TODO: [🧠][🥜] Reduce confusion of `PromptTemplateJson` vs (`LlmTemplateJson` which is 'PROMPT_TEMPLATE')
+ */

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
@@ -46,24 +49,38 @@ export interface PromptTemplateJsonCommon {
     readonly blockType: BlockType;
     /**
      * Content of the template 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 vs preparedContent
+     *
+     * @default "{content}"
+     */
+    readonly preparedContent?: (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 +90,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,13 @@ 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
+ * TODO: [🍙] Make some standart order of json properties
+ */

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

@@ -2,8 +2,10 @@ 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 {
+export type ScriptJson = PromptTemplateJsonCommon & {
     readonly blockType: 'SCRIPT';
     /**
      * Language of the script
@@ -11,4 +13,7 @@ export interface ScriptJson extends PromptTemplateJsonCommon {
      *
      */
     readonly contentLanguage?: ScriptLanguage;
-}
+};
+/**
+ * TODO: [🍙] Make some standart order of json properties
+ */

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

@@ -1,7 +1,12 @@
 import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
 /**
  * Template for simple concatenation of strings
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/17
  */
-export interface SimpleTemplateJson extends PromptTemplateJsonCommon {
+export type SimpleTemplateJson = PromptTemplateJsonCommon & {
     readonly blockType: 'SIMPLE_TEMPLATE';
-}
+};
+/**
+ * TODO: [🍙] Make some standart order of json properties
+ */

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