@promptbook/node 0.85.0-9 → 0.86.0-2

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.
@@ -5,7 +5,7 @@
5
5
  */
6
6
  export declare function promptbookCli(): Promise<void>;
7
7
  /**
8
- * TODO: [🧠] Maybe `run` command the default, instead of `ptbk run ./foo.book.md` -> `ptbk ./foo.book.md`
8
+ * TODO: [🧠] Maybe `run` command the default, instead of `ptbk run ./foo.book` -> `ptbk ./foo.book`
9
9
  * TODO: [🥠] Do not export, its just for CLI script
10
10
  * TODO: [🕌] When more functionalities, rename
11
11
  * Note: 11:11
@@ -1,6 +1,6 @@
1
1
  export {};
2
2
  /**
3
- * Note: [🐠] For example here URL https://example.com/pipeline.book.md is not valid
3
+ * Note: [🐠] For example here URL https://example.com/pipeline.book is not valid
4
4
  * because it is on private network BUT its very hard to debug because
5
5
  * there is no error message and false return (the error) happen deep in:
6
6
  * `isValidPipelineUrl` -> `isValidPipelineUrl` -> `isUrlOnPrivateNetwork`
@@ -6,7 +6,7 @@ import type { PipelineCollection } from '../PipelineCollection';
6
6
  /**
7
7
  * Options for `createCollectionFromDirectory` function
8
8
  *
9
- * Note: `rootDirname` is not needed because it is the folder in which `.book.md` file is located
9
+ * Note: `rootDirname` is not needed because it is the folder in which `.book` or `.book` file is located
10
10
  * This is not same as `path` which is the first argument of `createCollectionFromDirectory` - it can be a subfolder
11
11
  */
