@promptbook/openai 0.61.0-0 → 0.61.0-10

package/umd/typings/src/conversion/validation/_importPipeline.d.ts

@@ -9,5 +9,5 @@ import type { PipelineString } from '../../types/PipelineString';
  * @param path - The path to the file relative to samples/templates directory
  * @private
  */
-export declare function importPipeline(path: `${string}.ptbk.md`): PipelineString;
-export declare function importPipeline(path: `${string}.ptbk.json`): PipelineJson;
+export declare function importPipelineWithoutPreparation(path: `${string}.ptbk.md`): PipelineString;
+export declare function importPipelineWithoutPreparation(path: `${string}.ptbk.json`): PipelineJson;

package/umd/typings/src/errors/VersionMismatch.d.ts

@@ -0,0 +1,8 @@
+import type { string_semantic_version } from '../types/typeAliases';
+/**
+ * This error type indicates that the version of the pipeline is not matching the expected version
+ */
+export declare class VersionMismatch extends Error {
+    readonly name = "UnexpectedError";
+    constructor(message: string, expectedVersion: string_semantic_version);
+}

package/umd/typings/src/execution/PipelineExecutor.d.ts

@@ -16,25 +16,25 @@ export type PipelineExecutor = {
         /**
          * Whether the execution was successful, details are aviable in `executionReport`
          */
-        isSuccessful: boolean;
+        readonly isSuccessful: boolean;
         /**
          * Added usage of whole execution, detailed usage is aviable in `executionReport`
          */
-        usage: PromptResultUsage;
+        readonly usage: PromptResultUsage;
         /**
          * Errors that occured during the execution, details are aviable in `executionReport`
          */
-        errors: Array<Error>;
+        readonly errors: Array<Error>;
         /**
          * The report of the execution with all details
          */
-        executionReport: ExecutionReportJson;
+        readonly executionReport: ExecutionReportJson;
         /**
          * Result parameters of the execution
          *
          * Note: If the execution was not successful, there are only some of the result parameters
          */
-        outputParameters: Record<string_name, string>;
+        readonly outputParameters: Record<string_name, string>;
     }>;
 };
 /**

package/umd/typings/src/execution/PromptResult.d.ts

@@ -47,15 +47,15 @@ export type PromptCommonResult = {
         /**
          * Start of the execution
          */
-        start: string_date_iso8601;
+        readonly start: string_date_iso8601;
         /**
          * First token generated
          */
-        firstToken?: string_date_iso8601;
+        readonly firstToken?: string_date_iso8601;
         /**
          * End of the execution
          */
-        complete: string_date_iso8601;
+        readonly complete: string_date_iso8601;
     };
     /**
      * Usage of the prompt execution
@@ -99,11 +99,11 @@ export type UncertainNumber = {
     /**
      * The numeric value
      */
-    value: number_usd & (number_positive | 0);
+    readonly value: number_usd & (number_positive | 0);
     /**
      * Is the value uncertain
      */
-    isUncertain?: true;
+    readonly isUncertain?: true;
 };
 /**
  * TODO: [🧠] Maybe timing more accurate then seconds?

package/umd/typings/src/execution/ScriptExecutionTools.d.ts

@@ -16,13 +16,13 @@ export type ScriptExecutionToolsExecuteOptions = {
     /**
      * Language of the script
      */
-    scriptLanguage: ScriptLanguage;
+    readonly scriptLanguage: ScriptLanguage;
     /**
      * Parameters for the script
      * Theese parameters are passed to the script as variables
      * For example: { "name": "John" } => const name = "John";
      */
-    parameters: Record<string_name, string>;
+    readonly parameters: Record<string_name, string>;
     /**
      * The content of the script to execute
      * - It can be a single statement
@@ -31,7 +31,7 @@ export type ScriptExecutionToolsExecuteOptions = {
      * - It can be IIFE (immediately invoked function expression)
      * - It can use the parameters as variables and functions from global scope
      */
-    script: string_script;
+    readonly script: string_script;
 };
 /**
  * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute

package/umd/typings/src/execution/UserInterfaceTools.d.ts

@@ -21,26 +21,26 @@ export type UserInterfaceToolsPromptDialogOptions = {
      * Note: This is not a prompt to language model but a prompt to the user
      * @example "Your name"
      */
