@promptbook/website-crawler 0.80.0 → 0.81.0-7
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 +6 -0
- package/esm/index.es.js +142 -15
- package/esm/index.es.js.map +1 -1
- package/esm/typings/books/index.d.ts +15 -0
- package/esm/typings/src/_packages/core.index.d.ts +2 -6
- package/esm/typings/src/_packages/editable.index.d.ts +10 -0
- package/esm/typings/src/_packages/templates.index.d.ts +4 -0
- package/esm/typings/src/_packages/types.index.d.ts +4 -0
- package/esm/typings/src/_packages/utils.index.d.ts +10 -2
- package/esm/typings/src/config.d.ts +26 -0
- package/esm/typings/src/execution/ExecutionTools.d.ts +7 -0
- package/esm/typings/src/execution/PromptbookFetch.d.ts +5 -0
- package/esm/typings/src/execution/PromptbookFetch.test-type.d.ts +5 -0
- package/esm/typings/src/expectations/drafts/isDomainNameFree.d.ts +2 -1
- package/esm/typings/src/expectations/drafts/isGithubNameFree.d.ts +2 -1
- package/esm/typings/src/high-level-abstractions/index.d.ts +10 -0
- package/esm/typings/src/other/templates/getBookTemplate.d.ts +12 -0
- package/esm/typings/src/other/templates/getTemplatesPipelineCollection.d.ts +10 -0
- package/esm/typings/src/pipeline/PipelineJson/PipelineJson.d.ts +10 -0
- package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts +1 -1
- package/esm/typings/src/scrapers/_common/utils/scraperFetch.d.ts +7 -0
- package/esm/typings/src/utils/editable/types/PipelineEditableSerialized.d.ts +27 -0
- package/esm/typings/src/{conversion → utils/editable}/utils/removePipelineCommand.d.ts +3 -3
- package/esm/typings/src/{conversion → utils/editable}/utils/renamePipelineParameter.d.ts +3 -3
- package/esm/typings/src/{conversion → utils/editable}/utils/stringifyPipelineJson.d.ts +2 -2
- package/esm/typings/src/utils/parameters/numberToString.d.ts +7 -0
- package/esm/typings/src/utils/parameters/{replaceParameters.d.ts → templateParameters.d.ts} +6 -2
- package/esm/typings/src/utils/parameters/valueToString.d.ts +17 -0
- package/esm/typings/src/utils/parameters/valueToString.test.d.ts +1 -0
- package/esm/typings/src/utils/serialization/asSerializable.d.ts +4 -0
- package/esm/typings/src/version.d.ts +7 -0
- package/package.json +2 -2
- package/umd/index.umd.js +142 -15
- package/umd/index.umd.js.map +1 -1
- package/esm/typings/src/utils/formatNumber.d.ts +0 -6
- /package/esm/typings/src/{conversion → utils/editable}/utils/removePipelineCommand.test.d.ts +0 -0
- /package/esm/typings/src/{conversion → utils/editable}/utils/renamePipelineParameter.test.d.ts +0 -0
- /package/esm/typings/src/{conversion → utils/editable}/utils/stringifyPipelineJson.test.d.ts +0 -0
- /package/esm/typings/src/utils/{formatNumber.test.d.ts → parameters/numberToString.test.d.ts} +0 -0
- /package/esm/typings/src/utils/parameters/{replaceParameters.test.d.ts → templateParameters.test.d.ts} +0 -0
package/README.md
CHANGED
|
@@ -23,6 +23,10 @@
|
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
|
|
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
|
+
|
|
26
30
|
## 📦 Package `@promptbook/website-crawler`
|
|
27
31
|
|
|
28
32
|
- Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
|
|
@@ -247,6 +251,8 @@ Or you can install them separately:
|
|
|
247
251
|
- **[@promptbook/documents](https://www.npmjs.com/package/@promptbook/documents)** - Read knowledge from documents like `.docx`, `.odt`,…
|
|
248
252
|
- **[@promptbook/legacy-documents](https://www.npmjs.com/package/@promptbook/legacy-documents)** - Read knowledge from legacy documents like `.doc`, `.rtf`,…
|
|
249
253
|
- **[@promptbook/website-crawler](https://www.npmjs.com/package/@promptbook/website-crawler)** - Crawl knowledge from the web
|
|
254
|
+
- **[@promptbook/editable](https://www.npmjs.com/package/@promptbook/editable)** - Editable book as native javascript object with imperative object API
|
|
255
|
+
- **[@promptbook/templates](https://www.npmjs.com/package/@promptbook/templates)** - Usefull templates and examples of books which can be used as a starting point
|
|
250
256
|
- **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
|
|
251
257
|
- **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
|
|
252
258
|
|
package/esm/index.es.js
CHANGED
|
@@ -16,15 +16,17 @@ import { Converter } from 'showdown';
|
|
|
16
16
|
/**
|
|
17
17
|
* The version of the Book language
|
|
18
18
|
*
|
|
19
|
+
* @generated
|
|
19
20
|
* @see https://github.com/webgptorg/book
|
|
20
21
|
*/
|
|
21
22
|
var BOOK_LANGUAGE_VERSION = '1.0.0';
|
|
22
23
|
/**
|
|
23
24
|
* The version of the Promptbook engine
|
|
24
25
|
*
|
|
26
|
+
* @generated
|
|
25
27
|
* @see https://github.com/webgptorg/promptbook
|
|
26
28
|
*/
|
|
27
|
-
var PROMPTBOOK_ENGINE_VERSION = '0.
|
|
29
|
+
var PROMPTBOOK_ENGINE_VERSION = '0.81.0-6';
|
|
28
30
|
/**
|
|
29
31
|
* TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
|
|
30
32
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
@@ -234,6 +236,26 @@ var ADMIN_GITHUB_NAME = 'hejny';
|
|
|
234
236
|
* @private within the repository - too low-level in comparison with other `MAX_...`
|
|
235
237
|
*/
|
|
236
238
|
var LOOP_LIMIT = 1000;
|
|
239
|
+
/**
|
|
240
|
+
* Strings to represent various values in the context of parameter values
|
|
241
|
+
*
|
|
242
|
+
* @public exported from `@promptbook/utils`
|
|
243
|
+
*/
|
|
244
|
+
var VALUE_STRINGS = {
|
|
245
|
+
empty: '(nothing; empty string)',
|
|
246
|
+
null: '(no value; null)',
|
|
247
|
+
undefined: '(unknown value; undefined)',
|
|
248
|
+
nan: '(not a number; NaN)',
|
|
249
|
+
infinity: '(infinity; ∞)',
|
|
250
|
+
negativeInfinity: '(negative infinity; -∞)',
|
|
251
|
+
unserializable: '(unserializable value)',
|
|
252
|
+
};
|
|
253
|
+
/**
|
|
254
|
+
* Small number limit
|
|
255
|
+
*
|
|
256
|
+
* @public exported from `@promptbook/utils`
|
|
257
|
+
*/
|
|
258
|
+
var SMALL_NUMBER = 0.001;
|
|
237
259
|
/**
|
|
238
260
|
* Short time interval to prevent race conditions in milliseconds
|
|
239
261
|
*
|
|
@@ -1063,7 +1085,7 @@ function getScraperIntermediateSource(source, options) {
|
|
|
1063
1085
|
* Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
|
|
1064
1086
|
*/
|
|
1065
1087
|
|
|
1066
|
-
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:[],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:[],sourceFile:"./books/prepare-knowledge-keywords.book.md"},{title:"Prepare 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- Title should be concise and clear\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:[],sourceFile:"./books/prepare-knowledge-title.book.md"},{title:"Prepare Keywords",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:[],sourceFile:"./books/prepare-persona.book.md"}];
|
|
1088
|
+
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 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- Title should be concise and clear\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 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- Title should be concise and clear\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 Keywords",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 Keywords\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"}];
|
|
1067
1089
|
|
|
1068
1090
|
/**
|
|
1069
1091
|
* Prettify the html code
|
|
@@ -1515,6 +1537,7 @@ function exportJson(options) {
|
|
|
1515
1537
|
* @public exported from `@promptbook/core`
|
|
1516
1538
|
*/
|
|
1517
1539
|
var ORDER_OF_PIPELINE_JSON = [
|
|
1540
|
+
// Note: [🍙] In this order will be pipeline serialized
|
|
1518
1541
|
'title',
|
|
1519
1542
|
'pipelineUrl',
|
|
1520
1543
|
'bookVersion',
|
|
@@ -1526,6 +1549,7 @@ var ORDER_OF_PIPELINE_JSON = [
|
|
|
1526
1549
|
'preparations',
|
|
1527
1550
|
'knowledgeSources',
|
|
1528
1551
|
'knowledgePieces',
|
|
1552
|
+
'sources', // <- TODO: [🧠] Where should the `sources` be
|
|
1529
1553
|
];
|
|
1530
1554
|
/**
|
|
1531
1555
|
* Nonce which is used for replacing things in strings
|
|
@@ -3356,6 +3380,30 @@ function isFileExisting(filename, fs) {
|
|
|
3356
3380
|
* TODO: [🖇] What about symlinks?
|
|
3357
3381
|
*/
|
|
3358
3382
|
|
|
3383
|
+
/**
|
|
3384
|
+
* The built-in `fetch' function with a lightweight error handling wrapper as default fetch function used in Promptbook scrapers
|
|
3385
|
+
*
|
|
3386
|
+
* @private as default `fetch` function used in Promptbook scrapers
|
|
3387
|
+
*/
|
|
3388
|
+
var scraperFetch = function (url, init) { return __awaiter(void 0, void 0, void 0, function () {
|
|
3389
|
+
var error_1;
|
|
3390
|
+
return __generator(this, function (_a) {
|
|
3391
|
+
switch (_a.label) {
|
|
3392
|
+
case 0:
|
|
3393
|
+
_a.trys.push([0, 2, , 3]);
|
|
3394
|
+
return [4 /*yield*/, fetch(url, init)];
|
|
3395
|
+
case 1: return [2 /*return*/, _a.sent()];
|
|
3396
|
+
case 2:
|
|
3397
|
+
error_1 = _a.sent();
|
|
3398
|
+
if (!(error_1 instanceof Error)) {
|
|
3399
|
+
throw error_1;
|
|
3400
|
+
}
|
|
3401
|
+
throw new KnowledgeScrapeError(spaceTrim$1(function (block) { return "\n Can not fetch \"".concat(url, "\"\n\n Fetch error:\n ").concat(block(error_1.message), "\n\n "); }));
|
|
3402
|
+
case 3: return [2 /*return*/];
|
|
3403
|
+
}
|
|
3404
|
+
});
|
|
3405
|
+
}); };
|
|
3406
|
+
|
|
3359
3407
|
/**
|
|
3360
3408
|
* @@@
|
|
3361
3409
|
*
|
|
@@ -3364,13 +3412,14 @@ function isFileExisting(filename, fs) {
|
|
|
3364
3412
|
function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
|
|
3365
3413
|
var _a;
|
|
3366
3414
|
return __awaiter(this, void 0, void 0, function () {
|
|
3367
|
-
var sourceContent, name,
|
|
3368
|
-
return __generator(this, function (
|
|
3369
|
-
switch (
|
|
3415
|
+
var _b, fetch, sourceContent, name, _c, _d, rootDirname, url, response_1, mimeType, filename_1, fileExtension, mimeType;
|
|
3416
|
+
return __generator(this, function (_f) {
|
|
3417
|
+
switch (_f.label) {
|
|
3370
3418
|
case 0:
|
|
3419
|
+
_b = tools.fetch, fetch = _b === void 0 ? scraperFetch : _b;
|
|
3371
3420
|
sourceContent = knowledgeSource.sourceContent;
|
|
3372
3421
|
name = knowledgeSource.name;
|
|
3373
|
-
|
|
3422
|
+
_c = options || {}, _d = _c.rootDirname, rootDirname = _d === void 0 ? null : _d, _c.isVerbose;
|
|
3374
3423
|
if (!name) {
|
|
3375
3424
|
name = sourceContentToName(sourceContent);
|
|
3376
3425
|
}
|
|
@@ -3378,7 +3427,7 @@ function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
|
|
|
3378
3427
|
url = sourceContent;
|
|
3379
3428
|
return [4 /*yield*/, fetch(url)];
|
|
3380
3429
|
case 1:
|
|
3381
|
-
response_1 =
|
|
3430
|
+
response_1 = _f.sent();
|
|
3382
3431
|
mimeType = ((_a = response_1.headers.get('content-type')) === null || _a === void 0 ? void 0 : _a.split(';')[0]) || 'text/html';
|
|
3383
3432
|
return [2 /*return*/, {
|
|
3384
3433
|
source: name,
|
|
@@ -3435,7 +3484,7 @@ function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
|
|
|
3435
3484
|
mimeType = extensionToMimeType(fileExtension || '');
|
|
3436
3485
|
return [4 /*yield*/, isFileExisting(filename_1, tools.fs)];
|
|
3437
3486
|
case 3:
|
|
3438
|
-
if (!(
|
|
3487
|
+
if (!(_f.sent())) {
|
|
3439
3488
|
throw new NotFoundError(spaceTrim$1(function (block) { return "\n Can not make source handler for file which does not exist:\n\n File:\n ".concat(block(filename_1), "\n "); }));
|
|
3440
3489
|
}
|
|
3441
3490
|
// TODO: [🧠][😿] Test security file - file is scoped to the project (BUT maybe do this in `filesystemTools`)
|
|
@@ -4463,16 +4512,94 @@ function extractJsonBlock(markdown) {
|
|
|
4463
4512
|
* TODO: [🏢] Make this logic part of `JsonFormatDefinition` or `isValidJsonString`
|
|
4464
4513
|
*/
|
|
4465
4514
|
|
|
4515
|
+
/**
|
|
4516
|
+
* Format either small or big number
|
|
4517
|
+
*
|
|
4518
|
+
* @public exported from `@promptbook/utils`
|
|
4519
|
+
*/
|
|
4520
|
+
function numberToString(value) {
|
|
4521
|
+
if (value === 0) {
|
|
4522
|
+
return '0';
|
|
4523
|
+
}
|
|
4524
|
+
else if (Number.isNaN(value)) {
|
|
4525
|
+
return VALUE_STRINGS.nan;
|
|
4526
|
+
}
|
|
4527
|
+
else if (value === Infinity) {
|
|
4528
|
+
return VALUE_STRINGS.infinity;
|
|
4529
|
+
}
|
|
4530
|
+
else if (value === -Infinity) {
|
|
4531
|
+
return VALUE_STRINGS.negativeInfinity;
|
|
4532
|
+
}
|
|
4533
|
+
for (var exponent = 0; exponent < 15; exponent++) {
|
|
4534
|
+
var factor = Math.pow(10, exponent);
|
|
4535
|
+
var valueRounded = Math.round(value * factor) / factor;
|
|
4536
|
+
if (Math.abs(value - valueRounded) / value < SMALL_NUMBER) {
|
|
4537
|
+
return valueRounded.toFixed(exponent);
|
|
4538
|
+
}
|
|
4539
|
+
}
|
|
4540
|
+
return value.toString();
|
|
4541
|
+
}
|
|
4542
|
+
|
|
4543
|
+
/**
|
|
4544
|
+
* Function `valueToString` will convert the given value to string
|
|
4545
|
+
* This is useful and used in the `templateParameters` function
|
|
4546
|
+
*
|
|
4547
|
+
* Note: This function is not just calling `toString` method
|
|
4548
|
+
* It's more complex and can handle this conversion specifically for LLM models
|
|
4549
|
+
* See `VALUE_STRINGS`
|
|
4550
|
+
*
|
|
4551
|
+
* Note: There are 2 similar functions
|
|
4552
|
+
* - `valueToString` converts value to string for LLM models as human-readable string
|
|
4553
|
+
* - `asSerializable` converts value to string to preserve full information to be able to convert it back
|
|
4554
|
+
*
|
|
4555
|
+
* @public exported from `@promptbook/utils`
|
|
4556
|
+
*/
|
|
4557
|
+
function valueToString(value) {
|
|
4558
|
+
try {
|
|
4559
|
+
if (value === '') {
|
|
4560
|
+
return VALUE_STRINGS.empty;
|
|
4561
|
+
}
|
|
4562
|
+
else if (value === null) {
|
|
4563
|
+
return VALUE_STRINGS.null;
|
|
4564
|
+
}
|
|
4565
|
+
else if (value === undefined) {
|
|
4566
|
+
return VALUE_STRINGS.undefined;
|
|
4567
|
+
}
|
|
4568
|
+
else if (typeof value === 'string') {
|
|
4569
|
+
return value;
|
|
4570
|
+
}
|
|
4571
|
+
else if (typeof value === 'number') {
|
|
4572
|
+
return numberToString(value);
|
|
4573
|
+
}
|
|
4574
|
+
else if (value instanceof Date) {
|
|
4575
|
+
return value.toISOString();
|
|
4576
|
+
}
|
|
4577
|
+
else {
|
|
4578
|
+
return JSON.stringify(value);
|
|
4579
|
+
}
|
|
4580
|
+
}
|
|
4581
|
+
catch (error) {
|
|
4582
|
+
if (!(error instanceof Error)) {
|
|
4583
|
+
throw error;
|
|
4584
|
+
}
|
|
4585
|
+
console.error(error);
|
|
4586
|
+
return VALUE_STRINGS.unserializable;
|
|
4587
|
+
}
|
|
4588
|
+
}
|
|
4589
|
+
|
|
4466
4590
|
/**
|
|
4467
4591
|
* Replaces parameters in template with values from parameters object
|
|
4468
4592
|
*
|
|
4593
|
+
* Note: This function is not places strings into string,
|
|
4594
|
+
* It's more complex and can handle this operation specifically for LLM models
|
|
4595
|
+
*
|
|
4469
4596
|
* @param template the template with parameters in {curly} braces
|
|
4470
4597
|
* @param parameters the object with parameters
|
|
4471
4598
|
* @returns the template with replaced parameters
|
|
4472
4599
|
* @throws {PipelineExecutionError} if parameter is not defined, not closed, or not opened
|
|
4473
4600
|
* @public exported from `@promptbook/utils`
|
|
4474
4601
|
*/
|
|
4475
|
-
function
|
|
4602
|
+
function templateParameters(template, parameters) {
|
|
4476
4603
|
var e_1, _a;
|
|
4477
4604
|
try {
|
|
4478
4605
|
for (var _b = __values(Object.entries(parameters)), _c = _b.next(); !_c.done; _c = _b.next()) {
|
|
@@ -4498,7 +4625,7 @@ function replaceParameters(template, parameters) {
|
|
|
4498
4625
|
var loopLimit = LOOP_LIMIT;
|
|
4499
4626
|
var _loop_1 = function () {
|
|
4500
4627
|
if (loopLimit-- < 0) {
|
|
4501
|
-
throw new LimitReachedError('Loop limit reached during parameters replacement in `
|
|
4628
|
+
throw new LimitReachedError('Loop limit reached during parameters replacement in `templateParameters`');
|
|
4502
4629
|
}
|
|
4503
4630
|
var precol = match.groups.precol;
|
|
4504
4631
|
var parameterName = match.groups.parameterName;
|
|
@@ -4515,7 +4642,7 @@ function replaceParameters(template, parameters) {
|
|
|
4515
4642
|
if (parameterValue === undefined) {
|
|
4516
4643
|
throw new PipelineExecutionError("Parameter `{".concat(parameterName, "}` is not defined"));
|
|
4517
4644
|
}
|
|
4518
|
-
parameterValue = parameterValue
|
|
4645
|
+
parameterValue = valueToString(parameterValue);
|
|
4519
4646
|
if (parameterValue.includes('\n') && /^\s*\W{0,3}\s*$/.test(precol)) {
|
|
4520
4647
|
parameterValue = parameterValue
|
|
4521
4648
|
.split('\n')
|
|
@@ -4750,7 +4877,7 @@ function executeAttempts(options) {
|
|
|
4750
4877
|
}
|
|
4751
4878
|
return [3 /*break*/, 24];
|
|
4752
4879
|
case 2:
|
|
4753
|
-
$ongoingTaskResult.$resultString =
|
|
4880
|
+
$ongoingTaskResult.$resultString = templateParameters(preparedContent, parameters);
|
|
4754
4881
|
return [3 /*break*/, 25];
|
|
4755
4882
|
case 3:
|
|
4756
4883
|
modelRequirements = __assign(__assign({ modelVariant: 'CHAT' }, (preparedPipeline.defaultModelRequirements || {})), (task.modelRequirements || {}));
|
|
@@ -4873,8 +5000,8 @@ function executeAttempts(options) {
|
|
|
4873
5000
|
_j = $ongoingTaskResult;
|
|
4874
5001
|
return [4 /*yield*/, tools.userInterface.promptDialog($deepFreeze({
|
|
4875
5002
|
promptTitle: task.title,
|
|
4876
|
-
promptMessage:
|
|
4877
|
-
defaultValue:
|
|
5003
|
+
promptMessage: templateParameters(task.description || '', parameters),
|
|
5004
|
+
defaultValue: templateParameters(preparedContent, parameters),
|
|
4878
5005
|
// TODO: [🧠] !! Figure out how to define placeholder in .book.md file
|
|
4879
5006
|
placeholder: undefined,
|
|
4880
5007
|
priority: priority,
|
|
@@ -4998,7 +5125,7 @@ function executeAttempts(options) {
|
|
|
4998
5125
|
if (!isJokerAttempt &&
|
|
4999
5126
|
task.taskType === 'PROMPT_TASK' &&
|
|
5000
5127
|
$ongoingTaskResult.$prompt
|
|
5001
|
-
// <- Note: [2] When some expected parameter is not defined, error will occur in
|
|
5128
|
+
// <- Note: [2] When some expected parameter is not defined, error will occur in templateParameters
|
|
5002
5129
|
// In that case we don’t want to make a report about it because it’s not a llm execution error
|
|
5003
5130
|
) {
|
|
5004
5131
|
// TODO: [🧠] Maybe put other taskTypes into report
|