12
12
  type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions, 'rootDirname'> & {
@@ -51,13 +51,13 @@ type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions
51
51
  *
52
52
  * Note: Works only in Node.js environment because it reads the file system
53
53
  *
54
- * @param path - path to the directory with pipelines
54
+ * @param rootPath - path to the directory with pipelines
55
55
  * @param tools - Execution tools to be used for pipeline preparation if needed - If not provided, `$provideExecutionToolsForNode` will be used
56
56
  * @param options - Options for the collection creation
57
57
  * @returns PipelineCollection
58
58
  * @public exported from `@promptbook/node`
59
59
  */
60
- export declare function createCollectionFromDirectory(path: string_dirname, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
60
+ export declare function createCollectionFromDirectory(rootPath: string_dirname, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
61
61
  export {};
62
62
  /**
63
63
  * TODO: [🖇] What about symlinks? Maybe option isSymlinksFollowed
@@ -3,7 +3,7 @@ import type { ForeachCommand } from './ForeachCommand';
3
3
  /**
4
4
  * Parses the foreach command
5
5
  *
6
- * Note: @@@ This command is used as foreach for new commands - it should NOT be used in any `.book.md` file
6
+ * Note: @@@ This command is used as foreach for new commands - it should NOT be used in any `.book` file
7
7
  *
8
8
  * @see `documentationUrl` for more details
9
9
  * @public exported from `@promptbook/editable`
@@ -3,7 +3,7 @@ import type { FormfactorCommand } from './FormfactorCommand';
3
3
  /**
4
4
  * Parses the formfactor command
5
5
  *
6
- * Note: @@@ This command is used as formfactor for new commands - it should NOT be used in any `.book.md` file
6
+ * Note: @@@ This command is used as formfactor for new commands - it should NOT be used in any `.book` file
7
7
  *
8
8
  * @see `documentationUrl` for more details
9
9
  * @public exported from `@promptbook/editable`
@@ -3,7 +3,7 @@ import type { BoilerplateCommand } from './BoilerplateCommand';
3
3
  /**
4
4
  * Parses the boilerplate command
5
5
  *
6
- * Note: @@@ This command is used as boilerplate for new commands - it should NOT be used in any `.book.md` file
6
+ * Note: @@@ This command is used as boilerplate for new commands - it should NOT be used in any `.book` file
7
7
  *
8
8
  * @see `documentationUrl` for more details
9
9
  * @private within the commands folder
@@ -2,7 +2,7 @@ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
2
2
  import type { PipelineString } from '../../pipeline/PipelineString';
3
3
  import type { string_json } from '../../types/typeAliases';
4
4
  /**
5
- * Import the pipeline.book.md or pipeline.book.json file
5
+ * Import the pipeline.book or pipeline.book.json file
6
6
  *
7
7
  * Note: Using here custom import to work in jest tests
8
8
  * Note: Using sync version is 💩 in the production code, but it's ok here in tests
@@ -10,7 +10,7 @@ import type { string_json } from '../../types/typeAliases';
10
10
  * @param path - The path to the file relative to examples/pipelines directory
11
11
  * @private internal function of tests
12
12
  */
13
- export declare function importPipelineWithoutPreparation(path: `${string}.book.md`): PipelineString;
13
+ export declare function importPipelineWithoutPreparation(path: `${string}.book`): PipelineString;
14
14
  export declare function importPipelineWithoutPreparation(path: `${string}.book.json`): PipelineJson;
15
15
  /**
16
16
  * Import the pipeline.book.json file as parsed JSON
@@ -29,12 +29,12 @@ export type PipelineJson = {
29
29
  * Note: It must be unique across all pipeline collections
30
30
  * Note: It must use HTTPs URL
31
31
  * Tip: You can do versioning in the URL
32
- * For example: https://promptbook.studio/webgpt/write-website-content-cs.book.md@1.0.0
32
+ * For example: https://promptbook.studio/webgpt/write-website-content-cs.book@1.0.0
33
33
  * Warning: Do not hash part of the URL, hash part is used for identification of the task in the pipeline
34
34
  */
35
35
  readonly pipelineUrl?: string_pipeline_url;
36
36
  /**
37
- * Internal helper for tracking the source `.book.md` file of the pipeline
37
+ * Internal helper for tracking the source `.book` file of the pipeline
38
38
  */
39
39
  readonly sourceFile?: string_filename;
40
40
  /**
@@ -95,7 +95,7 @@ export type CommonPrompt = {
95
95
  /**
96
96
  * Unique identifier of the pipeline with specific task name as hash
97
97
  *
98
- * @example https://promptbook.studio/webgpt/write-website-content-cs.book.md#keywords
98
+ * @example https://promptbook.studio/webgpt/write-website-content-cs.book#keywords
99
99
  */
100
100
  readonly pipelineUrl?: string_pipeline_url_with_task_hash;
101
101
  /**
@@ -328,13 +328,13 @@ export type string_pipeline_root_url = string;
328
328
  /**
329
329
  * Semantic helper
330
330
  *
331
- * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book.md"`
331
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book"`
332
332
  */
333
333
  export type string_pipeline_url = string;
334
334
  /**
335
335
  * Semantic helper
336
336
  *
337
- * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book.md#keywords"`
337
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book#keywords"`
338
338
  */
339
339
  export type string_pipeline_url_with_task_hash = string;
340
340
  /**
@@ -9,7 +9,7 @@ import type { string_json } from '../../../types/typeAliases';
9
9
  */
10
10
  export declare function stringifyPipelineJson<TType>(pipeline: TType): string_json<TType>;
11
11
  /**
12
- * TODO: [🐝] Not Working propperly @see https://promptbook.studio/examples/mixed-knowledge.book.md
12
+ * TODO: [🐝] Not Working propperly @see https://promptbook.studio/examples/mixed-knowledge.book
13
13
  * TODO: [🧠][0] Maybe rename to `stringifyPipelineJson`, `stringifyIndexedJson`,...
14
14
  * TODO: [🧠] Maybe more elegant solution than replacing via regex
15
15
  * TODO: [🍙] Make some standard order of json properties
@@ -19,9 +19,9 @@ declare class Wizzard {
19
19
  * Run the book
20
20
  *
21
21
  * It can be loaded from:
22
- * 1) As a file ./books/write-cv.book.md
23
- * 2) As a URL https://promptbook.studio/hejny/write-cv.book.md found in ./books folder recursively
24
- * 2) As a URL https://promptbook.studio/hejny/write-cv.book.md fetched from the internet
22
+ * 1) As a file ./books/write-cv.book
23
+ * 2) As a URL https://promptbook.studio/hejny/write-cv.book found in ./books folder recursively
24
+ * 2) As a URL https://promptbook.studio/hejny/write-cv.book fetched from the internet
25
25
  * 3) As a string
26
26
  *
27
27
  * Note: This works simmilar to the `ptbk run` command
@@ -43,9 +43,9 @@ declare class Wizzard {
43
43
  * Load book from the source
44
44
  *
45
45
  * Pipelines can be loaded from:
46
- * 1) As a file ./books/write-cv.book.md
47
- * 2) As a URL https://promptbook.studio/hejny/write-cv.book.md found in ./books folder recursively
48
- * 2) As a URL https://promptbook.studio/hejny/write-cv.book.md fetched from the internet
46
+ * 1) As a file ./books/write-cv.book
47
+ * 2) As a URL https://promptbook.studio/hejny/write-cv.book found in ./books folder recursively
48
+ * 2) As a URL https://promptbook.studio/hejny/write-cv.book fetched from the internet
49
49
  * 3) As a string
50
50
  *
51
51
  * @param pipelineSource
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/node",
3
- "version": "0.85.0-9",
3
+ "version": "0.86.0-2",
4
4
  "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -42,12 +42,12 @@
42
42
  "bugs": {
43
43
  "url": "https://github.com/webgptorg/promptbook/issues"
44
44
  },
45
- "homepage": "https://www.npmjs.com/package/@promptbook/core",
45
+ "homepage": "https://ptbk.io/",
46
46
  "main": "./umd/index.umd.js",
47
47
  "module": "./esm/index.es.js",
48
48
  "typings": "./esm/typings/src/_packages/node.index.d.ts",
49
49
  "peerDependencies": {
50
- "@promptbook/core": "0.85.0-9"
50
+ "@promptbook/core": "0.86.0-2"
51
51
  },
52
52
  "dependencies": {
53
53
  "colors": "1.4.0",
package/umd/index.umd.js CHANGED
@@ -45,7 +45,7 @@
45
45
  * @generated
46
46
  * @see https://github.com/webgptorg/promptbook
47
47
  */
48
- var PROMPTBOOK_ENGINE_VERSION = '0.85.0-8';
48
+ var PROMPTBOOK_ENGINE_VERSION = '0.86.0-1';
49
49
  /**
50
50
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
51
51
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -353,7 +353,7 @@
353
353
  * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
354
354
  */
355
355
 
356
- 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"}];
356
+ var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.book",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`\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"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-keywords.book",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`\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"},{title:"Prepare Knowledge-piece Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-title.book",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`\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"},{title:"Prepare Persona",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.book",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`\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"},{title:"Prepare Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-title.book",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`\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"}];
357
357
 
358
358
  /**
359
359
  * Checks if value is valid email
@@ -1152,57 +1152,6 @@
1152
1152
  return true;
1153
1153
  }
1154
1154
 
1155
- /**
1156
- * Checks if an URL is reserved for private networks or localhost.
1157
- *
1158
- * Note: There are two simmilar functions:
1159
- * - `isUrlOnPrivateNetwork` which tests full URL
1160
- * - `isHostnameOnPrivateNetwork` *(this one)* which tests just hostname
1161
- *
1162
- * @public exported from `@promptbook/utils`
1163
- */
1164
- function isHostnameOnPrivateNetwork(hostname) {
1165
- if (hostname === 'example.com' ||
1166
- hostname === 'localhost' ||
1167
- hostname.endsWith('.localhost') ||
1168
- hostname.endsWith('.local') ||
1169
- hostname.endsWith('.test') ||
1170
- hostname === '127.0.0.1' ||
1171
- hostname === '::1') {
1172
- return true;
1173
- }
1174
- if (hostname.includes(':')) {
1175
- // IPv6
1176
- var ipParts = hostname.split(':');
1177
- return ipParts[0] === 'fc00' || ipParts[0] === 'fd00' || ipParts[0] === 'fe80';
1178
- }
1179
- else {
1180
- // IPv4
1181
- var ipParts = hostname.split('.').map(function (part) { return Number.parseInt(part, 10); });
1182
- return (ipParts[0] === 10 ||
1183
- (ipParts[0] === 172 && ipParts[1] >= 16 && ipParts[1] <= 31) ||
1184
- (ipParts[0] === 192 && ipParts[1] === 168));
1185
- }
1186
- }
1187
-
1188
- /**
1189
- * Checks if an IP address or hostname is reserved for private networks or localhost.
1190
- *
1191
- * Note: There are two simmilar functions:
1192
- * - `isUrlOnPrivateNetwork` *(this one)* which tests full URL
1193
- * - `isHostnameOnPrivateNetwork` which tests just hostname
1194
- *
1195
- * @param {string} ipAddress - The IP address to check.
1196
- * @returns {boolean} Returns true if the IP address is reserved for private networks or localhost, otherwise false.
1197
- * @public exported from `@promptbook/utils`
1198
- */
1199
- function isUrlOnPrivateNetwork(url) {
1200
- if (typeof url === 'string') {
1201
- url = new URL(url);
1202
- }
1203
- return isHostnameOnPrivateNetwork(url.hostname);
1204
- }
1205
-
1206
1155
  /**
1207
1156
  * Tests if given string is valid pipeline URL URL.
1208
1157
  *
@@ -1216,16 +1165,19 @@
1216
1165
  if (!isValidUrl(url)) {
1217
1166
  return false;
1218
1167
  }
1219
- if (!url.startsWith('https://')) {
1168
+ if (!url.startsWith('https://') && !url.startsWith('http://') /* <- Note: [👣] */) {
1220
1169
  return false;
1221
1170
  }