-    promptTitle: string;
+    readonly promptTitle: string;
     /**
      * Prompt message
      *
      * Note: This is not a prompt to language model but a prompt to the user
      * @example "Please enter your name, including your last name, title, etc."
      */
-    promptMessage: string;
+    readonly promptMessage: string;
     /**
      * Default value for the input/textarea
      */
-    defaultValue: string | null;
+    readonly defaultValue: string | null;
     /**
      * Placeholder for the input/textarea
      */
-    placeholder?: string;
+    readonly placeholder?: string;
     /**
      * Priority of the prompt
      *
      * Note: This would be reflected for example into the UI z-index of the prompt modal
      */
-    priority: number_integer & number_positive;
+    readonly priority: number_integer & number_positive;
 };

package/umd/typings/src/execution/createPipelineExecutor.d.ts

@@ -10,7 +10,7 @@ type CreatePipelineExecutorSettings = {
     readonly maxExecutionAttempts: number;
 };
 /**
- * Options for creating a pipeline executor
+ * Options for `createPipelineExecutor`
  */
 interface CreatePipelineExecutorOptions {
     /**
@@ -35,6 +35,7 @@ interface CreatePipelineExecutorOptions {
 export declare function createPipelineExecutor(options: CreatePipelineExecutorOptions): PipelineExecutor;
 export {};
 /**
+ * TODO: [🪂] Pass maxParallelCount here
  * TODO: [🧠] When not meet expectations in PROMPT_DIALOG, make some way to tell the user
  * TODO: [👧] Strongly type the executors to avoid need of remove nullables whtn noUncheckedIndexedAccess in tsconfig.json
  * Note: CreatePipelineExecutorOptions are just connected to PipelineExecutor so do not extract to types folder

package/umd/typings/src/execution/translation/automatic-translate/automatic-translators/TranslatorOptions.d.ts

@@ -1,4 +1,4 @@
 export type TranslatorOptions = {
-    from?: string;
-    to: string;
+    readonly from?: string;
+    readonly to: string;
 };

package/umd/typings/src/execution/utils/forEachAsync.d.ts

@@ -5,7 +5,7 @@ type ForEachAsyncOptions = {
      *
      * @default Infinity
      */
-    inParallelCount?: number;
+    readonly maxParallelCount?: number;
 };
 /**
  * Async version of Array.forEach

package/umd/typings/src/formats/csv/ListFormatDefinition.d.ts

@@ -8,4 +8,4 @@ export declare const CsvFormatDefinition: FormatDefinition<string, string, objec
  * TODO: [🍓] In `CsvFormatDefinition` implement partial `canBeValid`
  * TODO: [🍓] In `CsvFormatDefinition` implement `heal
  * TODO: [🍓] In `CsvFormatDefinition` implement `extractValues`
- */ 
+ */

package/umd/typings/src/formats/json/JsonFormatDefinition.d.ts

@@ -12,4 +12,4 @@ export declare const JsonFormatDefinition: FormatDefinition<string, string, obje
  * TODO: [🍓] In `JsonFormatDefinition` implement partial `canBeValid`
  * TODO: [🍓] In `JsonFormatDefinition` implement `heal
  * TODO: [🍓] In `JsonFormatDefinition` implement `extractValues`
- */ 
+ */

package/umd/typings/src/formats/list/ListFormatDefinition.d.ts

@@ -10,4 +10,4 @@ export declare const ListFormatDefinition: FormatDefinition<string, string, obje
  * TODO: [🍓] In `ListFormatDefinition` implement partial `canBeValid`
  * TODO: [🍓] In `ListFormatDefinition` implement `heal
  * TODO: [🍓] In `ListFormatDefinition` implement `extractValues`
- */ 
+ */

package/umd/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/umd/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/umd/typings/src/knowledge/prepare-knowledge/_common/prepareKnowledgePieces.test.d.ts

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

package/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/typings/src/personas/preparePersona.test.d.ts

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

package/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/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>;
+};