@promptbook/markitdown 0.84.0-21 → 0.84.0-9
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 +5 -21
- package/esm/index.es.js +71 -170
- package/esm/index.es.js.map +1 -1
- package/esm/typings/src/_packages/cli.index.d.ts +0 -4
- package/esm/typings/src/_packages/core.index.d.ts +2 -12
- package/esm/typings/src/_packages/types.index.d.ts +0 -2
- package/esm/typings/src/_packages/utils.index.d.ts +0 -2
- package/esm/typings/src/_packages/wizzard.index.d.ts +0 -4
- package/esm/typings/src/cli/cli-commands/about.d.ts +1 -3
- package/esm/typings/src/cli/cli-commands/hello.d.ts +1 -3
- package/esm/typings/src/cli/cli-commands/list-models.d.ts +1 -3
- package/esm/typings/src/cli/cli-commands/make.d.ts +1 -3
- package/esm/typings/src/cli/cli-commands/prettify.d.ts +1 -3
- package/esm/typings/src/cli/cli-commands/run.d.ts +1 -3
- package/esm/typings/src/cli/cli-commands/runInteractiveChatbot.d.ts +1 -1
- package/esm/typings/src/cli/cli-commands/test-command.d.ts +1 -3
- package/esm/typings/src/config.d.ts +1 -27
- 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 +1 -3
- package/esm/typings/src/pipeline/book-notation.d.ts +2 -3
- package/esm/typings/src/pipeline/prompt-notation.d.ts +5 -18
- package/esm/typings/src/prepare/preparePipelineOnRemoteServer.d.ts +1 -1
- package/esm/typings/src/remote-server/socket-types/_subtypes/PromptbookServer_Identification.d.ts +2 -5
- package/esm/typings/src/wizzard/wizzard.d.ts +1 -7
- package/package.json +16 -9
- package/umd/index.umd.js +74 -173
- package/umd/index.umd.js.map +1 -1
- package/esm/typings/src/_packages/deepseek.index.d.ts +0 -8
- package/esm/typings/src/cli/cli-commands/list-scrapers.d.ts +0 -13
- package/esm/typings/src/llm-providers/deepseek/DeepseekExecutionToolsOptions.d.ts +0 -9
- package/esm/typings/src/llm-providers/deepseek/createDeepseekExecutionTools.d.ts +0 -14
- package/esm/typings/src/llm-providers/deepseek/register-configuration.d.ts +0 -14
- package/esm/typings/src/llm-providers/deepseek/register-constructor.d.ts +0 -15
- package/esm/typings/src/utils/editable/edit-pipeline-string/deflatePipeline.test.d.ts +0 -1
- package/esm/typings/src/utils/editable/utils/isFlatPipeline.test.d.ts +0 -1
- package/esm/typings/src/utils/files/mimeTypeToExtension.d.ts +0 -10
- package/esm/typings/src/utils/files/mimeTypeToExtension.test.d.ts +0 -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,13 +14,12 @@
|
|
|
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)**
|
|
21
19
|
- 💙 Working [the **Book** language v1.0.0](https://github.com/webgptorg/book)
|
|
22
20
|
- 🖤 Run books from CLI - `npx ptbk run path/to/your/book`
|
|
23
|
-
- 📚 Support of `.docx`, `.doc` and `.pdf` documents
|
|
21
|
+
- 📚 Support of `.docx`, `.doc` and `.pdf` documents
|
|
22
|
+
- ✨ **Support of [OpenAI o1 model](https://openai.com/o1/)**
|
|
24
23
|
|
|
25
24
|
|
|
26
25
|
|
|
@@ -264,9 +263,8 @@ Or you can install them separately:
|
|
|
264
263
|
- **[@promptbook/anthropic-claude](https://www.npmjs.com/package/@promptbook/anthropic-claude)** - Execution tools for Anthropic Claude API, wrapper around Anthropic Claude SDK
|
|
265
264
|
- **[@promptbook/vercel](https://www.npmjs.com/package/@promptbook/vercel)** - Adapter for Vercel functionalities
|
|
266
265
|
- **[@promptbook/google](https://www.npmjs.com/package/@promptbook/google)** - Integration with Google's Gemini API
|
|
267
|
-
- **[@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
|
+
- **[@promptbook/langtail](https://www.npmjs.com/package/@promptbook/langtail)** - Execution tools for Langtail API, wrapper around Langtail SDK
|
|
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,20 +434,6 @@ See [TODO.md](./TODO.md)
|
|
|
436
434
|
|
|
437
435
|
|
|
438
436
|
|
|
439
|
-
## 🤝 Partners
|
|
440
|
-
|
|
441
|
-
<div style="display: flex; align-items: center; gap: 20px;">
|
|
442
|
-
|
|
443
|
-
<a href="https://promptbook.studio/">
|
|
444
|
-
<img src="./other/design/promptbook-studio-logo.png" alt="Partner 3" height="100">
|
|
445
|
-
</a>
|
|
446
|
-
|
|
447
|
-
<a href="https://technologickainkubace.org/en/about-technology-incubation/about-the-project/">
|
|
448
|
-
<img src="./other/partners/CI-Technology-Incubation.png" alt="Technology Incubation" height="100">
|
|
449
|
-
</a>
|
|
450
|
-
|
|
451
|
-
</div>
|
|
452
|
-
|
|
453
437
|
## 🖋️ Contributing
|
|
454
438
|
|
|
455
439
|
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,8 +6,7 @@ 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
|
|
10
|
-
import { lookup, extension } from 'mime-types';
|
|
9
|
+
import { lookup } from 'mime-types';
|
|
11
10
|
import { unparse, parse } from 'papaparse';
|
|
12
11
|
|
|
13
12
|
// ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten
|
|
@@ -24,7 +23,7 @@ var BOOK_LANGUAGE_VERSION = '1.0.0';
|
|
|
24
23
|
* @generated
|
|
25
24
|
* @see https://github.com/webgptorg/promptbook
|
|
26
25
|
*/
|
|
27
|
-
var PROMPTBOOK_ENGINE_VERSION = '0.84.0-
|
|
26
|
+
var PROMPTBOOK_ENGINE_VERSION = '0.84.0-8';
|
|
28
27
|
/**
|
|
29
28
|
* TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
|
|
30
29
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
@@ -195,12 +194,6 @@ var ADMIN_GITHUB_NAME = 'hejny';
|
|
|
195
194
|
* @public exported from `@promptbook/core`
|
|
196
195
|
*/
|
|
197
196
|
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
|
|
204
197
|
// <- TODO: [🧠] Better system for generator warnings - not always "code" and "by `@promptbook/cli`"
|
|
205
198
|
/**
|
|
206
199
|
* The maximum number of iterations for a loops
|
|
@@ -234,12 +227,6 @@ var SMALL_NUMBER = 0.001;
|
|
|
234
227
|
* @private within the repository - too low-level in comparison with other `MAX_...`
|
|
235
228
|
*/
|
|
236
229
|
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;
|
|
243
230
|
/**
|
|
244
231
|
* Strategy for caching the intermediate results for knowledge sources
|
|
245
232
|
*
|
|
@@ -259,15 +246,6 @@ var DEFAULT_MAX_PARALLEL_COUNT = 5; // <- TODO: [🤹♂️]
|
|
|
259
246
|
* @public exported from `@promptbook/core`
|
|
260
247
|
*/
|
|
261
248
|
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';
|
|
271
249
|
/**
|
|
272
250
|
* Where to store the scrape cache
|
|
273
251
|
*
|
|
@@ -949,18 +927,24 @@ function getScraperIntermediateSource(source, options) {
|
|
|
949
927
|
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"}];
|
|
950
928
|
|
|
951
929
|
/**
|
|
952
|
-
*
|
|
930
|
+
* Function isValidJsonString will tell you if the string is valid JSON or not
|
|
953
931
|
*
|
|
954
932
|
* @public exported from `@promptbook/utils`
|
|
955
933
|
*/
|
|
956
|
-
function
|
|
957
|
-
|
|
958
|
-
|
|
934
|
+
function isValidJsonString(value /* <- [👨⚖️] */) {
|
|
935
|
+
try {
|
|
936
|
+
JSON.parse(value);
|
|
937
|
+
return true;
|
|
959
938
|
}
|
|
960
|
-
|
|
939
|
+
catch (error) {
|
|
940
|
+
if (!(error instanceof Error)) {
|
|
941
|
+
throw error;
|
|
942
|
+
}
|
|
943
|
+
if (error.message.includes('Unexpected token')) {
|
|
944
|
+
return false;
|
|
945
|
+
}
|
|
961
946
|
return false;
|
|
962
947
|
}
|
|
963
|
-
return /^.+@.+\..+$/.test(email);
|
|
964
948
|
}
|
|
965
949
|
|
|
966
950
|
/**
|
|
@@ -982,27 +966,6 @@ var ParseError = /** @class */ (function (_super) {
|
|
|
982
966
|
* TODO: Maybe split `ParseError` and `ApplyError`
|
|
983
967
|
*/
|
|
984
968
|
|
|
985
|
-
/**
|
|
986
|
-
* Function isValidJsonString will tell you if the string is valid JSON or not
|
|
987
|
-
*
|
|
988
|
-
* @public exported from `@promptbook/utils`
|
|
989
|
-
*/
|
|
990
|
-
function isValidJsonString(value /* <- [👨⚖️] */) {
|
|
991
|
-
try {
|
|
992
|
-
JSON.parse(value);
|
|
993
|
-
return true;
|
|
994
|
-
}
|
|
995
|
-
catch (error) {
|
|
996
|
-
if (!(error instanceof Error)) {
|
|
997
|
-
throw error;
|
|
998
|
-
}
|
|
999
|
-
if (error.message.includes('Unexpected token')) {
|
|
1000
|
-
return false;
|
|
1001
|
-
}
|
|
1002
|
-
return false;
|
|
1003
|
-
}
|
|
1004
|
-
}
|
|
1005
|
-
|
|
1006
969
|
/**
|
|
1007
970
|
* Function `validatePipelineString` will validate the if the string is a valid pipeline string
|
|
1008
971
|
* 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.
|
|
@@ -1016,15 +979,6 @@ function validatePipelineString(pipelineString) {
|
|
|
1016
979
|
if (isValidJsonString(pipelineString)) {
|
|
1017
980
|
throw new ParseError('Expected a book, but got a JSON string');
|
|
1018
981
|
}
|
|
1019
|
-
else if (isValidUrl(pipelineString)) {
|
|
1020
|
-
throw new ParseError("Expected a book, but got just the URL \"".concat(pipelineString, "\""));
|
|
1021
|
-
}
|
|
1022
|
-
else if (isValidFilePath(pipelineString)) {
|
|
1023
|
-
throw new ParseError("Expected a book, but got just the file path \"".concat(pipelineString, "\""));
|
|
1024
|
-
}
|
|
1025
|
-
else if (isValidEmail(pipelineString)) {
|
|
1026
|
-
throw new ParseError("Expected a book, but got just the email \"".concat(pipelineString, "\""));
|
|
1027
|
-
}
|
|
1028
982
|
// <- TODO: Implement the validation + add tests when the pipeline logic considered as invalid
|
|
1029
983
|
return pipelineString;
|
|
1030
984
|
}
|
|
@@ -2406,28 +2360,12 @@ function deserializeError(error) {
|
|
|
2406
2360
|
/**
|
|
2407
2361
|
* Asserts that the execution of a Promptbook is successful
|
|
2408
2362
|
*
|
|
2409
|
-
* Note: If there are only warnings, the execution is still successful but the warnings are logged in the console
|
|
2410
|
-
*
|
|
2411
2363
|
* @param executionResult - The partial result of the Promptbook execution
|
|
2412
2364
|
* @throws {PipelineExecutionError} If the execution is not successful or if multiple errors occurred
|
|
2413
2365
|
* @public exported from `@promptbook/core`
|
|
2414
2366
|
*/
|
|
2415
2367
|
function assertsExecutionSuccessful(executionResult) {
|
|
2416
|
-
var
|
|
2417
|
-
var isSuccessful = executionResult.isSuccessful, errors = executionResult.errors, warnings = executionResult.warnings;
|
|
2418
|
-
try {
|
|
2419
|
-
for (var warnings_1 = __values(warnings), warnings_1_1 = warnings_1.next(); !warnings_1_1.done; warnings_1_1 = warnings_1.next()) {
|
|
2420
|
-
var warning = warnings_1_1.value;
|
|
2421
|
-
console.warn(warning.message);
|
|
2422
|
-
}
|
|
2423
|
-
}
|
|
2424
|
-
catch (e_1_1) { e_1 = { error: e_1_1 }; }
|
|
2425
|
-
finally {
|
|
2426
|
-
try {
|
|
2427
|
-
if (warnings_1_1 && !warnings_1_1.done && (_a = warnings_1.return)) _a.call(warnings_1);
|
|
2428
|
-
}
|
|
2429
|
-
finally { if (e_1) throw e_1.error; }
|
|
2430
|
-
}
|
|
2368
|
+
var isSuccessful = executionResult.isSuccessful, errors = executionResult.errors;
|
|
2431
2369
|
if (isSuccessful === true) {
|
|
2432
2370
|
return;
|
|
2433
2371
|
}
|
|
@@ -3064,7 +3002,7 @@ var MultipleLlmExecutionTools = /** @class */ (function () {
|
|
|
3064
3002
|
if (!(error_1 instanceof Error) || error_1 instanceof UnexpectedError) {
|
|
3065
3003
|
throw error_1;
|
|
3066
3004
|
}
|
|
3067
|
-
errors.push(
|
|
3005
|
+
errors.push(error_1);
|
|
3068
3006
|
return [3 /*break*/, 13];
|
|
3069
3007
|
case 13:
|
|
3070
3008
|
_b = _a.next();
|
|
@@ -3091,10 +3029,7 @@ var MultipleLlmExecutionTools = /** @class */ (function () {
|
|
|
3091
3029
|
// 2) AnthropicClaude throw PipelineExecutionError: Parameter `{knowledge}` is not defined
|
|
3092
3030
|
// 3) ...
|
|
3093
3031
|
spaceTrim(function (block) { return "\n All execution tools failed:\n\n ".concat(block(errors
|
|
3094
|
-
.map(function (
|
|
3095
|
-
var error = _a.error, llmExecutionTools = _a.llmExecutionTools;
|
|
3096
|
-
return "".concat(i + 1, ") **").concat(llmExecutionTools.title, "** thrown **").concat(error.name || 'Error', ":** ").concat(error.message);
|
|
3097
|
-
})
|
|
3032
|
+
.map(function (error, i) { return "".concat(i + 1, ") **").concat(error.name || 'Error', ":** ").concat(error.message); })
|
|
3098
3033
|
.join('\n')), "\n\n "); }));
|
|
3099
3034
|
}
|
|
3100
3035
|
else if (this.llmExecutionTools.length === 0) {
|
|
@@ -3576,17 +3511,6 @@ function getFileExtension(value) {
|
|
|
3576
3511
|
return match ? match[1].toLowerCase() : null;
|
|
3577
3512
|
}
|
|
3578
3513
|
|
|
3579
|
-
/**
|
|
3580
|
-
* Convert mime type to file extension
|
|
3581
|
-
*
|
|
3582
|
-
* Note: If the mime type is invalid, `null` is returned
|
|
3583
|
-
*
|
|
3584
|
-
* @private within the repository
|
|
3585
|
-
*/
|
|
3586
|
-
function mimeTypeToExtension(value) {
|
|
3587
|
-
return extension(value) || null;
|
|
3588
|
-
}
|
|
3589
|
-
|
|
3590
3514
|
/**
|
|
3591
3515
|
* The built-in `fetch' function with a lightweight error handling wrapper as default fetch function used in Promptbook scrapers
|
|
3592
3516
|
*
|
|
@@ -3622,9 +3546,9 @@ var scraperFetch = function (url, init) { return __awaiter(void 0, void 0, void
|
|
|
3622
3546
|
function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
|
|
3623
3547
|
var _a;
|
|
3624
3548
|
return __awaiter(this, void 0, void 0, function () {
|
|
3625
|
-
var _b, fetch, knowledgeSourceContent, name, _c, _d, rootDirname, url, response_1, mimeType,
|
|
3626
|
-
return __generator(this, function (
|
|
3627
|
-
switch (
|
|
3549
|
+
var _b, fetch, knowledgeSourceContent, name, _c, _d, rootDirname, url, response_1, mimeType, filename_1, fileExtension, mimeType;
|
|
3550
|
+
return __generator(this, function (_f) {
|
|
3551
|
+
switch (_f.label) {
|
|
3628
3552
|
case 0:
|
|
3629
3553
|
_b = tools.fetch, fetch = _b === void 0 ? scraperFetch : _b;
|
|
3630
3554
|
knowledgeSourceContent = knowledgeSource.knowledgeSourceContent;
|
|
@@ -3633,76 +3557,54 @@ function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
|
|
|
3633
3557
|
if (!name) {
|
|
3634
3558
|
name = knowledgeSourceContentToName(knowledgeSourceContent);
|
|
3635
3559
|
}
|
|
3636
|
-
if (!isValidUrl(knowledgeSourceContent)) return [3 /*break*/,
|
|
3560
|
+
if (!isValidUrl(knowledgeSourceContent)) return [3 /*break*/, 2];
|
|
3637
3561
|
url = knowledgeSourceContent;
|
|
3638
3562
|
return [4 /*yield*/, fetch(url)];
|
|
3639
3563
|
case 1:
|
|
3640
|
-
response_1 =
|
|
3564
|
+
response_1 = _f.sent();
|
|
3641
3565
|
mimeType = ((_a = response_1.headers.get('content-type')) === null || _a === void 0 ? void 0 : _a.split(';')[0]) || 'text/html';
|
|
3642
|
-
|
|
3643
|
-
|
|
3644
|
-
|
|
3645
|
-
|
|
3646
|
-
|
|
3647
|
-
|
|
3648
|
-
|
|
3649
|
-
|
|
3650
|
-
|
|
3651
|
-
|
|
3652
|
-
|
|
3653
|
-
|
|
3654
|
-
|
|
3655
|
-
|
|
3656
|
-
|
|
3657
|
-
|
|
3658
|
-
|
|
3659
|
-
|
|
3660
|
-
|
|
3661
|
-
|
|
3662
|
-
|
|
3663
|
-
|
|
3664
|
-
|
|
3665
|
-
}
|
|
3666
|
-
});
|
|
3566
|
+
return [2 /*return*/, {
|
|
3567
|
+
source: name,
|
|
3568
|
+
filename: null,
|
|
3569
|
+
url: url,
|
|
3570
|
+
mimeType: mimeType,
|
|
3571
|
+
/*
|
|
3572
|
+
TODO: [🥽]
|
|
3573
|
+
> async asBlob() {
|
|
3574
|
+
> // TODO: [👨🏻🤝👨🏻] This can be called multiple times BUT when called second time, response in already consumed
|
|
3575
|
+
> const content = await response.blob();
|
|
3576
|
+
> return content;
|
|
3577
|
+
> },
|
|
3578
|
+
*/
|
|
3579
|
+
asJson: function () {
|
|
3580
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
3581
|
+
var content;
|
|
3582
|
+
return __generator(this, function (_a) {
|
|
3583
|
+
switch (_a.label) {
|
|
3584
|
+
case 0: return [4 /*yield*/, response_1.json()];
|
|
3585
|
+
case 1:
|
|
3586
|
+
content = _a.sent();
|
|
3587
|
+
return [2 /*return*/, content];
|
|
3588
|
+
}
|
|
3667
3589
|
});
|
|
3668
|
-
}
|
|
3669
|
-
|
|
3670
|
-
|
|
3671
|
-
|
|
3672
|
-
|
|
3673
|
-
|
|
3674
|
-
|
|
3675
|
-
|
|
3676
|
-
|
|
3677
|
-
|
|
3678
|
-
|
|
3679
|
-
}
|
|
3590
|
+
});
|
|
3591
|
+
},
|
|
3592
|
+
asText: function () {
|
|
3593
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
3594
|
+
var content;
|
|
3595
|
+
return __generator(this, function (_a) {
|
|
3596
|
+
switch (_a.label) {
|
|
3597
|
+
case 0: return [4 /*yield*/, response_1.text()];
|
|
3598
|
+
case 1:
|
|
3599
|
+
content = _a.sent();
|
|
3600
|
+
return [2 /*return*/, content];
|
|
3601
|
+
}
|
|
3680
3602
|
});
|
|
3681
|
-
}
|
|
3682
|
-
}
|
|
3683
|
-
|
|
3684
|
-
basename = url.split('/').pop() || titleToName(url);
|
|
3685
|
-
hash = sha256(hexEncoder.parse(url)).toString( /* hex */);
|
|
3686
|
-
rootDirname_1 = join(process.cwd(), DEFAULT_DOWNLOAD_CACHE_DIRNAME);
|
|
3687
|
-
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));
|
|
3688
|
-
return [4 /*yield*/, tools.fs.mkdir(dirname(join(rootDirname_1, filepath)), { recursive: true })];
|
|
3603
|
+
});
|
|
3604
|
+
},
|
|
3605
|
+
}];
|
|
3689
3606
|
case 2:
|
|
3690
|
-
|
|
3691
|
-
_g = (_f = Buffer).from;
|
|
3692
|
-
return [4 /*yield*/, response_1.arrayBuffer()];
|
|
3693
|
-
case 3:
|
|
3694
|
-
fileContent = _g.apply(_f, [_h.sent()]);
|
|
3695
|
-
if (fileContent.length > DEFAULT_MAX_FILE_SIZE /* <- TODO: Allow to pass different value to remote server */) {
|
|
3696
|
-
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."));
|
|
3697
|
-
}
|
|
3698
|
-
return [4 /*yield*/, tools.fs.writeFile(join(rootDirname_1, filepath), fileContent)];
|
|
3699
|
-
case 4:
|
|
3700
|
-
_h.sent();
|
|
3701
|
-
// TODO: [💵] Check the file security
|
|
3702
|
-
// TODO: [🧹][🧠] Delete the file after the scraping is done
|
|
3703
|
-
return [2 /*return*/, makeKnowledgeSourceHandler({ name: name, knowledgeSourceContent: filepath }, tools, __assign(__assign({}, options), { rootDirname: rootDirname_1 }))];
|
|
3704
|
-
case 5:
|
|
3705
|
-
if (!isValidFilePath(knowledgeSourceContent)) return [3 /*break*/, 7];
|
|
3607
|
+
if (!isValidFilePath(knowledgeSourceContent)) return [3 /*break*/, 4];
|
|
3706
3608
|
if (tools.fs === undefined) {
|
|
3707
3609
|
throw new EnvironmentMismatchError('Can not import file knowledge without filesystem tools');
|
|
3708
3610
|
// <- TODO: [🧠] What is the best error type here`
|
|
@@ -3715,8 +3617,8 @@ function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
|
|
|
3715
3617
|
fileExtension = getFileExtension(filename_1);
|
|
3716
3618
|
mimeType = extensionToMimeType(fileExtension || '');
|
|
3717
3619
|
return [4 /*yield*/, isFileExisting(filename_1, tools.fs)];
|
|
3718
|
-
case
|
|
3719
|
-
if (!(
|
|
3620
|
+
case 3:
|
|
3621
|
+
if (!(_f.sent())) {
|
|
3720
3622
|
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 "); }));
|
|
3721
3623
|
}
|
|
3722
3624
|
// TODO: [🧠][😿] Test security file - file is scoped to the project (BUT maybe do this in `filesystemTools`)
|
|
@@ -3762,7 +3664,7 @@ function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
|
|
|
3762
3664
|
});
|
|
3763
3665
|
},
|
|
3764
3666
|
}];
|
|
3765
|
-
case
|
|
3667
|
+
case 4: return [2 /*return*/, {
|
|
3766
3668
|
source: name,
|
|
3767
3669
|
filename: null,
|
|
3768
3670
|
url: null,
|
|
@@ -6318,7 +6220,7 @@ var markitdownScraperMetadata = $deepFreeze({
|
|
|
6318
6220
|
className: 'MarkitdownScraper',
|
|
6319
6221
|
mimeTypes: [
|
|
6320
6222
|
'application/pdf',
|
|
6321
|
-
// TODO:
|
|
6223
|
+
// TODO: Make priority for scrapers and than allow all mime types here:
|
|
6322
6224
|
// 'text/html',
|
|
6323
6225
|
// 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
|
|
6324
6226
|
],
|
|
@@ -6354,10 +6256,10 @@ var MarkitdownScraper = /** @class */ (function () {
|
|
|
6354
6256
|
this.tools = tools;
|
|
6355
6257
|
this.options = options;
|
|
6356
6258
|
this.markdownScraper = new MarkdownScraper(tools, options);
|
|
6357
|
-
// Note: Module `markitdown-ts` has no types available, so it is imported using `require`
|
|
6358
6259
|
// eslint-disable-next-line @typescript-eslint/no-var-requires
|
|
6359
6260
|
var MarkItDown = require('markitdown-ts').MarkItDown;
|
|
6360
|
-
// <- TODO:
|
|
6261
|
+
// <- TODO: !!! Use Markitdown directly not through this package
|
|
6262
|
+
// <- Note: !!!!!!!
|
|
6361
6263
|
this.markitdown = new MarkItDown();
|
|
6362
6264
|
}
|
|
6363
6265
|
Object.defineProperty(MarkitdownScraper.prototype, "metadata", {
|
|
@@ -6402,12 +6304,12 @@ var MarkitdownScraper = /** @class */ (function () {
|
|
|
6402
6304
|
case 2:
|
|
6403
6305
|
if (!!(_f.sent())) return [3 /*break*/, 5];
|
|
6404
6306
|
src = source.filename || source.url || null;
|
|
6405
|
-
|
|
6307
|
+
console.log('!!!', { src: src, source: source, cacheFilehandler: cacheFilehandler });
|
|
6406
6308
|
if (src === null) {
|
|
6407
6309
|
throw new UnexpectedError('Source has no filename or url');
|
|
6408
6310
|
}
|
|
6409
6311
|
return [4 /*yield*/, this.markitdown.convert(src, {
|
|
6410
|
-
// TODO: Pass when sacraping Youtube
|
|
6312
|
+
// TODO: !!!!!! Pass when sacraping Youtube
|
|
6411
6313
|
// enableYoutubeTranscript: true,
|
|
6412
6314
|
// youtubeTranscriptLanguage: 'en',
|
|
6413
6315
|
})];
|
|
@@ -6415,12 +6317,11 @@ var MarkitdownScraper = /** @class */ (function () {
|
|
|
6415
6317
|
result = _f.sent();
|
|
6416
6318
|
if (result === null || result === undefined) {
|
|
6417
6319
|
throw new Error("Markitdown could not convert the \"".concat(source.source, "\""));
|
|
6418
|
-
// <- TODO:
|
|
6320
|
+
// <- TODO: !!! Make MarkitdownError
|
|
6419
6321
|
}
|
|
6420
|
-
|
|
6322
|
+
console.log('!!!', { result: result, cacheFilehandler: cacheFilehandler });
|
|
6421
6323
|
return [4 /*yield*/, this.tools.fs.writeFile(cacheFilehandler.filename, result.text_content)];
|
|
6422
6324
|
case 4:
|
|
6423
|
-
// console.log('!!', { result, cacheFilehandler });
|
|
6424
6325
|
_f.sent();
|
|
6425
6326
|
_f.label = 5;
|
|
6426
6327
|
case 5: return [2 /*return*/, cacheFilehandler];
|