1222
1171
  if (url.includes('#')) {
1223
1172
  // TODO: [🐠]
1224
1173
  return false;
1225
1174
  }
1175
+ /*
1176
+ Note: [👣][🧠] Is it secure to allow pipeline URLs on private and unsecured networks?
1226
1177
  if (isUrlOnPrivateNetwork(url)) {
1227
1178
  return false;
1228
1179
  }
1180
+ */
1229
1181
  return true;
1230
1182
  }
1231
1183
  /**
@@ -5095,7 +5047,7 @@
5095
5047
  collection = createCollectionFromJson.apply(void 0, __spreadArray([], __read(PipelineCollection), false));
5096
5048
  _b = createPipelineExecutor;
5097
5049
  _c = {};
5098
- return [4 /*yield*/, collection.getPipelineByUrl('https://promptbook.studio/promptbook/prepare-persona.book.md')];
5050
+ return [4 /*yield*/, collection.getPipelineByUrl('https://promptbook.studio/promptbook/prepare-persona.book')];
5099
5051
  case 1:
5100
5052
  preparePersonaExecutor = _b.apply(void 0, [(_c.pipeline = _d.sent(),
5101
5053
  _c.tools = tools,
@@ -6052,7 +6004,7 @@
6052
6004
  collection = createCollectionFromJson.apply(void 0, __spreadArray([], __read(PipelineCollection), false));
6053
6005
  _c = createPipelineExecutor;
6054
6006
  _d = {};
6055
- return [4 /*yield*/, collection.getPipelineByUrl('https://promptbook.studio/promptbook/prepare-title.book.md')];
6007
+ return [4 /*yield*/, collection.getPipelineByUrl('https://promptbook.studio/promptbook/prepare-title.book')];
6056
6008
  case 1:
6057
6009
  prepareTitleExecutor = _c.apply(void 0, [(_d.pipeline = _e.sent(),
6058
6010
  _d.tools = tools,
@@ -6450,7 +6402,7 @@
6450
6402
  /**
6451
6403
  * Parses the boilerplate command
6452
6404
  *
6453
- * Note: @@@ This command is used as boilerplate for new commands - it should NOT be used in any `.book.md` file
6405
+ * Note: @@@ This command is used as boilerplate for new commands - it should NOT be used in any `.book` file
6454
6406
  *
6455
6407
  * @see `documentationUrl` for more details
6456
6408
  * @private within the commands folder
@@ -7012,7 +6964,7 @@
7012
6964
  /**
7013
6965
  * Parses the foreach command
7014
6966
  *
7015
- * Note: @@@ This command is used as foreach for new commands - it should NOT be used in any `.book.md` file
6967
+ * Note: @@@ This command is used as foreach for new commands - it should NOT be used in any `.book` file
7016
6968
  *
7017
6969
  * @see `documentationUrl` for more details
7018
6970
  * @public exported from `@promptbook/editable`
@@ -7463,7 +7415,7 @@
7463
7415
  /**
7464
7416
  * Parses the formfactor command
7465
7417
  *
7466
- * Note: @@@ This command is used as formfactor for new commands - it should NOT be used in any `.book.md` file
7418
+ * Note: @@@ This command is used as formfactor for new commands - it should NOT be used in any `.book` file
7467
7419
  *
7468
7420
  * @see `documentationUrl` for more details
7469
7421
  * @public exported from `@promptbook/editable`
@@ -8124,9 +8076,9 @@
8124
8076
  * Example usages of the URL command
8125
8077
  */
8126
8078
  examples: [
8127
- 'PIPELINE URL https://promptbook.studio/library/write-cv.book.md',
8128
- 'URL https://promptbook.studio/library/write-cv.book.md',
8129
- 'https://promptbook.studio/library/write-cv.book.md',
8079
+ 'PIPELINE URL https://promptbook.studio/library/write-cv.book',
8080
+ 'URL https://promptbook.studio/library/write-cv.book',
8081
+ 'https://promptbook.studio/library/write-cv.book',
8130
8082
  ],
8131
8083
  /**
8132
8084
  * Parses the URL command
@@ -11305,13 +11257,13 @@
11305
11257
  *
11306
11258
  * Note: Works only in Node.js environment because it reads the file system
11307
11259
  *
11308
- * @param path - path to the directory with pipelines
11260
+ * @param rootPath - path to the directory with pipelines
11309
11261
  * @param tools - Execution tools to be used for pipeline preparation if needed - If not provided, `$provideExecutionToolsForNode` will be used
11310
11262
  * @param options - Options for the collection creation
11311
11263
  * @returns PipelineCollection
11312
11264
  * @public exported from `@promptbook/node`
11313
11265
  */
11314
- function createCollectionFromDirectory(path$1, tools, options) {
11266
+ function createCollectionFromDirectory(rootPath, tools, options) {
11315
11267
  return __awaiter(this, void 0, void 0, function () {
11316
11268
  var madeLibraryFilePath, _a, _b, isRecursive, _c, isVerbose, _d, isLazyLoaded, _e, isCrashedOnError, rootUrl, collection;
11317
11269
  var _this = this;
@@ -11328,7 +11280,7 @@
11328
11280
  throw new EnvironmentMismatchError('Can not create collection without filesystem tools');
11329
11281
  // <- TODO: [🧠] What is the best error type here`
11330
11282
  }
11331
- madeLibraryFilePath = path.join(path$1, "".concat(DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME
11283
+ madeLibraryFilePath = path.join(rootPath, "".concat(DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME
11332
11284
  // <- TODO: [🦒] Allow to override (pass different value into the function)
11333
11285
  , ".json"));
11334
11286
  return [4 /*yield*/, isFileExisting(madeLibraryFilePath, tools.fs)];
@@ -11347,18 +11299,18 @@
11347
11299
  switch (_b.label) {
11348
11300
  case 0:
11349
11301
  if (isVerbose) {
11350
- console.info(colors__default["default"].cyan("Creating pipeline collection from path ".concat(path$1.split('\\').join('/'))));
11302
+ console.info(colors__default["default"].cyan("Creating pipeline collection from path ".concat(rootPath.split('\\').join('/'))));
11351
11303
  }
11352
- return [4 /*yield*/, listAllFiles(path$1, isRecursive, tools.fs)];
11304
+ return [4 /*yield*/, listAllFiles(rootPath, isRecursive, tools.fs)];
11353
11305
  case 1:
11354
11306
  fileNames = _b.sent();
11355
- // Note: First load all .book.json and then .book.md files
11356
- // .book.json can be prepared so it is faster to load
11307
+ // Note: First load all `.book.json` and then `.book` / `.book` files
11308
+ // `.book.json` can be prepared so it is faster to load
11357
11309
  fileNames.sort(function (a, b) {
11358
- if (a.endsWith('.json') && b.endsWith('.md')) {
11310
+ if (a.endsWith('.json') && (b.endsWith('.book') || b.endsWith('.book'))) {
11359
11311
  return -1;
11360
11312
  }
11361
- if (a.endsWith('.md') && b.endsWith('.json')) {
11313
+ if ((a.endsWith('.book') || a.endsWith('.book')) && b.endsWith('.json')) {
11362
11314
  return 1;
11363
11315
  }
11364
11316
  return 0;
@@ -11375,7 +11327,7 @@
11375
11327
  case 1:
11376
11328
  _f.trys.push([1, 8, , 9]);
11377
11329
  pipeline = null;
11378
- if (!fileName.endsWith('.book.md')) return [3 /*break*/, 4];
11330
+ if (!(fileName.endsWith('.book') || fileName.endsWith('.book'))) return [3 /*break*/, 4];
11379
11331
  _c = validatePipelineString;
11380
11332
  return [4 /*yield*/, promises.readFile(fileName, 'utf-8')];
11381
11333
  case 2:
@@ -11407,7 +11359,8 @@
11407
11359
  if (pipeline !== null) {
11408
11360
  if (rootUrl !== undefined) {
11409
11361
  if (pipeline.pipelineUrl === undefined) {
11410
- pipelineUrl = rootUrl + '/' + fileName.split('\\').join('/');
11362
+ pipelineUrl = rootUrl + '/' + path.relative(rootPath, fileName).split('\\').join('/');
11363
+ // console.log({ pipelineUrl, rootPath, rootUrl, fileName });
11411
11364
  if (isVerbose) {
11412
11365
  console.info(colors__default["default"].yellow("Implicitly set pipeline URL to ".concat(pipelineUrl, " from ").concat(fileName
11413
11366
  .split('\\')
@@ -11537,7 +11490,7 @@
11537
11490
  return pipelineJsonStringified;
11538
11491
  }
11539
11492
  /**
11540
- * TODO: [🐝] Not Working propperly @see https://promptbook.studio/examples/mixed-knowledge.book.md
11493
+ * TODO: [🐝] Not Working propperly @see https://promptbook.studio/examples/mixed-knowledge.book
11541
11494
  * TODO: [🧠][0] Maybe rename to `stringifyPipelineJson`, `stringifyIndexedJson`,...
11542
11495
  * TODO: [🧠] Maybe more elegant solution than replacing via regex
11543
11496
  * TODO: [🍙] Make some standard order of json properties