@promptbook/core 0.59.0-20 → 0.59.0-21

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

@@ -1,7 +1,21 @@
 import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
 import type { KnowledgeJson } from '../../../types/PromptbookJson/KnowledgeJson';
 import type { string_markdown } from '../../../types/typeAliases';
-export declare function prepareKnowledgeFromMarkdown(options: {
+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
+     */
     llmTools: LlmExecutionTools;
-}): Promise<KnowledgeJson>;
+    /**
+     * If true, the preaparation of knowledge logs additional information
+     *
+     * @default false
+     */
+    isVerbose?: boolean;
+};
+export declare function prepareKnowledgeFromMarkdown(options: PrepareKnowledgeFromMarkdownOptions): Promise<KnowledgeJson>;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/core",
-    "version": "0.59.0-20",
+    "version": "0.59.0-21",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,

package/umd/index.umd.js

@@ -206,7 +206,7 @@
         return PromptbookSyntaxError;
     }(Error));
 
-    var promptbookLibrary = [{title:"Prepare Knowledge from Markdown",promptbookUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md",promptbookVersion:"0.59.0-22",parameters:[{name:"content",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledge",description:"The knowledge JSON object",isInput:false,isOutput:true}],promptTemplates:[{name:"knowledge",title:"Knowledge",dependentParameterNames:["content"],executionType:"PROMPT_TEMPLATE",modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},content:"You are experienced data researcher, extract the important knowledge from the document.\n\n# Rules\n\n-   Make pieces of information concise, clear, and easy to understand\n-   One piece of information should be approximately 1 paragraph\n-   Divide the paragraphs by markdown horizontal lines ---\n-   Omit irrelevant information\n-   Group redundant information\n-   Write just extracted information, nothing else\n\n# The document\n\nTake information from this document:\n\n> {content}",resultingParameterName:"knowledge"}],knowledge:[]}];
+    var promptbookLibrary = [{title:"Prepare Knowledge from Markdown",promptbookUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md",promptbookVersion:"0.59.0-20",parameters:[{name:"content",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledge",description:"The knowledge JSON object",isInput:false,isOutput:true}],promptTemplates:[{name:"knowledge",title:"Knowledge",dependentParameterNames:["content"],executionType:"PROMPT_TEMPLATE",modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},content:"You are experienced data researcher, extract the important knowledge from the document.\n\n# Rules\n\n-   Make pieces of information concise, clear, and easy to understand\n-   One piece of information should be approximately 1 paragraph\n-   Divide the paragraphs by markdown horizontal lines ---\n-   Omit irrelevant information\n-   Group redundant information\n-   Write just extracted information, nothing else\n\n# The document\n\nTake information from this document:\n\n> {content}",resultingParameterName:"knowledge"}],knowledge:[]}];
 
     /**
      * This error indicates errors during the execution of the promptbook
@@ -531,7 +531,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.59.0-22';
+    var PROMPTBOOK_VERSION = '0.59.0-20';
 
     /**
      * Function `addUsage` will add multiple usages into one
@@ -2051,15 +2051,15 @@
 
     function prepareKnowledgeFromMarkdown(options) {
         return __awaiter(this, void 0, void 0, function () {
-            var content, llmTools, library, promptbook, executor, result, outputParameters, knowledgeRaw, knowledgeTextPieces, knowledge;
+            var content, llmTools, _a, isVerbose, library, promptbook, executor, result, outputParameters, knowledgeRaw, knowledgeTextPieces, knowledge;
             var _this = this;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
-                        content = options.content, llmTools = options.llmTools;
+                        content = options.content, llmTools = options.llmTools, _a = options.isVerbose, isVerbose = _a === void 0 ? false : _a;
                         return [4 /*yield*/, createPromptbookLibraryFromSources.apply(void 0, __spreadArray([], __read(promptbookLibrary), false))];
                     case 1:
-                        library = _a.sent();
+                        library = _b.sent();
                         promptbook = library.getPromptbookByUrl('https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md');
                         executor = createPromptbookExecutor({
                             promptbook: promptbook,
@@ -2072,11 +2072,14 @@
                         });
                         return [4 /*yield*/, executor({ content: content })];
                     case 2:
-                        result = _a.sent();
+                        result = _b.sent();
                         assertsExecutionSuccessful(result);
                         outputParameters = result.outputParameters;
                         knowledgeRaw = outputParameters.knowledge;
                         knowledgeTextPieces = (knowledgeRaw || '').split('\n---\n');
+                        if (isVerbose) {
+                            console.info('knowledgeTextPieces:', knowledgeTextPieces);
+                        }
                         return [4 /*yield*/, Promise.all(knowledgeTextPieces.map(function (knowledgeTextPiece, i) { return __awaiter(_this, void 0, void 0, function () {
                                 var name, title, content, keywords, index, sources;
                                 return __generator(this, function (_a) {
@@ -2108,7 +2111,7 @@
                                 });
                             }); }))];
                     case 3:
-                        knowledge = _a.sent();
+                        knowledge = _b.sent();
                         return [2 /*return*/, knowledge];
                 }
             });