@promptbook/openai 0.61.0-1 → 0.61.0-10

package/esm/typings/src/knowledge/dialogs/callback/CallbackInterfaceToolsOptions.d.ts

@@ -2,7 +2,7 @@ import type { Promisable } from 'type-fest';
 import type { CommonExecutionToolsOptions } from '../../../execution/CommonExecutionToolsOptions';
 import type { UserInterfaceToolsPromptDialogOptions } from '../../../execution/UserInterfaceTools';
 /**
- * Options for CallbackInterfaceTools
+ * Options for `CallbackInterfaceTools`
  */
 export type CallbackInterfaceToolsOptions = CommonExecutionToolsOptions & {
     /**

package/esm/typings/src/knowledge/prepare-knowledge/_common/prepareKnowledgePieces.d.ts

@@ -0,0 +1,18 @@
+import type { PrepareOptions } from '../../../prepare/PrepareOptions';
+import type { KnowledgePiecePreparedJson } from '../../../types/PipelineJson/KnowledgePieceJson';
+import type { KnowledgeSourceJson } from '../../../types/PipelineJson/KnowledgeSourceJson';
+/**
+ * Prepares the knowle
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/41
+ * @private within the package
+ */
+export declare function prepareKnowledgePieces(knowledgeSources: Array<KnowledgeSourceJson>, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'preparationIds'>>>;
+/**
+ * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
+ *       Put `knowledgePieces` into `PrepareKnowledgeOptions`
+ * TODO: [🪂] More than max things can run in parallel by acident [1,[2a,2b,_],[3a,3b,_]]
+ * TODO: [🧠][❎] Do here propper M:N mapping
+ *       [x] One source can make multiple pieces
+ *       [ ] One piece can have multiple sources
+ */

package/esm/typings/src/knowledge/prepare-knowledge/_common/prepareKnowledgePieces.test.d.ts

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

package/esm/typings/src/knowledge/prepare-knowledge/_common/utils/getLlmToolsForTests.d.ts

@@ -0,0 +1,7 @@
+import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
+/**
+ * Returns LLM tools for testing purposes
+ *
+ * @private within the package - JUST FOR TESTS
+ */
+export declare function getLlmToolsForTests(): LlmExecutionTools;

package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts

@@ -1,26 +1,11 @@
-import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
-import type { KnowledgeJson } from '../../../types/PipelineJson/KnowledgeJson';
+import type { PrepareOptions } from '../../../prepare/PrepareOptions';
+import type { KnowledgePiecePreparedJson } from '../../../types/PipelineJson/KnowledgePieceJson';
 import type { string_markdown } from '../../../types/typeAliases';
-type PrepareKnowledgeFromMarkdownOptions = {
-    /**
-     * The source of the knowledge in markdown format
-     */
-    content: string_markdown;
-    /**
-     * The LLM tools to use for the conversion and extraction of knowledge
-     *
-     * Note: If you want to use multiple LLMs, you can use `joinLlmExecutionTools` to join them first
-     */
-    llmTools: LlmExecutionTools;
-    /**
-     * If true, the preaparation of knowledge logs additional information
-     *
-     * @default false
-     */
-    isVerbose?: boolean;
-};
-export declare function prepareKnowledgeFromMarkdown(options: PrepareKnowledgeFromMarkdownOptions): Promise<KnowledgeJson>;
-export {};
 /**
- * 11:11
+ * @@@
+ */
+export declare function prepareKnowledgeFromMarkdown(content: string_markdown, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
+/**
+ * TODO: [🪂] Do it in parallel 11:11
+ * Note: No need to aggregate usage here, it is done by intercepting the llmTools
  */

package/esm/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts

@@ -1,19 +1,12 @@
-import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
-import type { KnowledgeJson } from '../../../types/PipelineJson/KnowledgeJson';
+import type { PrepareOptions } from '../../../prepare/PrepareOptions';
+import type { KnowledgePiecePreparedJson } from '../../../types/PipelineJson/KnowledgePieceJson';
 import type { string_base64 } from '../../../types/typeAliases';
-type PrepareKnowledgeFromPdfOptions = {
-    /**
-     * The source of the knowledge in PDF format
-     */
-    content: string_base64;
-    /**
-     * The LLM tools to use for the conversion and extraction of knowledge
-     */
-    llmTools: LlmExecutionTools;
-};
-export declare function prepareKnowledgeFromPdf(options: PrepareKnowledgeFromPdfOptions): Promise<KnowledgeJson>;
-export {};
+/**
+ * @@@
+ */
+export declare function prepareKnowledgeFromPdf(content: string_base64, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
 /**
  * TODO: [🧺] In future, content can be alse File or Blob BUT for now for wider compatibility its only base64
  *       @see https://stackoverflow.com/questions/14653349/node-js-cant-create-blobs
+ * TODO: [🪂] Do it in parallel
  */

package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts

@@ -1,7 +1,7 @@
 import type { ClientOptions } from '@anthropic-ai/sdk';
 import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
 /**
- * Options for AnthropicClaudeExecutionTools
+ * Options for `AnthropicClaudeExecutionTools`
  *
  * This extends Anthropic's `ClientOptions` with are directly passed to the Anthropic client.
  */

package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts

@@ -9,8 +9,8 @@ import type { number_usd } from '../../types/typeAliases';
  */
 export declare const ANTHROPIC_CLAUDE_MODELS: Array<AvailableModel & {
     pricing?: {
-        prompt: number_usd;
-        output: number_usd;
+        readonly prompt: number_usd;
+        readonly output: number_usd;
     };
 }>;
 /**

package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts

@@ -2,7 +2,7 @@ import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutio
 import type { string_name } from '../../types/typeAliases';
 import type { string_token } from '../../types/typeAliases';
 /**
- * Options for AzureOpenAiExecutionTools
+ * Options for `AzureOpenAiExecutionTools`
  *
  * @see https://oai.azure.com/portal/
  */
@@ -12,7 +12,7 @@ export type AzureOpenAiExecutionToolsOptions = CommonExecutionToolsOptions & {
      *
      * Note: Typically you have one resource and multiple deployments.
      */
-    resourceName: string_name;
+    readonly resourceName: string_name;
     /**
      * The deployment name
      *
@@ -20,16 +20,16 @@ export type AzureOpenAiExecutionToolsOptions = CommonExecutionToolsOptions & {
      * Note: This is kind of a modelName in OpenAI terms
      * Note: Typically you have one resource and multiple deployments.
      */
-    deploymentName: string_name;
+    readonly deploymentName: string_name;
     /**
      * The API key of the Azure OpenAI resource
      */
-    apiKey: string_token;
+    readonly apiKey: string_token;
     /**
      * A unique identifier representing your end-user, which can help Azure OpenAI to monitor
      * and detect abuse.
      *
      * @see https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids (document from OpenAI not Azure, but same concept)
      */
-    user?: string_token;
+    readonly user?: string_token;
 };

package/esm/typings/src/llm-providers/openai/OpenAiExecutionToolsOptions.d.ts

@@ -2,7 +2,7 @@ import type { ClientOptions } from 'openai';
 import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
 import type { string_token } from '../../types/typeAliases';
 /**
- * Options for OpenAiExecutionTools
+ * Options for `OpenAiExecutionTools`
  *
  * This extends OpenAI's `ClientOptions` with are directly passed to the OpenAI client.
  * Rest is used by the `OpenAiExecutionTools`.

package/esm/typings/src/llm-providers/openai/openai-models.d.ts

@@ -10,8 +10,8 @@ import type { number_usd } from '../../types/typeAliases';
  */
 export declare const OPENAI_MODELS: Array<AvailableModel & {
     pricing?: {
-        prompt: number_usd;
-        output: number_usd;
+        readonly prompt: number_usd;
+        readonly output: number_usd;
     };
 }>;
 /**

package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionToolsOptions.d.ts

@@ -2,7 +2,7 @@ import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutio
 import type { client_id } from '../../types/typeAliases';
 import type { string_uri } from '../../types/typeAliases';
 /**
- * Options for RemoteLlmExecutionTools
+ * Options for `RemoteLlmExecutionTools`
  */
 export type RemoteLlmExecutionToolsOptions = CommonExecutionToolsOptions & {
     /**

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

@@ -0,0 +1,13 @@
+import type { PrepareOptions } from '../prepare/PrepareOptions';
+import type { PersonaPreparedJson } from '../types/PipelineJson/PersonaJson';
+import type { string_persona_description } from '../types/typeAliases';
+/**
+ * Prepares the persona for the pipeline
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/22
+ * @private within the package
+ */
+export declare function preparePersona(personaDescription: string_persona_description, options: PrepareOptions): Promise<PersonaPreparedJson['modelRequirements']>;
+/**
+ * TODO: [🪂] Do it in parallel
+ */

package/esm/typings/src/personas/preparePersona.test.d.ts

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

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

@@ -0,0 +1,22 @@
+import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
+/**
+ * Options for preparation of the pipeline
+ */
+export type PrepareOptions = {
+    /**
+     * LLM tools
+     */
+    readonly llmTools: LlmExecutionTools;
+    /**
+     * Maximum number of tasks running in parallel
+     *
+     * @default MAX_PARALLEL_COUNT
+     */
+    readonly maxParallelCount?: number;
+    /**
+     * If true, the preparation logs additional information
+     *
+     * @default false
+     */
+    readonly isVerbose?: boolean;
+};

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

@@ -0,0 +1,15 @@
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import type { PrepareOptions } from './PrepareOptions';
+/**
+ * Prepare pipeline from string (markdown) format to JSON format
+ *
+ * Note: This function does not validate logic of the pipeline
+ * Note: This function acts as part of compilation process
+ */
+export declare function preparePipeline(pipeline: PipelineJson, options: PrepareOptions): Promise<PipelineJson>;
+/**
+ * TODO: Write tests for `preparePipeline`
+ * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
+ * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
+ * TODO: [💸] Make utilities `interceptLlmTools` and `costLlmTools` to compute cost and DO put this counting logic in `prepareKnowledge` or `preparePersona`
+ */

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

@@ -0,0 +1,8 @@
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+/**
+ * Unprepare just strips the preparation data of the pipeline
+ */
+export declare function unpreparePipeline(pipeline: PipelineJson): PipelineJson;
+/**
+ * TODO: Write tests for `preparePipeline`
+ */

package/esm/typings/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts

@@ -2,7 +2,7 @@ import type { Promisable } from 'type-fest';
 import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
 import type { string_javascript_name } from '../../types/typeAliases';
 /**
- * Options for javascript execution
+ * Options for `JavascriptExecutionTools`
  */
 export type JavascriptExecutionToolsOptions = CommonExecutionToolsOptions & {
     /**

package/esm/typings/src/scripting/javascript/utils/preserve.d.ts

@@ -1,4 +1,4 @@
-import type { really_any } from '../../../types/typeAliases';
+import type { really_any } from '../../../utils/organization/really_any';
 /**
  * Does nothing, but preserves the function in the bundle
  * Compiler is tricked into thinking the function is used

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

@@ -37,7 +37,8 @@ export type ModelRequirements = {
     readonly maxTokens?: number;
 };
 /**
+ * TODO: !!!!! Add and use systemMessage, temprerature, top_k, top_p, presencePenalty, frequencyPenalty, bestOf, n, logitBias, logitBiasType, stop, ... to ModelRequirements
  * TODO: Maybe figure out better word than "variant"
  * TODO: Add here more requirement options like max context size, max tokens, etc.
- * TODO: [👙][🧠] Just selecting gpt3 or gpt4 level of model
+ * TODO: [💕][🧠] Just selecting gpt3 or gpt4 level of model
  */

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

@@ -10,5 +10,6 @@
  */
 export type Parameters = object;
 /**
+ * TODO: !!!!! Implement samples into parameters
  * TODO: Constrain type to Simple key-value object, only string keys and string values and no index signature + only camelCase keys and spaceTrimmed values
  */

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

@@ -6,21 +6,25 @@ import type { number_positive } from '../typeAliases';
  * For example 5 words, 3 sentences, 2 paragraphs, ...
  *
  * Note: Expectations are performed after all postprocessing steps
+ * @see https://github.com/webgptorg/promptbook/discussions/30
  */
 export type Expectations = Partial<Record<Lowercase<ExpectationUnit>, {
-    min?: ExpectationAmount;
-    max?: ExpectationAmount;
+    readonly min?: ExpectationAmount;
+    readonly max?: ExpectationAmount;
 }>>;
 /**
  * Units of text measurement
+ * @see https://github.com/webgptorg/promptbook/discussions/30
  */
 export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTENCES", "LINES", "PARAGRAPHS", "PAGES"];
 /**
  * Unit of text measurement
+ * @see https://github.com/webgptorg/promptbook/discussions/30
  */
 export type ExpectationUnit = typeof EXPECTATION_UNITS[number];
 /**
  * Amount of text measurement
+ * @see https://github.com/webgptorg/promptbook/discussions/30
  */
 export type ExpectationAmount = number_integer & (number_positive | 0);
 /**

package/esm/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/esm/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/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 | 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/esm/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/esm/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/esm/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/esm/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/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';

package/esm/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/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';