@promptbook/node 0.57.2 → 0.59.0-0

package/umd/typings/types/PromptbookJson/KnowledgeJson.d.ts

@@ -0,0 +1,6 @@
+import type { MaterialKnowledgePieceJson } from './MaterialKnowledgePieceJson';
+export type KnowledgeJson = Array<MaterialKnowledgePieceJson>;
+/**
+ * !!!! Annotate
+ * TODO: [🦪]
+ */

package/umd/typings/types/PromptbookJson/MaterialKnowledgePieceJson.d.ts

@@ -0,0 +1,27 @@
+import { IVectorData } from 'xyzt';
+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: IVectorData;
+    }>;
+    readonly sources: Array<{
+        title: string_markdown_text;
+        href: string_href;
+    }>;
+};
+/**
+ * !!!! Annotate
+ * TODO: [🧠][🦪] Maybe allow internal linkes 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/types/PromptbookJson/PromptbookJson.d.ts

@@ -1,6 +1,7 @@
 import type { string_markdown_text } from '../typeAliases';
 import type { string_promptbook_url } from '../typeAliases';
 import type { string_version } from '../typeAliases';
+import type { KnowledgeJson } from './KnowledgeJson';
 import type { PromptTemplateJson } from './PromptTemplateJson';
 import type { PromptTemplateParameterJson } from './PromptTemplateParameterJson';
 /**
@@ -42,12 +43,13 @@ export type PromptbookJson = {
      * Sequence of prompt templates that are chained together to form a pipeline
      */
     readonly promptTemplates: Array<PromptTemplateJson>;
+    /**
+     * Set of information that are used as external knowledge in the pipeline
+     */
+    readonly knowledge: KnowledgeJson;
 };
 /**
- * TODO: [🧠] Best format of this code?
- *             There must be possible to make
- *             - Branching
- *             - Loops
- *             - Paralelization
- *             - ...and more
+ * 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 library just as a collection of promptbooks
  */

package/esm/typings/execution/plugins/script-execution-tools/python/PythonExecutionTools.d.ts

@@ -1,16 +0,0 @@
-import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
-import type { ScriptExecutionTools } from '../../../ScriptExecutionTools';
-import type { ScriptExecutionToolsExecuteOptions } from '../../../ScriptExecutionTools';
-/**
- * ScriptExecutionTools for Python
- *
- * Warning: This is not implemented yet
- */
-export declare class PythonExecutionTools implements ScriptExecutionTools {
-    private readonly options;
-    constructor(options: CommonExecutionToolsOptions);
-    /**
-     * Executes a Python
-     */
-    execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
-}

package/esm/typings/execution/plugins/script-execution-tools/typescript/TypescriptExecutionTools.d.ts

@@ -1,16 +0,0 @@
-import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
-import type { ScriptExecutionTools } from '../../../ScriptExecutionTools';
-import type { ScriptExecutionToolsExecuteOptions } from '../../../ScriptExecutionTools';
-/**
- * ScriptExecutionTools for TypeScript
- *
- * Warning: This is not implemented yet
- */
-export declare class TypescriptExecutionTools implements ScriptExecutionTools {
-    private readonly options;
-    constructor(options: CommonExecutionToolsOptions);
-    /**
-     * Executes a TypeScript
-     */
-    execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
-}

package/umd/typings/execution/plugins/script-execution-tools/python/PythonExecutionTools.d.ts

@@ -1,16 +0,0 @@
-import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
-import type { ScriptExecutionTools } from '../../../ScriptExecutionTools';
-import type { ScriptExecutionToolsExecuteOptions } from '../../../ScriptExecutionTools';
-/**
- * ScriptExecutionTools for Python
- *
- * Warning: This is not implemented yet
- */
-export declare class PythonExecutionTools implements ScriptExecutionTools {
-    private readonly options;
-    constructor(options: CommonExecutionToolsOptions);
-    /**
-     * Executes a Python
-     */
-    execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
-}

package/umd/typings/execution/plugins/script-execution-tools/typescript/TypescriptExecutionTools.d.ts

@@ -1,16 +0,0 @@
-import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
-import type { ScriptExecutionTools } from '../../../ScriptExecutionTools';
-import type { ScriptExecutionToolsExecuteOptions } from '../../../ScriptExecutionTools';
-/**
- * ScriptExecutionTools for TypeScript
- *
- * Warning: This is not implemented yet
- */
-export declare class TypescriptExecutionTools implements ScriptExecutionTools {
-    private readonly options;
-    constructor(options: CommonExecutionToolsOptions);
-    /**
-     * Executes a TypeScript
-     */
-    execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
-}