@promptbook/website-crawler 0.72.0 → 0.73.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +33 -245
- package/esm/index.es.js +18 -18
- package/esm/index.es.js.map +1 -1
- package/esm/typings/src/commands/TEMPLATE/TemplateTypes.d.ts +1 -1
- package/esm/typings/src/config.d.ts +1 -1
- package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +3 -3
- package/esm/typings/src/conversion/utils/stringifyPipelineJson.d.ts +1 -1
- package/esm/typings/src/conversion/validation/_importPipeline.d.ts +1 -1
- package/esm/typings/src/conversion/validation/validatePipeline.d.ts +2 -2
- package/esm/typings/src/execution/createPipelineExecutor/{getSamplesForTemplate.d.ts → getExamplesForTemplate.d.ts} +1 -1
- package/esm/typings/src/formats/_common/FormatDefinition.d.ts +2 -2
- package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts +1 -1
- package/esm/typings/src/personas/preparePersona.d.ts +1 -1
- package/esm/typings/src/prepare/isPipelinePrepared.d.ts +2 -2
- package/esm/typings/src/prepare/prepareTemplates.d.ts +1 -1
- package/esm/typings/src/scrapers/document/DocumentScraper.test.d.ts +1 -1
- package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.test.d.ts +1 -1
- package/esm/typings/src/scrapers/markdown/MarkdownScraper.test.d.ts +1 -1
- package/esm/typings/src/types/PipelineJson/ParameterJson.d.ts +2 -2
- package/esm/typings/src/types/PipelineJson/PreparationJson.d.ts +1 -1
- package/package.json +4 -3
- package/umd/index.umd.js +18 -18
- package/umd/index.umd.js.map +1 -1
|
@@ -12,4 +12,4 @@ export type TemplateType = TupleToUnion<typeof TemplateTypes>;
|
|
|
12
12
|
* @see https://github.com/webgptorg/promptbook#template-type
|
|
13
13
|
* @public exported from `@promptbook/core`
|
|
14
14
|
*/
|
|
15
|
-
export declare const TemplateTypes: readonly ["PROMPT_TEMPLATE", "SIMPLE_TEMPLATE", "SCRIPT_TEMPLATE", "DIALOG_TEMPLATE", "
|
|
15
|
+
export declare const TemplateTypes: readonly ["PROMPT_TEMPLATE", "SIMPLE_TEMPLATE", "SCRIPT_TEMPLATE", "DIALOG_TEMPLATE", "EXAMPLE", "KNOWLEDGE", "INSTRUMENT", "ACTION"];
|
|
@@ -121,7 +121,7 @@ export declare const REPLACING_NONCE = "u$k42k%!V2zo34w7Fu#@QUHYPW";
|
|
|
121
121
|
*
|
|
122
122
|
* @public exported from `@promptbook/core`
|
|
123
123
|
*/
|
|
124
|
-
export declare const RESERVED_PARAMETER_NAMES: readonly ["content", "context", "knowledge", "
|
|
124
|
+
export declare const RESERVED_PARAMETER_NAMES: readonly ["content", "context", "knowledge", "examples", "modelName", "currentDate"];
|
|
125
125
|
/**
|
|
126
126
|
* @@@
|
|
127
127
|
*
|
|
@@ -22,9 +22,9 @@ export type renderPipelineMermaidOptions = {
|
|
|
22
22
|
*/
|
|
23
23
|
export declare function renderPromptbookMermaid(pipelineJson: PipelineJson, options?: renderPipelineMermaidOptions): string;
|
|
24
24
|
/**
|
|
25
|
-
* TODO:
|
|
26
|
-
* TODO:
|
|
27
|
-
* TODO:
|
|
25
|
+
* TODO: [🧠] !! FOREACH in mermaid graph
|
|
26
|
+
* TODO: [🧠] !! Knowledge in mermaid graph
|
|
27
|
+
* TODO: [🧠] !! Personas in mermaid graph
|
|
28
28
|
* TODO: Maybe use some Mermaid package instead of string templating
|
|
29
29
|
* TODO: [🕌] When more than 2 functionalities, split into separate functions
|
|
30
30
|
*/
|
|
@@ -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/
|
|
12
|
+
* TODO: [🐝] Not Working propperly @see https://promptbook.studio/examples/mixed-knowledge.ptbk.md
|
|
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
|
|
@@ -7,7 +7,7 @@ import type { string_json } from '../../types/typeAliases';
|
|
|
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
|
|
9
9
|
*
|
|
10
|
-
* @param path - The path to the file relative to
|
|
10
|
+
* @param path - The path to the file relative to examples/pipelines directory
|
|
11
11
|
* @private internal function of tests
|
|
12
12
|
*/
|
|
13
13
|
export declare function importPipelineWithoutPreparation(path: `${string}.ptbk.md`): PipelineString;
|
|
@@ -20,7 +20,7 @@ export declare function validatePipeline(pipeline: PipelineJson): PipelineJson;
|
|
|
20
20
|
*/
|
|
21
21
|
export declare function validatePipelineCore(pipeline: PipelineJson): void;
|
|
22
22
|
/**
|
|
23
|
-
* TODO:
|
|
23
|
+
* TODO: !! [🧞♀️] Do not allow joker + foreach
|
|
24
24
|
* TODO: [🧠] Work with promptbookVersion
|
|
25
25
|
* TODO: Use here some json-schema, Zod or something similar and change it to:
|
|
26
26
|
* > /**
|
|
@@ -32,7 +32,7 @@ export declare function validatePipelineCore(pipeline: PipelineJson): void;
|
|
|
32
32
|
* > ex port function validatePipeline(promptbook: really_unknown): asserts promptbook is PipelineJson {
|
|
33
33
|
*/
|
|
34
34
|
/**
|
|
35
|
-
* TODO: [🧳][main] !!!! Validate that all
|
|
35
|
+
* TODO: [🧳][main] !!!! Validate that all examples match expectations
|
|
36
36
|
* TODO: [🧳][🐝][main] !!!! Validate that knowledge is valid (non-void)
|
|
37
37
|
* TODO: [🧳][main] !!!! Validate that persona can be used only with CHAT variant
|
|
38
38
|
* TODO: [🧳][main] !!!! Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
|
|
@@ -7,4 +7,4 @@ import type { string_parameter_value } from '../../types/typeAliases';
|
|
|
7
7
|
*
|
|
8
8
|
* @private internal utility of `createPipelineExecutor`
|
|
9
9
|
*/
|
|
10
|
-
export declare function
|
|
10
|
+
export declare function getExamplesForTemplate(template: ReadonlyDeep<TemplateJson>): Promise<string_parameter_value & string_markdown>;
|
|
@@ -15,7 +15,7 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
|
|
|
15
15
|
/**
|
|
16
16
|
* The name of the format used in .ptbk.md files
|
|
17
17
|
*
|
|
18
|
-
* @
|
|
18
|
+
* @example "JSON"
|
|
19
19
|
*/
|
|
20
20
|
readonly formatName: string_name & string_SCREAMING_CASE;
|
|
21
21
|
/**
|
|
@@ -25,7 +25,7 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
|
|
|
25
25
|
/**
|
|
26
26
|
* The mime type of the format (if any)
|
|
27
27
|
*
|
|
28
|
-
* @
|
|
28
|
+
* @example "application/json"
|
|
29
29
|
*/
|
|
30
30
|
readonly mimeType?: string_mime_type;
|
|
31
31
|
/**
|
|
@@ -11,7 +11,7 @@ export type FormatSubvalueDefinition<TValue extends string, TSettings extends em
|
|
|
11
11
|
/**
|
|
12
12
|
* The name of the format used in .ptbk.md files
|
|
13
13
|
*
|
|
14
|
-
* @
|
|
14
|
+
* @example "CELL"
|
|
15
15
|
*/
|
|
16
16
|
readonly subvalueName: string_name & string_SCREAMING_CASE;
|
|
17
17
|
/**
|
|
@@ -10,7 +10,7 @@ import type { string_persona_description } from '../types/typeAliases';
|
|
|
10
10
|
*/
|
|
11
11
|
export declare function preparePersona(personaDescription: string_persona_description, tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions): Promise<PersonaPreparedJson['modelRequirements']>;
|
|
12
12
|
/**
|
|
13
|
-
* TODO: [🔃][main]
|
|
13
|
+
* TODO: [🔃][main] !! If the persona was prepared with different version or different set of models, prepare it once again
|
|
14
14
|
* TODO: [🏢] !! Check validity of `modelName` in pipeline
|
|
15
15
|
* TODO: [🏢] !! Check validity of `systemMessage` in pipeline
|
|
16
16
|
* TODO: [🏢] !! Check validity of `temperature` in pipeline
|
|
@@ -6,11 +6,11 @@ import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
|
|
|
6
6
|
*/
|
|
7
7
|
export declare function isPipelinePrepared(pipeline: PipelineJson): boolean;
|
|
8
8
|
/**
|
|
9
|
-
* TODO: [🔃][main]
|
|
9
|
+
* TODO: [🔃][main] !! If the pipeline was prepared with different version or different set of models, prepare it once again
|
|
10
10
|
* TODO: [🐠] Maybe base this on `makeValidator`
|
|
11
11
|
* TODO: [🧊] Pipeline can be partially prepared, this should return true ONLY if fully prepared
|
|
12
12
|
* TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`
|
|
13
13
|
* - [🏍] ? Is context in each template
|
|
14
|
-
* - [♨] Are
|
|
14
|
+
* - [♨] Are examples prepared
|
|
15
15
|
* - [♨] Are templates prepared
|
|
16
16
|
*/
|
|
@@ -24,7 +24,7 @@ export {};
|
|
|
24
24
|
/**
|
|
25
25
|
* TODO: [🧠] Add context to each template (if missing)
|
|
26
26
|
* TODO: [🧠] What is better name `prepareTemplate` or `prepareTemplateAndParameters`
|
|
27
|
-
* TODO: [♨][main] !!! Prepare index the
|
|
27
|
+
* TODO: [♨][main] !!! Prepare index the examples and maybe templates
|
|
28
28
|
* TODO: Write tests for `preparePipeline`
|
|
29
29
|
* TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
|
|
30
30
|
* TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
|
|
@@ -27,10 +27,10 @@ export type ParameterJson = {
|
|
|
27
27
|
*/
|
|
28
28
|
readonly description?: string_markdown_text;
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* Example values of the parameter
|
|
31
31
|
* Note: This values won't be actually used as some default values, but they are just for better understanding of the parameter
|
|
32
32
|
*/
|
|
33
|
-
readonly
|
|
33
|
+
readonly exampleValues?: Array<string_parameter_value>;
|
|
34
34
|
};
|
|
35
35
|
/**
|
|
36
36
|
* TODO: [🧠] Should be here registered subparameters from foreach or not?
|
|
@@ -18,5 +18,5 @@ export type PreparationJson = {
|
|
|
18
18
|
/**
|
|
19
19
|
* TODO: [🍙] Make some standard order of json properties
|
|
20
20
|
* TODO: Maybe put here used `modelName`
|
|
21
|
-
* TODO: [🍥] When using `date` it changes all
|
|
21
|
+
* TODO: [🍥] When using `date` it changes all examples .ptbk.json files each time so until some more elegant solution omit the time from prepared pipeline
|
|
22
22
|
*/
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@promptbook/website-crawler",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.73.0",
|
|
4
4
|
"description": "Supercharge your use of large language models",
|
|
5
5
|
"private": false,
|
|
6
6
|
"sideEffects": false,
|
|
@@ -31,7 +31,8 @@
|
|
|
31
31
|
"o1",
|
|
32
32
|
"o1-mini",
|
|
33
33
|
"o1-preview",
|
|
34
|
-
"anthropic"
|
|
34
|
+
"anthropic",
|
|
35
|
+
"LLMOps"
|
|
35
36
|
],
|
|
36
37
|
"license": "CC-BY-4.0",
|
|
37
38
|
"bugs": {
|
|
@@ -52,7 +53,7 @@
|
|
|
52
53
|
"module": "./esm/index.es.js",
|
|
53
54
|
"typings": "./esm/typings/src/_packages/website-crawler.index.d.ts",
|
|
54
55
|
"peerDependencies": {
|
|
55
|
-
"@promptbook/core": "0.
|
|
56
|
+
"@promptbook/core": "0.73.0"
|
|
56
57
|
},
|
|
57
58
|
"dependencies": {
|
|
58
59
|
"@mozilla/readability": "^0.5.0",
|
package/umd/index.umd.js
CHANGED
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
/**
|
|
15
15
|
* The version of the Promptbook library
|
|
16
16
|
*/
|
|
17
|
-
var PROMPTBOOK_VERSION = '0.72.0
|
|
17
|
+
var PROMPTBOOK_VERSION = '0.72.0';
|
|
18
18
|
// TODO: [main] !!!! List here all the versions and annotate + put into script
|
|
19
19
|
|
|
20
20
|
/*! *****************************************************************************
|
|
@@ -404,10 +404,10 @@
|
|
|
404
404
|
'content',
|
|
405
405
|
'context',
|
|
406
406
|
'knowledge',
|
|
407
|
-
'
|
|
407
|
+
'examples',
|
|
408
408
|
'modelName',
|
|
409
409
|
'currentDate',
|
|
410
|
-
// <- TODO:
|
|
410
|
+
// <- TODO: list here all command names
|
|
411
411
|
// <- TODO: Add more like 'date', 'modelName',...
|
|
412
412
|
// <- TODO: Add [emoji] + instructions ACRY when adding new reserved parameter
|
|
413
413
|
]);
|
|
@@ -1191,7 +1191,7 @@
|
|
|
1191
1191
|
* Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
|
|
1192
1192
|
*/
|
|
1193
1193
|
|
|
1194
|
-
var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md",parameters:[{name:"knowledgeContent",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledgePieces",description:"The knowledge JSON object",isInput:false,isOutput:true}],templates:[{templateType:"PROMPT_TEMPLATE",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"]}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-knowledge-from-markdown.ptbk.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-keywords.ptbk.md",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],templates:[{templateType:"PROMPT_TEMPLATE",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"]}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-knowledge-keywords.ptbk.md"},{title:"Prepare Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-title.ptbk.md",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"title",description:"The title of the document",isInput:false,isOutput:true}],templates:[{templateType:"PROMPT_TEMPLATE",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"]}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-knowledge-title.ptbk.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.ptbk.md",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}],templates:[{templateType:"PROMPT_TEMPLATE",name:"make-model-requirements",title:"Make modelRequirements",content:"You are experienced AI engineer, you need to create virtual assistant.\nWrite\n\n##
|
|
1194
|
+
var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md",parameters:[{name:"knowledgeContent",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledgePieces",description:"The knowledge JSON object",isInput:false,isOutput:true}],templates:[{templateType:"PROMPT_TEMPLATE",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"]}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-knowledge-from-markdown.ptbk.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-keywords.ptbk.md",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],templates:[{templateType:"PROMPT_TEMPLATE",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"]}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-knowledge-keywords.ptbk.md"},{title:"Prepare Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-title.ptbk.md",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"title",description:"The title of the document",isInput:false,isOutput:true}],templates:[{templateType:"PROMPT_TEMPLATE",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"]}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-knowledge-title.ptbk.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.ptbk.md",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}],templates:[{templateType:"PROMPT_TEMPLATE",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"]}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-persona.ptbk.md"}];
|
|
1195
1195
|
|
|
1196
1196
|
/**
|
|
1197
1197
|
* Prettify the html code
|
|
@@ -1835,7 +1835,7 @@
|
|
|
1835
1835
|
}
|
|
1836
1836
|
}
|
|
1837
1837
|
/**
|
|
1838
|
-
* TODO:
|
|
1838
|
+
* TODO: !! [🧞♀️] Do not allow joker + foreach
|
|
1839
1839
|
* TODO: [🧠] Work with promptbookVersion
|
|
1840
1840
|
* TODO: Use here some json-schema, Zod or something similar and change it to:
|
|
1841
1841
|
* > /**
|
|
@@ -1847,7 +1847,7 @@
|
|
|
1847
1847
|
* > ex port function validatePipeline(promptbook: really_unknown): asserts promptbook is PipelineJson {
|
|
1848
1848
|
*/
|
|
1849
1849
|
/**
|
|
1850
|
-
* TODO: [🧳][main] !!!! Validate that all
|
|
1850
|
+
* TODO: [🧳][main] !!!! Validate that all examples match expectations
|
|
1851
1851
|
* TODO: [🧳][🐝][main] !!!! Validate that knowledge is valid (non-void)
|
|
1852
1852
|
* TODO: [🧳][main] !!!! Validate that persona can be used only with CHAT variant
|
|
1853
1853
|
* TODO: [🧳][main] !!!! Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
|
|
@@ -2217,12 +2217,12 @@
|
|
|
2217
2217
|
return true;
|
|
2218
2218
|
}
|
|
2219
2219
|
/**
|
|
2220
|
-
* TODO: [🔃][main]
|
|
2220
|
+
* TODO: [🔃][main] !! If the pipeline was prepared with different version or different set of models, prepare it once again
|
|
2221
2221
|
* TODO: [🐠] Maybe base this on `makeValidator`
|
|
2222
2222
|
* TODO: [🧊] Pipeline can be partially prepared, this should return true ONLY if fully prepared
|
|
2223
2223
|
* TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`
|
|
2224
2224
|
* - [🏍] ? Is context in each template
|
|
2225
|
-
* - [♨] Are
|
|
2225
|
+
* - [♨] Are examples prepared
|
|
2226
2226
|
* - [♨] Are templates prepared
|
|
2227
2227
|
*/
|
|
2228
2228
|
|
|
@@ -2927,7 +2927,7 @@
|
|
|
2927
2927
|
});
|
|
2928
2928
|
}
|
|
2929
2929
|
/**
|
|
2930
|
-
* TODO: [🔃][main]
|
|
2930
|
+
* TODO: [🔃][main] !! If the persona was prepared with different version or different set of models, prepare it once again
|
|
2931
2931
|
* TODO: [🏢] !! Check validity of `modelName` in pipeline
|
|
2932
2932
|
* TODO: [🏢] !! Check validity of `systemMessage` in pipeline
|
|
2933
2933
|
* TODO: [🏢] !! Check validity of `temperature` in pipeline
|
|
@@ -3426,7 +3426,7 @@
|
|
|
3426
3426
|
case 0:
|
|
3427
3427
|
_a = options.maxParallelCount, maxParallelCount = _a === void 0 ? DEFAULT_MAX_PARALLEL_COUNT : _a;
|
|
3428
3428
|
templates = pipeline.templates, parameters = pipeline.parameters, knowledgePiecesCount = pipeline.knowledgePiecesCount;
|
|
3429
|
-
// TODO: [main]
|
|
3429
|
+
// TODO: [main] !! Apply examples to each template (if missing and is for the template defined)
|
|
3430
3430
|
TODO_USE(parameters);
|
|
3431
3431
|
templatesPrepared = new Array(templates.length);
|
|
3432
3432
|
return [4 /*yield*/, forEachAsync(templates, { maxParallelCount: maxParallelCount /* <- TODO: [🪂] When there are subtasks, this maximul limit can be broken */ }, function (template, index) { return __awaiter(_this, void 0, void 0, function () {
|
|
@@ -3456,7 +3456,7 @@
|
|
|
3456
3456
|
/**
|
|
3457
3457
|
* TODO: [🧠] Add context to each template (if missing)
|
|
3458
3458
|
* TODO: [🧠] What is better name `prepareTemplate` or `prepareTemplateAndParameters`
|
|
3459
|
-
* TODO: [♨][main] !!! Prepare index the
|
|
3459
|
+
* TODO: [♨][main] !!! Prepare index the examples and maybe templates
|
|
3460
3460
|
* TODO: Write tests for `preparePipeline`
|
|
3461
3461
|
* TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
|
|
3462
3462
|
* TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
|
|
@@ -4986,7 +4986,7 @@
|
|
|
4986
4986
|
var preparedPipeline, template;
|
|
4987
4987
|
return __generator(this, function (_a) {
|
|
4988
4988
|
preparedPipeline = options.preparedPipeline, template = options.template;
|
|
4989
|
-
// TODO: [♨] Implement Better - use real index and keyword search from `template` and {
|
|
4989
|
+
// TODO: [♨] Implement Better - use real index and keyword search from `template` and {examples}
|
|
4990
4990
|
TODO_USE(template);
|
|
4991
4991
|
return [2 /*return*/, preparedPipeline.knowledgePieces.map(function (_a) {
|
|
4992
4992
|
var content = _a.content;
|
|
@@ -5001,7 +5001,7 @@
|
|
|
5001
5001
|
*
|
|
5002
5002
|
* @private internal utility of `createPipelineExecutor`
|
|
5003
5003
|
*/
|
|
5004
|
-
function
|
|
5004
|
+
function getExamplesForTemplate(template) {
|
|
5005
5005
|
return __awaiter(this, void 0, void 0, function () {
|
|
5006
5006
|
return __generator(this, function (_a) {
|
|
5007
5007
|
// TODO: [♨] Implement Better - use real index and keyword search
|
|
@@ -5018,7 +5018,7 @@
|
|
|
5018
5018
|
*/
|
|
5019
5019
|
function getReservedParametersForTemplate(options) {
|
|
5020
5020
|
return __awaiter(this, void 0, void 0, function () {
|
|
5021
|
-
var preparedPipeline, template, pipelineIdentification, context, knowledge,
|
|
5021
|
+
var preparedPipeline, template, pipelineIdentification, context, knowledge, examples, currentDate, modelName, reservedParameters, _loop_1, RESERVED_PARAMETER_NAMES_1, RESERVED_PARAMETER_NAMES_1_1, parameterName;
|
|
5022
5022
|
var e_1, _a;
|
|
5023
5023
|
return __generator(this, function (_b) {
|
|
5024
5024
|
switch (_b.label) {
|
|
@@ -5030,16 +5030,16 @@
|
|
|
5030
5030
|
return [4 /*yield*/, getKnowledgeForTemplate({ preparedPipeline: preparedPipeline, template: template })];
|
|
5031
5031
|
case 2:
|
|
5032
5032
|
knowledge = _b.sent();
|
|
5033
|
-
return [4 /*yield*/,
|
|
5033
|
+
return [4 /*yield*/, getExamplesForTemplate(template)];
|
|
5034
5034
|
case 3:
|
|
5035
|
-
|
|
5035
|
+
examples = _b.sent();
|
|
5036
5036
|
currentDate = new Date().toISOString();
|
|
5037
5037
|
modelName = RESERVED_PARAMETER_MISSING_VALUE;
|
|
5038
5038
|
reservedParameters = {
|
|
5039
5039
|
content: RESERVED_PARAMETER_RESTRICTED,
|
|
5040
5040
|
context: context,
|
|
5041
5041
|
knowledge: knowledge,
|
|
5042
|
-
|
|
5042
|
+
examples: examples,
|
|
5043
5043
|
currentDate: currentDate,
|
|
5044
5044
|
modelName: modelName,
|
|
5045
5045
|
};
|
|
@@ -5698,7 +5698,7 @@
|
|
|
5698
5698
|
outputParameters = result.outputParameters;
|
|
5699
5699
|
knowledgePiecesRaw = outputParameters.knowledgePieces;
|
|
5700
5700
|
knowledgeTextPieces = (knowledgePiecesRaw || '').split('\n---\n');
|
|
5701
|
-
// <- TODO: [main]
|
|
5701
|
+
// <- TODO: [main] !! Smarter split and filter out empty pieces
|
|
5702
5702
|
if (isVerbose) {
|
|
5703
5703
|
console.info('knowledgeTextPieces:', knowledgeTextPieces);
|
|
5704
5704
|
}
|