@promptbook/cli 0.59.0-29 → 0.59.0-30

package/README.md

@@ -34,6 +34,61 @@ npm i -g @promptbook/cli
 
 CLI utils for Promptbook. After install you can use `promptbook` command in terminal:
 
+## Make your Promptbook Library
+
+You can prebuild your own Promptbook library with `promptbook make` command:
+
+```bash
+npx promptbook make ./promptbook-library --format typescript --verbose
+```
+
+This will emit `index.ts` with `getPromptbookLibrary` function file in `promptbook-library` directory.
+
+Then just use it:
+
+```typescript
+import { createPromptbookExecutor, assertsExecutionSuccessful } from '@promptbook/core';
+import { getPromptbookLibrary } from './promptbook-library'; // <- Importing from pre-built library
+import { JavascriptExecutionTools } from '@promptbook/execute-javascript';
+import { OpenAiExecutionTools } from '@promptbook/openai';
+
+// ▶ Get one Promptbook
+const promptbook = await getPromptbookLibrary().getPromptbookByUrl(
+    `https://promptbook.studio/my-library/write-article.ptbk.md`,
+);
+
+// ▶ Prepare tools
+const tools = {
+    llm: new OpenAiExecutionTools({
+        isVerbose: true,
+        apiKey: process.env.OPENAI_API_KEY,
+    }),
+    script: [new JavascriptExecutionTools()],
+};
+
+// ▶ Create executor - the function that will execute the Promptbook
+const promptbookExecutor = createPromptbookExecutor({ promptbook, tools });
+
+// ▶ Prepare input parameters
+const inputParameters = { word: 'cat' };
+
+// 🚀▶ Execute the Promptbook
+const result = await promptbookExecutor(inputParameters);
+
+// ▶ Fail if the execution was not successful
+assertsExecutionSuccessful(result);
+
+// ▶ Handle the result
+const { isSuccessful, errors, outputParameters, executionReport } = result;
+console.info(outputParameters);
+```
+
+This is simmilar to compilation process, during the build time the `promptbook make` command will check promptbooks for errors, convert them to the more optimized format and build knowledge base (RAG) for the library.
+
+There is also a javascript and json format available.
+
+## Prettify
+
 ```bash
 npx promptbook prettify promptbook/**/*.ptbk.md
 ```

package/esm/index.es.js

@@ -143,7 +143,7 @@ new Function("\n    try {\n        if (typeof WorkerGlobalScope !== 'undefined'
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.59.0-28';
+var PROMPTBOOK_VERSION = '0.59.0-29';
 
 /**
  * Initializes testing `hello` command for Promptbook CLI utilities
@@ -182,7 +182,7 @@ var LOOP_LIMIT = 1000;
 /**
  * The name of the builded promptbook library made by CLI `promptbook make` and for lookup in `createLibraryFromDirectory`
  */
-var PROMPTBOOK_MAKED_BASE_FILENAME = "promptbook-library";
+var PROMPTBOOK_MAKED_BASE_FILENAME = "index";
 
 /**
  * This error indicates that the promptbook object has valid syntax but contains logical errors (like circular dependencies)
@@ -437,7 +437,7 @@ function validatePromptbook(promptbook) {
  *     >  ex port function validatePromptbook(promptbook: unknown): asserts promptbook is PromptbookJson {
  */
 
-var promptbookLibrary = [{title:"Prepare Knowledge from Markdown",promptbookUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md",promptbookVersion:"0.59.0-28",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 Keywords",promptbookUrl:"https://promptbook.studio/promptbook/prepare-keywords.ptbk.md",promptbookVersion:"0.59.0-29",parameters:[{name:"content",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",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, detect the important keywords in the document.\n\n# Rules\n\n-   Write just keywords separated by comma\n\n# The document\n\nTake information from this document:\n\n> {content}",resultingParameterName:"keywords"}],knowledge:[]},{title:"Prepare Knowledge from Markdown",promptbookUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md",promptbookVersion:"0.59.0-29",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
@@ -1996,7 +1996,7 @@ function normalizeToKebabCase(sentence) {
 
 function prepareKnowledgeFromMarkdown(options) {
     return __awaiter(this, void 0, void 0, function () {
-        var content, llmTools, _a, isVerbose, library, promptbook, executor, result, outputParameters, knowledgeRaw, knowledgeTextPieces, knowledge;
+        var content, llmTools, _a, isVerbose, library, prepareKnowledgeFromMarkdownPromptbook, prepareKnowledgeFromMarkdownExecutor, prepareKeywordsPromptbook, prepareKeywordsExecutor, result, outputParameters, knowledgeRaw, knowledgeTextPieces, knowledge;
         var _this = this;
         return __generator(this, function (_b) {
             switch (_b.label) {
@@ -2005,9 +2005,9 @@ function prepareKnowledgeFromMarkdown(options) {
                     library = createLibraryFromJson.apply(void 0, __spreadArray([], __read(promptbookLibrary), false));
                     return [4 /*yield*/, library.getPromptbookByUrl('https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md')];
                 case 1:
-                    promptbook = _b.sent();
-                    executor = createPromptbookExecutor({
-                        promptbook: promptbook,
+                    prepareKnowledgeFromMarkdownPromptbook = _b.sent();
+                    prepareKnowledgeFromMarkdownExecutor = createPromptbookExecutor({
+                        promptbook: prepareKnowledgeFromMarkdownPromptbook,
                         tools: {
                             llm: llmTools,
                             script: [
@@ -2015,8 +2015,20 @@ function prepareKnowledgeFromMarkdown(options) {
                             ],
                         },
                     });
-                    return [4 /*yield*/, executor({ content: content })];
+                    return [4 /*yield*/, library.getPromptbookByUrl('https://promptbook.studio/promptbook/prepare-keywords.ptbk.md')];
                 case 2:
+                    prepareKeywordsPromptbook = _b.sent();
+                    prepareKeywordsExecutor = createPromptbookExecutor({
+                        promptbook: prepareKeywordsPromptbook,
+                        tools: {
+                            llm: llmTools,
+                            script: [
+                            /* <- TODO: Allow to just keep script undefined */
+                            ],
+                        },
+                    });
+                    return [4 /*yield*/, prepareKnowledgeFromMarkdownExecutor({ content: content })];
+                case 3:
                     result = _b.sent();
                     assertsExecutionSuccessful(result);
                     outputParameters = result.outputParameters;
@@ -2026,36 +2038,57 @@ function prepareKnowledgeFromMarkdown(options) {
                         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) {
-                                name = "piece-".concat(i);
-                                title = spaceTrim(knowledgeTextPiece.substring(0, 100));
-                                content = spaceTrim(knowledgeTextPiece);
-                                keywords = [];
-                                index = [];
-                                sources = [];
-                                try {
-                                    // TODO: !!!! Summarize name and title from the content
-                                    title = spaceTrim(knowledgeTextPiece.substring(0, 30));
-                                    name = normalizeToKebabCase(title);
-                                    // TODO: !!!! Extract keywords via prompt
-                                    // TODO: !!!! Index through LLM model
-                                    // TODO: [🖖] !!!! Make system for sources and identification of sources
-                                }
-                                catch (error) {
-                                    console.error(error);
+                            var name, title, content, keywords, index, sources, result_1, _a, outputParameters_1, keywordsRaw, error_1;
+                            return __generator(this, function (_b) {
+                                switch (_b.label) {
+                                    case 0:
+                                        name = "piece-".concat(i);
+                                        title = spaceTrim(knowledgeTextPiece.substring(0, 100));
+                                        content = spaceTrim(knowledgeTextPiece);
+                                        keywords = [];
+                                        index = [];
+                                        sources = [];
+                                        _b.label = 1;
+                                    case 1:
+                                        _b.trys.push([1, 3, , 4]);
+                                        // TODO: !!!! Summarize name and title from the content
+                                        title = spaceTrim(knowledgeTextPiece.substring(0, 30));
+                                        name = normalizeToKebabCase(title);
+                                        return [4 /*yield*/, prepareKeywordsExecutor({ content: content })];
+                                    case 2:
+                                        result_1 = _b.sent();
+                                        _a = result_1.outputParameters, outputParameters_1 = _a === void 0 ? {} : _a;
+                                        keywordsRaw = outputParameters_1.keywords;
+                                        keywords = (keywordsRaw || '')
+                                            .split(',')
+                                            .map(function (keyword) { return keyword.trim(); })
+                                            .filter(function (keyword) { return keyword !== ''; });
+                                        if (isVerbose) {
+                                            console.info("Keywords for \"".concat(title, "\":"), keywords);
+                                        }
+                                        // ---
+                                        // TODO: !!!! Index through LLM model
+                                        index.push({
+                                            modelName: 'fake-model',
+                                            position: new Array(25).fill(0).map(function () { return Math.random() * 2 - 1; }),
+                                        });
+                                        return [3 /*break*/, 4];
+                                    case 3:
+                                        error_1 = _b.sent();
+                                        console.error(error_1);
+                                        return [3 /*break*/, 4];
+                                    case 4: return [2 /*return*/, {
+                                            name: name,
+                                            title: title,
+                                            content: content,
+                                            keywords: keywords,
+                                            index: index,
+                                            sources: sources,
+                                        }];
                                 }
-                                return [2 /*return*/, {
-                                        name: name,
-                                        title: title,
-                                        content: content,
-                                        keywords: keywords,
-                                        index: index,
-                                        sources: sources,
-                                    }];
                             });
                         }); }))];
-                case 3:
+                case 4:
                     knowledge = _b.sent();
                     return [2 /*return*/, knowledge];
             }