@promptbook/pdf 0.84.0-9 → 0.84.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -9
- package/esm/index.es.js +173 -71
- package/esm/index.es.js.map +1 -1
- package/esm/typings/src/_packages/cli.index.d.ts +4 -0
- package/esm/typings/src/_packages/core.index.d.ts +12 -2
- package/esm/typings/src/_packages/deepseek.index.d.ts +8 -0
- package/esm/typings/src/_packages/types.index.d.ts +2 -0
- package/esm/typings/src/_packages/utils.index.d.ts +2 -0
- package/esm/typings/src/_packages/wizzard.index.d.ts +4 -0
- package/esm/typings/src/cli/cli-commands/about.d.ts +4 -1
- package/esm/typings/src/cli/cli-commands/hello.d.ts +3 -1
- package/esm/typings/src/cli/cli-commands/list-models.d.ts +3 -1
- package/esm/typings/src/cli/cli-commands/list-scrapers.d.ts +13 -0
- package/esm/typings/src/cli/cli-commands/make.d.ts +3 -1
- package/esm/typings/src/cli/cli-commands/prettify.d.ts +3 -1
- package/esm/typings/src/cli/cli-commands/run.d.ts +3 -1
- package/esm/typings/src/cli/cli-commands/runInteractiveChatbot.d.ts +1 -1
- package/esm/typings/src/cli/cli-commands/test-command.d.ts +3 -1
- package/esm/typings/src/config.d.ts +27 -1
- package/esm/typings/src/conversion/compilePipelineOnRemoteServer.d.ts +1 -1
- package/esm/typings/src/execution/FilesystemTools.d.ts +1 -1
- package/esm/typings/src/execution/assertsExecutionSuccessful.d.ts +3 -1
- package/esm/typings/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts +9 -0
- package/esm/typings/src/llm-providers/deepseek/DeepseekExecutionToolsOptions.d.ts +9 -0
- package/esm/typings/src/llm-providers/deepseek/createDeepseekExecutionTools.d.ts +14 -0
- package/esm/typings/src/llm-providers/deepseek/register-configuration.d.ts +14 -0
- package/esm/typings/src/llm-providers/deepseek/register-constructor.d.ts +15 -0
- package/esm/typings/src/pipeline/book-notation.d.ts +3 -2
- package/esm/typings/src/pipeline/prompt-notation.d.ts +18 -5
- package/esm/typings/src/prepare/preparePipelineOnRemoteServer.d.ts +1 -1
- package/esm/typings/src/remote-server/socket-types/_subtypes/PromptbookServer_Identification.d.ts +5 -2
- package/esm/typings/src/utils/editable/edit-pipeline-string/deflatePipeline.test.d.ts +1 -0
- package/esm/typings/src/utils/editable/utils/isFlatPipeline.test.d.ts +1 -0
- package/esm/typings/src/utils/environment/$isRunningInBrowser.d.ts +3 -0
- package/esm/typings/src/utils/environment/$isRunningInJest.d.ts +3 -0
- package/esm/typings/src/utils/environment/$isRunningInNode.d.ts +3 -0
- package/esm/typings/src/utils/environment/$isRunningInWebWorker.d.ts +3 -0
- package/esm/typings/src/utils/files/mimeTypeToExtension.d.ts +10 -0
- package/esm/typings/src/utils/files/mimeTypeToExtension.test.d.ts +1 -0
- package/esm/typings/src/wizzard/wizzard.d.ts +7 -1
- package/package.json +9 -16
- package/umd/index.umd.js +176 -74
- package/umd/index.umd.js.map +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten -->
|
|
2
2
|
|
|
3
|
-
#
|
|
3
|
+
# ✨ Promptbook
|
|
4
4
|
|
|
5
5
|
|
|
6
6
|
|
|
@@ -14,19 +14,16 @@
|
|
|
14
14
|
|
|
15
15
|
|
|
16
16
|
|
|
17
|
-
##
|
|
17
|
+
## 🌟 New Features
|
|
18
18
|
|
|
19
|
+
- 💫 Support of [`o3-mini` model by OpenAI](https://openai.com/index/openai-o3-mini/)
|
|
20
|
+
- 🐋 **Support of [DeepSeek models](https://www.npmjs.com/package/@promptbook/deepseek)**
|
|
19
21
|
- 💙 Working [the **Book** language v1.0.0](https://github.com/webgptorg/book)
|
|
20
22
|
- 🖤 Run books from CLI - `npx ptbk run path/to/your/book`
|
|
21
|
-
- 📚 Support of `.docx`, `.doc` and `.pdf` documents
|
|
22
|
-
- ✨ **Support of [OpenAI o1 model](https://openai.com/o1/)**
|
|
23
|
+
- 📚 Support of `.docx`, `.doc` and `.pdf` documents as knowledge
|
|
23
24
|
|
|
24
25
|
|
|
25
26
|
|
|
26
|
-
<blockquote style="color: #ff8811">
|
|
27
|
-
<b>⚠ Warning:</b> This is a pre-release version of the library. It is not yet ready for production use. Please look at <a href="https://www.npmjs.com/package/@promptbook/core?activeTab=versions">latest stable release</a>.
|
|
28
|
-
</blockquote>
|
|
29
|
-
|
|
30
27
|
## 📦 Package `@promptbook/pdf`
|
|
31
28
|
|
|
32
29
|
- Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
|
|
@@ -265,8 +262,9 @@ Or you can install them separately:
|
|
|
265
262
|
- **[@promptbook/anthropic-claude](https://www.npmjs.com/package/@promptbook/anthropic-claude)** - Execution tools for Anthropic Claude API, wrapper around Anthropic Claude SDK
|
|
266
263
|
- **[@promptbook/vercel](https://www.npmjs.com/package/@promptbook/vercel)** - Adapter for Vercel functionalities
|
|
267
264
|
- **[@promptbook/google](https://www.npmjs.com/package/@promptbook/google)** - Integration with Google's Gemini API
|
|
265
|
+
- **[@promptbook/deepseek](https://www.npmjs.com/package/@promptbook/deepseek)** - Integration with [DeepSeek API](https://www.deepseek.com/)
|
|
268
266
|
- **[@promptbook/azure-openai](https://www.npmjs.com/package/@promptbook/azure-openai)** - Execution tools for Azure OpenAI API
|
|
269
|
-
|
|
267
|
+
|
|
270
268
|
- **[@promptbook/fake-llm](https://www.npmjs.com/package/@promptbook/fake-llm)** - Mocked execution tools for testing the library and saving the tokens
|
|
271
269
|
- **[@promptbook/remote-client](https://www.npmjs.com/package/@promptbook/remote-client)** - Remote client for remote execution of promptbooks
|
|
272
270
|
- **[@promptbook/remote-server](https://www.npmjs.com/package/@promptbook/remote-server)** - Remote server for remote execution of promptbooks
|
|
@@ -436,6 +434,20 @@ See [TODO.md](./TODO.md)
|
|
|
436
434
|
|
|
437
435
|
|
|
438
436
|
|
|
437
|
+
## 🤝 Partners
|
|
438
|
+
|
|
439
|
+
<div style="display: flex; align-items: center; gap: 20px;">
|
|
440
|
+
|
|
441
|
+
<a href="https://promptbook.studio/">
|
|
442
|
+
<img src="./other/design/promptbook-studio-logo.png" alt="Partner 3" height="100">
|
|
443
|
+
</a>
|
|
444
|
+
|
|
445
|
+
<a href="https://technologickainkubace.org/en/about-technology-incubation/about-the-project/">
|
|
446
|
+
<img src="./other/partners/CI-Technology-Incubation.png" alt="Technology Incubation" height="100">
|
|
447
|
+
</a>
|
|
448
|
+
|
|
449
|
+
</div>
|
|
450
|
+
|
|
439
451
|
## 🖋️ Contributing
|
|
440
452
|
|
|
441
453
|
I am open to pull requests, feedback, and suggestions. Or if you like this utility, you can [☕ buy me a coffee](https://www.buymeacoffee.com/hejny) or [donate via cryptocurrencies](https://github.com/hejny/hejny/blob/main/documents/crypto.md).
|
package/esm/index.es.js
CHANGED
|
@@ -6,7 +6,8 @@ import { basename, join, dirname } from 'path';
|
|
|
6
6
|
import { format } from 'prettier';
|
|
7
7
|
import parserHtml from 'prettier/parser-html';
|
|
8
8
|
import { forTime } from 'waitasecond';
|
|
9
|
-
import
|
|
9
|
+
import sha256 from 'crypto-js/sha256';
|
|
10
|
+
import { lookup, extension } from 'mime-types';
|
|
10
11
|
import { unparse, parse } from 'papaparse';
|
|
11
12
|
|
|
12
13
|
// ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten
|
|
@@ -23,7 +24,7 @@ var BOOK_LANGUAGE_VERSION = '1.0.0';
|
|
|
23
24
|
* @generated
|
|
24
25
|
* @see https://github.com/webgptorg/promptbook
|
|
25
26
|
*/
|
|
26
|
-
var PROMPTBOOK_ENGINE_VERSION = '0.84.0-
|
|
27
|
+
var PROMPTBOOK_ENGINE_VERSION = '0.84.0-21';
|
|
27
28
|
/**
|
|
28
29
|
* TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
|
|
29
30
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
@@ -194,6 +195,12 @@ var ADMIN_GITHUB_NAME = 'hejny';
|
|
|
194
195
|
* @public exported from `@promptbook/core`
|
|
195
196
|
*/
|
|
196
197
|
var DEFAULT_BOOK_TITLE = "\u2728 Untitled Book";
|
|
198
|
+
/**
|
|
199
|
+
* Maximum file size limit
|
|
200
|
+
*
|
|
201
|
+
* @public exported from `@promptbook/core`
|
|
202
|
+
*/
|
|
203
|
+
var DEFAULT_MAX_FILE_SIZE = 100 * 1024 * 1024; // 100MB
|
|
197
204
|
// <- TODO: [🧠] Better system for generator warnings - not always "code" and "by `@promptbook/cli`"
|
|
198
205
|
/**
|
|
199
206
|
* The maximum number of iterations for a loops
|
|
@@ -227,6 +234,12 @@ var SMALL_NUMBER = 0.001;
|
|
|
227
234
|
* @private within the repository - too low-level in comparison with other `MAX_...`
|
|
228
235
|
*/
|
|
229
236
|
var IMMEDIATE_TIME = 10;
|
|
237
|
+
/**
|
|
238
|
+
* The maximum length of the (generated) filename
|
|
239
|
+
*
|
|
240
|
+
* @public exported from `@promptbook/core`
|
|
241
|
+
*/
|
|
242
|
+
var MAX_FILENAME_LENGTH = 30;
|
|
230
243
|
/**
|
|
231
244
|
* Strategy for caching the intermediate results for knowledge sources
|
|
232
245
|
*
|
|
@@ -246,6 +259,15 @@ var DEFAULT_MAX_PARALLEL_COUNT = 5; // <- TODO: [🤹♂️]
|
|
|
246
259
|
* @public exported from `@promptbook/core`
|
|
247
260
|
*/
|
|
248
261
|
var DEFAULT_MAX_EXECUTION_ATTEMPTS = 3; // <- TODO: [🤹♂️]
|
|
262
|
+
// <- TODO: [🕝] Make also `BOOKS_DIRNAME_ALTERNATIVES`
|
|
263
|
+
/**
|
|
264
|
+
* Where to store the temporary downloads
|
|
265
|
+
*
|
|
266
|
+
* Note: When the folder does not exist, it is created recursively
|
|
267
|
+
*
|
|
268
|
+
* @public exported from `@promptbook/core`
|
|
269
|
+
*/
|
|
270
|
+
var DEFAULT_DOWNLOAD_CACHE_DIRNAME = './.promptbook/download-cache';
|
|
249
271
|
/**
|
|
250
272
|
* Where to store the scrape cache
|
|
251
273
|
*
|
|
@@ -366,6 +388,9 @@ var UnexpectedError = /** @class */ (function (_super) {
|
|
|
366
388
|
* @public exported from `@promptbook/utils`
|
|
367
389
|
*/
|
|
368
390
|
var $isRunningInNode = new Function("\n try {\n return this === global;\n } catch (e) {\n return false;\n }\n");
|
|
391
|
+
/**
|
|
392
|
+
* TODO: [☑]
|
|
393
|
+
*/
|
|
369
394
|
|
|
370
395
|
/**
|
|
371
396
|
* Checks if the file exists
|
|
@@ -940,24 +965,18 @@ function getScraperIntermediateSource(source, options) {
|
|
|
940
965
|
var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.book.md",formfactorName:"GENERIC",parameters:[{name:"knowledgeContent",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledgePieces",description:"The knowledge JSON object",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"knowledge",title:"Knowledge",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> {knowledgeContent}",resultingParameterName:"knowledgePieces",dependentParameterNames:["knowledgeContent"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Knowledge from Markdown\n\n- PIPELINE URL `https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.book.md`\n- INPUT PARAMETER `{knowledgeContent}` Markdown document content\n- OUTPUT PARAMETER `{knowledgePieces}` The knowledge JSON object\n\n## Knowledge\n\n<!-- TODO: [🍆] -FORMAT JSON -->\n\n```markdown\nYou 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> {knowledgeContent}\n```\n\n`-> {knowledgePieces}`\n"}],sourceFile:"./books/prepare-knowledge-from-markdown.book.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-keywords.book.md",formfactorName:"GENERIC",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"knowledge",title:"Knowledge",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> {knowledgePieceContent}",resultingParameterName:"keywords",dependentParameterNames:["knowledgePieceContent"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Keywords\n\n- PIPELINE URL `https://promptbook.studio/promptbook/prepare-knowledge-keywords.book.md`\n- INPUT PARAMETER `{knowledgePieceContent}` The content\n- OUTPUT PARAMETER `{keywords}` Keywords separated by comma\n\n## Knowledge\n\n<!-- TODO: [🍆] -FORMAT JSON -->\n\n```markdown\nYou 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> {knowledgePieceContent}\n```\n\n`-> {keywords}`\n"}],sourceFile:"./books/prepare-knowledge-keywords.book.md"},{title:"Prepare Knowledge-piece Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-title.book.md",formfactorName:"GENERIC",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"title",description:"The title of the document",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"knowledge",title:"Knowledge",content:"You are experienced content creator, write best title for the document.\n\n# Rules\n\n- Write just title, nothing else\n- Write maximum 5 words for the title\n\n# The document\n\n> {knowledgePieceContent}",resultingParameterName:"title",expectations:{words:{min:1,max:8}},dependentParameterNames:["knowledgePieceContent"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Knowledge-piece Title\n\n- PIPELINE URL `https://promptbook.studio/promptbook/prepare-knowledge-title.book.md`\n- INPUT PARAMETER `{knowledgePieceContent}` The content\n- OUTPUT PARAMETER `{title}` The title of the document\n\n## Knowledge\n\n- EXPECT MIN 1 WORD\n- EXPECT MAX 8 WORDS\n\n```markdown\nYou are experienced content creator, write best title for the document.\n\n# Rules\n\n- Write just title, nothing else\n- Write maximum 5 words for the title\n\n# The document\n\n> {knowledgePieceContent}\n```\n\n`-> {title}`\n"}],sourceFile:"./books/prepare-knowledge-title.book.md"},{title:"Prepare Persona",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.book.md",formfactorName:"GENERIC",parameters:[{name:"availableModelNames",description:"List of available model names separated by comma (,)",isInput:true,isOutput:false},{name:"personaDescription",description:"Description of the persona",isInput:true,isOutput:false},{name:"modelRequirements",description:"Specific requirements for the model",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"make-model-requirements",title:"Make modelRequirements",content:"You are experienced AI engineer, you need to create virtual assistant.\nWrite\n\n## Example\n\n```json\n{\n\"modelName\": \"gpt-4o\",\n\"systemMessage\": \"You are experienced AI engineer and helpfull assistant.\",\n\"temperature\": 0.7\n}\n```\n\n## Instructions\n\n- Your output format is JSON object\n- Write just the JSON object, no other text should be present\n- It contains the following keys:\n - `modelName`: The name of the model to use\n - `systemMessage`: The system message to provide context to the model\n - `temperature`: The sampling temperature to use\n\n### Key `modelName`\n\nPick from the following models:\n\n- {availableModelNames}\n\n### Key `systemMessage`\n\nThe system message is used to communicate instructions or provide context to the model at the beginning of a conversation. It is displayed in a different format compared to user messages, helping the model understand its role in the conversation. The system message typically guides the model's behavior, sets the tone, or specifies desired output from the model. By utilizing the system message effectively, users can steer the model towards generating more accurate and relevant responses.\n\nFor example:\n\n> You are an experienced AI engineer and helpful assistant.\n\n> You are a friendly and knowledgeable chatbot.\n\n### Key `temperature`\n\nThe sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.\n\nYou can pick a value between 0 and 2. For example:\n\n- `0.1`: Low temperature, extremely conservative and deterministic\n- `0.5`: Medium temperature, balanced between conservative and creative\n- `1.0`: High temperature, creative and bit random\n- `1.5`: Very high temperature, extremely creative and often chaotic and unpredictable\n- `2.0`: Maximum temperature, completely random and unpredictable, for some extreme creative use cases\n\n# The assistant\n\nTake this description of the persona:\n\n> {personaDescription}",resultingParameterName:"modelRequirements",format:"JSON",dependentParameterNames:["availableModelNames","personaDescription"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Persona\n\n- PIPELINE URL `https://promptbook.studio/promptbook/prepare-persona.book.md`\n- INPUT PARAMETER `{availableModelNames}` List of available model names separated by comma (,)\n- INPUT PARAMETER `{personaDescription}` Description of the persona\n- OUTPUT PARAMETER `{modelRequirements}` Specific requirements for the model\n\n## Make modelRequirements\n\n- FORMAT JSON\n\n```markdown\nYou are experienced AI engineer, you need to create virtual assistant.\nWrite\n\n## Example\n\n\\`\\`\\`json\n{\n\"modelName\": \"gpt-4o\",\n\"systemMessage\": \"You are experienced AI engineer and helpfull assistant.\",\n\"temperature\": 0.7\n}\n\\`\\`\\`\n\n## Instructions\n\n- Your output format is JSON object\n- Write just the JSON object, no other text should be present\n- It contains the following keys:\n - `modelName`: The name of the model to use\n - `systemMessage`: The system message to provide context to the model\n - `temperature`: The sampling temperature to use\n\n### Key `modelName`\n\nPick from the following models:\n\n- {availableModelNames}\n\n### Key `systemMessage`\n\nThe system message is used to communicate instructions or provide context to the model at the beginning of a conversation. It is displayed in a different format compared to user messages, helping the model understand its role in the conversation. The system message typically guides the model's behavior, sets the tone, or specifies desired output from the model. By utilizing the system message effectively, users can steer the model towards generating more accurate and relevant responses.\n\nFor example:\n\n> You are an experienced AI engineer and helpful assistant.\n\n> You are a friendly and knowledgeable chatbot.\n\n### Key `temperature`\n\nThe sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.\n\nYou can pick a value between 0 and 2. For example:\n\n- `0.1`: Low temperature, extremely conservative and deterministic\n- `0.5`: Medium temperature, balanced between conservative and creative\n- `1.0`: High temperature, creative and bit random\n- `1.5`: Very high temperature, extremely creative and often chaotic and unpredictable\n- `2.0`: Maximum temperature, completely random and unpredictable, for some extreme creative use cases\n\n# The assistant\n\nTake this description of the persona:\n\n> {personaDescription}\n```\n\n`-> {modelRequirements}`\n"}],sourceFile:"./books/prepare-persona.book.md"},{title:"Prepare Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-title.book.md",formfactorName:"GENERIC",parameters:[{name:"book",description:"The book to prepare the title for",isInput:true,isOutput:false},{name:"title",description:"Best title for the book",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"make-title",title:"Make title",content:"Make best title for given text which describes the workflow:\n\n## Rules\n\n- Write just title, nothing else\n- Title should be concise and clear - Write maximum ideally 2 words, maximum 5 words\n- Title starts with emoticon\n- Title should not mention the input and output of the workflow but the main purpose of the workflow\n _For example, not \"✍ Convert Knowledge-piece to title\" but \"✍ Title\"_\n\n## The workflow\n\n> {book}",resultingParameterName:"title",expectations:{words:{min:1,max:8},lines:{min:1,max:1}},dependentParameterNames:["book"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Title\n\n- PIPELINE URL `https://promptbook.studio/promptbook/prepare-title.book.md`\n- INPUT PARAMETER `{book}` The book to prepare the title for\n- OUTPUT PARAMETER `{title}` Best title for the book\n\n## Make title\n\n- EXPECT MIN 1 Word\n- EXPECT MAX 8 Words\n- EXPECT EXACTLY 1 Line\n\n```markdown\nMake best title for given text which describes the workflow:\n\n## Rules\n\n- Write just title, nothing else\n- Title should be concise and clear - Write maximum ideally 2 words, maximum 5 words\n- Title starts with emoticon\n- Title should not mention the input and output of the workflow but the main purpose of the workflow\n _For example, not \"✍ Convert Knowledge-piece to title\" but \"✍ Title\"_\n\n## The workflow\n\n> {book}\n```\n\n`-> {title}`\n"}],sourceFile:"./books/prepare-title.book.md"}];
|
|
941
966
|
|
|
942
967
|
/**
|
|
943
|
-
*
|
|
968
|
+
* Checks if value is valid email
|
|
944
969
|
*
|
|
945
970
|
* @public exported from `@promptbook/utils`
|
|
946
971
|
*/
|
|
947
|
-
function
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
return true;
|
|
972
|
+
function isValidEmail(email) {
|
|
973
|
+
if (typeof email !== 'string') {
|
|
974
|
+
return false;
|
|
951
975
|
}
|
|
952
|
-
|
|
953
|
-
if (!(error instanceof Error)) {
|
|
954
|
-
throw error;
|
|
955
|
-
}
|
|
956
|
-
if (error.message.includes('Unexpected token')) {
|
|
957
|
-
return false;
|
|
958
|
-
}
|
|
976
|
+
if (email.split('\n').length > 1) {
|
|
959
977
|
return false;
|
|
960
978
|
}
|
|
979
|
+
return /^.+@.+\..+$/.test(email);
|
|
961
980
|
}
|
|
962
981
|
|
|
963
982
|
/**
|
|
@@ -979,6 +998,27 @@ var ParseError = /** @class */ (function (_super) {
|
|
|
979
998
|
* TODO: Maybe split `ParseError` and `ApplyError`
|
|
980
999
|
*/
|
|
981
1000
|
|
|
1001
|
+
/**
|
|
1002
|
+
* Function isValidJsonString will tell you if the string is valid JSON or not
|
|
1003
|
+
*
|
|
1004
|
+
* @public exported from `@promptbook/utils`
|
|
1005
|
+
*/
|
|
1006
|
+
function isValidJsonString(value /* <- [👨⚖️] */) {
|
|
1007
|
+
try {
|
|
1008
|
+
JSON.parse(value);
|
|
1009
|
+
return true;
|
|
1010
|
+
}
|
|
1011
|
+
catch (error) {
|
|
1012
|
+
if (!(error instanceof Error)) {
|
|
1013
|
+
throw error;
|
|
1014
|
+
}
|
|
1015
|
+
if (error.message.includes('Unexpected token')) {
|
|
1016
|
+
return false;
|
|
1017
|
+
}
|
|
1018
|
+
return false;
|
|
1019
|
+
}
|
|
1020
|
+
}
|
|
1021
|
+
|
|
982
1022
|
/**
|
|
983
1023
|
* Function `validatePipelineString` will validate the if the string is a valid pipeline string
|
|
984
1024
|
* It does not check if the string is fully logically correct, but if it is a string that can be a pipeline string or the string looks completely different.
|
|
@@ -992,6 +1032,15 @@ function validatePipelineString(pipelineString) {
|
|
|
992
1032
|
if (isValidJsonString(pipelineString)) {
|
|
993
1033
|
throw new ParseError('Expected a book, but got a JSON string');
|
|
994
1034
|
}
|
|
1035
|
+
else if (isValidUrl(pipelineString)) {
|
|
1036
|
+
throw new ParseError("Expected a book, but got just the URL \"".concat(pipelineString, "\""));
|
|
1037
|
+
}
|
|
1038
|
+
else if (isValidFilePath(pipelineString)) {
|
|
1039
|
+
throw new ParseError("Expected a book, but got just the file path \"".concat(pipelineString, "\""));
|
|
1040
|
+
}
|
|
1041
|
+
else if (isValidEmail(pipelineString)) {
|
|
1042
|
+
throw new ParseError("Expected a book, but got just the email \"".concat(pipelineString, "\""));
|
|
1043
|
+
}
|
|
995
1044
|
// <- TODO: Implement the validation + add tests when the pipeline logic considered as invalid
|
|
996
1045
|
return pipelineString;
|
|
997
1046
|
}
|
|
@@ -2373,12 +2422,28 @@ function deserializeError(error) {
|
|
|
2373
2422
|
/**
|
|
2374
2423
|
* Asserts that the execution of a Promptbook is successful
|
|
2375
2424
|
*
|
|
2425
|
+
* Note: If there are only warnings, the execution is still successful but the warnings are logged in the console
|
|
2426
|
+
*
|
|
2376
2427
|
* @param executionResult - The partial result of the Promptbook execution
|
|
2377
2428
|
* @throws {PipelineExecutionError} If the execution is not successful or if multiple errors occurred
|
|
2378
2429
|
* @public exported from `@promptbook/core`
|
|
2379
2430
|
*/
|
|
2380
2431
|
function assertsExecutionSuccessful(executionResult) {
|
|
2381
|
-
var
|
|
2432
|
+
var e_1, _a;
|
|
2433
|
+
var isSuccessful = executionResult.isSuccessful, errors = executionResult.errors, warnings = executionResult.warnings;
|
|
2434
|
+
try {
|
|
2435
|
+
for (var warnings_1 = __values(warnings), warnings_1_1 = warnings_1.next(); !warnings_1_1.done; warnings_1_1 = warnings_1.next()) {
|
|
2436
|
+
var warning = warnings_1_1.value;
|
|
2437
|
+
console.warn(warning.message);
|
|
2438
|
+
}
|
|
2439
|
+
}
|
|
2440
|
+
catch (e_1_1) { e_1 = { error: e_1_1 }; }
|
|
2441
|
+
finally {
|
|
2442
|
+
try {
|
|
2443
|
+
if (warnings_1_1 && !warnings_1_1.done && (_a = warnings_1.return)) _a.call(warnings_1);
|
|
2444
|
+
}
|
|
2445
|
+
finally { if (e_1) throw e_1.error; }
|
|
2446
|
+
}
|
|
2382
2447
|
if (isSuccessful === true) {
|
|
2383
2448
|
return;
|
|
2384
2449
|
}
|
|
@@ -3015,7 +3080,7 @@ var MultipleLlmExecutionTools = /** @class */ (function () {
|
|
|
3015
3080
|
if (!(error_1 instanceof Error) || error_1 instanceof UnexpectedError) {
|
|
3016
3081
|
throw error_1;
|
|
3017
3082
|
}
|
|
3018
|
-
errors.push(error_1);
|
|
3083
|
+
errors.push({ llmExecutionTools: llmExecutionTools, error: error_1 });
|
|
3019
3084
|
return [3 /*break*/, 13];
|
|
3020
3085
|
case 13:
|
|
3021
3086
|
_b = _a.next();
|
|
@@ -3042,7 +3107,10 @@ var MultipleLlmExecutionTools = /** @class */ (function () {
|
|
|
3042
3107
|
// 2) AnthropicClaude throw PipelineExecutionError: Parameter `{knowledge}` is not defined
|
|
3043
3108
|
// 3) ...
|
|
3044
3109
|
spaceTrim(function (block) { return "\n All execution tools failed:\n\n ".concat(block(errors
|
|
3045
|
-
.map(function (
|
|
3110
|
+
.map(function (_a, i) {
|
|
3111
|
+
var error = _a.error, llmExecutionTools = _a.llmExecutionTools;
|
|
3112
|
+
return "".concat(i + 1, ") **").concat(llmExecutionTools.title, "** thrown **").concat(error.name || 'Error', ":** ").concat(error.message);
|
|
3113
|
+
})
|
|
3046
3114
|
.join('\n')), "\n\n "); }));
|
|
3047
3115
|
}
|
|
3048
3116
|
else if (this.llmExecutionTools.length === 0) {
|
|
@@ -3524,6 +3592,17 @@ function getFileExtension(value) {
|
|
|
3524
3592
|
return match ? match[1].toLowerCase() : null;
|
|
3525
3593
|
}
|
|
3526
3594
|
|
|
3595
|
+
/**
|
|
3596
|
+
* Convert mime type to file extension
|
|
3597
|
+
*
|
|
3598
|
+
* Note: If the mime type is invalid, `null` is returned
|
|
3599
|
+
*
|
|
3600
|
+
* @private within the repository
|
|
3601
|
+
*/
|
|
3602
|
+
function mimeTypeToExtension(value) {
|
|
3603
|
+
return extension(value) || null;
|
|
3604
|
+
}
|
|
3605
|
+
|
|
3527
3606
|
/**
|
|
3528
3607
|
* The built-in `fetch' function with a lightweight error handling wrapper as default fetch function used in Promptbook scrapers
|
|
3529
3608
|
*
|
|
@@ -3559,9 +3638,9 @@ var scraperFetch = function (url, init) { return __awaiter(void 0, void 0, void
|
|
|
3559
3638
|
function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
|
|
3560
3639
|
var _a;
|
|
3561
3640
|
return __awaiter(this, void 0, void 0, function () {
|
|
3562
|
-
var _b, fetch, knowledgeSourceContent, name, _c, _d, rootDirname, url, response_1, mimeType, filename_1, fileExtension, mimeType;
|
|
3563
|
-
return __generator(this, function (
|
|
3564
|
-
switch (
|
|
3641
|
+
var _b, fetch, knowledgeSourceContent, name, _c, _d, rootDirname, url, response_1, mimeType, basename, hash, rootDirname_1, filepath, fileContent, _f, _g, filename_1, fileExtension, mimeType;
|
|
3642
|
+
return __generator(this, function (_h) {
|
|
3643
|
+
switch (_h.label) {
|
|
3565
3644
|
case 0:
|
|
3566
3645
|
_b = tools.fetch, fetch = _b === void 0 ? scraperFetch : _b;
|
|
3567
3646
|
knowledgeSourceContent = knowledgeSource.knowledgeSourceContent;
|
|
@@ -3570,54 +3649,76 @@ function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
|
|
|
3570
3649
|
if (!name) {
|
|
3571
3650
|
name = knowledgeSourceContentToName(knowledgeSourceContent);
|
|
3572
3651
|
}
|
|
3573
|
-
if (!isValidUrl(knowledgeSourceContent)) return [3 /*break*/,
|
|
3652
|
+
if (!isValidUrl(knowledgeSourceContent)) return [3 /*break*/, 5];
|
|
3574
3653
|
url = knowledgeSourceContent;
|
|
3575
3654
|
return [4 /*yield*/, fetch(url)];
|
|
3576
3655
|
case 1:
|
|
3577
|
-
response_1 =
|
|
3656
|
+
response_1 = _h.sent();
|
|
3578
3657
|
mimeType = ((_a = response_1.headers.get('content-type')) === null || _a === void 0 ? void 0 : _a.split(';')[0]) || 'text/html';
|
|
3579
|
-
|
|
3580
|
-
|
|
3581
|
-
|
|
3582
|
-
|
|
3583
|
-
|
|
3584
|
-
|
|
3585
|
-
|
|
3586
|
-
|
|
3587
|
-
|
|
3588
|
-
|
|
3589
|
-
|
|
3590
|
-
|
|
3591
|
-
|
|
3592
|
-
|
|
3593
|
-
|
|
3594
|
-
|
|
3595
|
-
|
|
3596
|
-
|
|
3597
|
-
|
|
3598
|
-
|
|
3599
|
-
|
|
3600
|
-
|
|
3601
|
-
|
|
3658
|
+
if (tools.fs === undefined || !url.endsWith('.pdf' /* <- TODO: [💵] */)) {
|
|
3659
|
+
return [2 /*return*/, {
|
|
3660
|
+
source: name,
|
|
3661
|
+
filename: null,
|
|
3662
|
+
url: url,
|
|
3663
|
+
mimeType: mimeType,
|
|
3664
|
+
/*
|
|
3665
|
+
TODO: [🥽]
|
|
3666
|
+
> async asBlob() {
|
|
3667
|
+
> // TODO: [👨🏻🤝👨🏻] This can be called multiple times BUT when called second time, response in already consumed
|
|
3668
|
+
> const content = await response.blob();
|
|
3669
|
+
> return content;
|
|
3670
|
+
> },
|
|
3671
|
+
*/
|
|
3672
|
+
asJson: function () {
|
|
3673
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
3674
|
+
var content;
|
|
3675
|
+
return __generator(this, function (_a) {
|
|
3676
|
+
switch (_a.label) {
|
|
3677
|
+
case 0: return [4 /*yield*/, response_1.json()];
|
|
3678
|
+
case 1:
|
|
3679
|
+
content = _a.sent();
|
|
3680
|
+
return [2 /*return*/, content];
|
|
3681
|
+
}
|
|
3682
|
+
});
|
|
3602
3683
|
});
|
|
3603
|
-
}
|
|
3604
|
-
|
|
3605
|
-
|
|
3606
|
-
|
|
3607
|
-
|
|
3608
|
-
|
|
3609
|
-
|
|
3610
|
-
|
|
3611
|
-
|
|
3612
|
-
|
|
3613
|
-
|
|
3614
|
-
}
|
|
3684
|
+
},
|
|
3685
|
+
asText: function () {
|
|
3686
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
3687
|
+
var content;
|
|
3688
|
+
return __generator(this, function (_a) {
|
|
3689
|
+
switch (_a.label) {
|
|
3690
|
+
case 0: return [4 /*yield*/, response_1.text()];
|
|
3691
|
+
case 1:
|
|
3692
|
+
content = _a.sent();
|
|
3693
|
+
return [2 /*return*/, content];
|
|
3694
|
+
}
|
|
3695
|
+
});
|
|
3615
3696
|
});
|
|
3616
|
-
}
|
|
3617
|
-
}
|
|
3618
|
-
|
|
3697
|
+
},
|
|
3698
|
+
}];
|
|
3699
|
+
}
|
|
3700
|
+
basename = url.split('/').pop() || titleToName(url);
|
|
3701
|
+
hash = sha256(hexEncoder.parse(url)).toString( /* hex */);
|
|
3702
|
+
rootDirname_1 = join(process.cwd(), DEFAULT_DOWNLOAD_CACHE_DIRNAME);
|
|
3703
|
+
filepath = join.apply(void 0, __spreadArray(__spreadArray([], __read(nameToSubfolderPath(hash /* <- TODO: [🎎] Maybe add some SHA256 prefix */)), false), ["".concat(basename.substring(0, MAX_FILENAME_LENGTH), ".").concat(mimeTypeToExtension(mimeType))], false));
|
|
3704
|
+
return [4 /*yield*/, tools.fs.mkdir(dirname(join(rootDirname_1, filepath)), { recursive: true })];
|
|
3619
3705
|
case 2:
|
|
3620
|
-
|
|
3706
|
+
_h.sent();
|
|
3707
|
+
_g = (_f = Buffer).from;
|
|
3708
|
+
return [4 /*yield*/, response_1.arrayBuffer()];
|
|
3709
|
+
case 3:
|
|
3710
|
+
fileContent = _g.apply(_f, [_h.sent()]);
|
|
3711
|
+
if (fileContent.length > DEFAULT_MAX_FILE_SIZE /* <- TODO: Allow to pass different value to remote server */) {
|
|
3712
|
+
throw new LimitReachedError("File is too large (".concat(Math.round(fileContent.length / 1024 / 1024), "MB). Maximum allowed size is ").concat(Math.round(DEFAULT_MAX_FILE_SIZE / 1024 / 1024), "MB."));
|
|
3713
|
+
}
|
|
3714
|
+
return [4 /*yield*/, tools.fs.writeFile(join(rootDirname_1, filepath), fileContent)];
|
|
3715
|
+
case 4:
|
|
3716
|
+
_h.sent();
|
|
3717
|
+
// TODO: [💵] Check the file security
|
|
3718
|
+
// TODO: [🧹][🧠] Delete the file after the scraping is done
|
|
3719
|
+
return [2 /*return*/, makeKnowledgeSourceHandler({ name: name, knowledgeSourceContent: filepath }, tools, __assign(__assign({}, options), { rootDirname: rootDirname_1 }))];
|
|
3720
|
+
case 5:
|
|
3721
|
+
if (!isValidFilePath(knowledgeSourceContent)) return [3 /*break*/, 7];
|
|
3621
3722
|
if (tools.fs === undefined) {
|
|
3622
3723
|
throw new EnvironmentMismatchError('Can not import file knowledge without filesystem tools');
|
|
3623
3724
|
// <- TODO: [🧠] What is the best error type here`
|
|
@@ -3630,8 +3731,8 @@ function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
|
|
|
3630
3731
|
fileExtension = getFileExtension(filename_1);
|
|
3631
3732
|
mimeType = extensionToMimeType(fileExtension || '');
|
|
3632
3733
|
return [4 /*yield*/, isFileExisting(filename_1, tools.fs)];
|
|
3633
|
-
case
|
|
3634
|
-
if (!(
|
|
3734
|
+
case 6:
|
|
3735
|
+
if (!(_h.sent())) {
|
|
3635
3736
|
throw new NotFoundError(spaceTrim(function (block) { return "\n Can not make source handler for file which does not exist:\n\n File:\n ".concat(block(knowledgeSourceContent), "\n\n Full file path:\n ").concat(block(filename_1), "\n "); }));
|
|
3636
3737
|
}
|
|
3637
3738
|
// TODO: [🧠][😿] Test security file - file is scoped to the project (BUT maybe do this in `filesystemTools`)
|
|
@@ -3677,7 +3778,7 @@ function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
|
|
|
3677
3778
|
});
|
|
3678
3779
|
},
|
|
3679
3780
|
}];
|
|
3680
|
-
case
|
|
3781
|
+
case 7: return [2 /*return*/, {
|
|
3681
3782
|
source: name,
|
|
3682
3783
|
filename: null,
|
|
3683
3784
|
url: null,
|
|
@@ -6233,7 +6334,7 @@ var markitdownScraperMetadata = $deepFreeze({
|
|
|
6233
6334
|
className: 'MarkitdownScraper',
|
|
6234
6335
|
mimeTypes: [
|
|
6235
6336
|
'application/pdf',
|
|
6236
|
-
// TODO: Make priority for scrapers and than allow all mime types here:
|
|
6337
|
+
// TODO: [💵] Make priority for scrapers and than analyze which mime-types can Markitdown scrape and allow all mime types here:
|
|
6237
6338
|
// 'text/html',
|
|
6238
6339
|
// 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
|
|
6239
6340
|
],
|
|
@@ -6269,10 +6370,10 @@ var MarkitdownScraper = /** @class */ (function () {
|
|
|
6269
6370
|
this.tools = tools;
|
|
6270
6371
|
this.options = options;
|
|
6271
6372
|
this.markdownScraper = new MarkdownScraper(tools, options);
|
|
6373
|
+
// Note: Module `markitdown-ts` has no types available, so it is imported using `require`
|
|
6272
6374
|
// eslint-disable-next-line @typescript-eslint/no-var-requires
|
|
6273
6375
|
var MarkItDown = require('markitdown-ts').MarkItDown;
|
|
6274
|
-
// <- TODO:
|
|
6275
|
-
// <- Note: !!!!!!!
|
|
6376
|
+
// <- TODO: [🍀] Use Markitdown directly not through this package
|
|
6276
6377
|
this.markitdown = new MarkItDown();
|
|
6277
6378
|
}
|
|
6278
6379
|
Object.defineProperty(MarkitdownScraper.prototype, "metadata", {
|
|
@@ -6317,12 +6418,12 @@ var MarkitdownScraper = /** @class */ (function () {
|
|
|
6317
6418
|
case 2:
|
|
6318
6419
|
if (!!(_f.sent())) return [3 /*break*/, 5];
|
|
6319
6420
|
src = source.filename || source.url || null;
|
|
6320
|
-
console.log('
|
|
6421
|
+
// console.log('!!', { src, source, cacheFilehandler });
|
|
6321
6422
|
if (src === null) {
|
|
6322
6423
|
throw new UnexpectedError('Source has no filename or url');
|
|
6323
6424
|
}
|
|
6324
6425
|
return [4 /*yield*/, this.markitdown.convert(src, {
|
|
6325
|
-
// TODO:
|
|
6426
|
+
// TODO: Pass when sacraping Youtube
|
|
6326
6427
|
// enableYoutubeTranscript: true,
|
|
6327
6428
|
// youtubeTranscriptLanguage: 'en',
|
|
6328
6429
|
})];
|
|
@@ -6330,11 +6431,12 @@ var MarkitdownScraper = /** @class */ (function () {
|
|
|
6330
6431
|
result = _f.sent();
|
|
6331
6432
|
if (result === null || result === undefined) {
|
|
6332
6433
|
throw new Error("Markitdown could not convert the \"".concat(source.source, "\""));
|
|
6333
|
-
// <- TODO:
|
|
6434
|
+
// <- TODO: [🍀] Make MarkitdownError
|
|
6334
6435
|
}
|
|
6335
|
-
console.log('
|
|
6436
|
+
// console.log('!!', { result, cacheFilehandler });
|
|
6336
6437
|
return [4 /*yield*/, this.tools.fs.writeFile(cacheFilehandler.filename, result.text_content)];
|
|
6337
6438
|
case 4:
|
|
6439
|
+
// console.log('!!', { result, cacheFilehandler });
|
|
6338
6440
|
_f.sent();
|
|
6339
6441
|
_f.label = 5;
|
|
6340
6442
|
case 5: return [2 /*return*/, cacheFilehandler];
|