@promptbook/cli 0.66.0-4 → 0.66.0-5
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/esm/index.es.js +42 -27
- package/esm/index.es.js.map +1 -1
- package/esm/typings/src/_packages/core.index.d.ts +6 -6
- package/esm/typings/src/_packages/types.index.d.ts +4 -0
- package/esm/typings/src/cli/cli-commands/make.d.ts +1 -1
- package/esm/typings/src/knowledge/prepare-knowledge/_common/prepareKnowledgePieces.test.d.ts +1 -1
- package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.test.d.ts +1 -1
- package/esm/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.test.d.ts +1 -1
- package/esm/typings/src/llm-providers/_common/{$llmToolsConfigurationBoilerplatesRegister.d.ts → $llmToolsMetadataRegister.d.ts} +2 -4
- package/esm/typings/src/llm-providers/_common/LlmToolsConfiguration.d.ts +5 -3
- package/esm/typings/src/llm-providers/_common/LlmToolsMetadata.d.ts +27 -0
- package/esm/typings/src/llm-providers/_common/LlmToolsOptions.d.ts +7 -0
- package/esm/typings/src/llm-providers/_common/config.d.ts +1 -1
- package/esm/typings/src/llm-providers/anthropic-claude/register-configuration.d.ts +1 -1
- package/esm/typings/src/llm-providers/anthropic-claude/register-constructor.d.ts +1 -1
- package/esm/typings/src/llm-providers/openai/register-configuration.d.ts +1 -1
- package/esm/typings/src/llm-providers/openai/register-constructor.d.ts +1 -1
- package/esm/typings/src/personas/preparePersona.test.d.ts +1 -1
- package/package.json +1 -1
- package/umd/index.umd.js +42 -27
- package/umd/index.umd.js.map +1 -1
package/esm/index.es.js
CHANGED
|
@@ -20,7 +20,7 @@ import glob from 'glob-promise';
|
|
|
20
20
|
/**
|
|
21
21
|
* The version of the Promptbook library
|
|
22
22
|
*/
|
|
23
|
-
var PROMPTBOOK_VERSION = '0.66.0-
|
|
23
|
+
var PROMPTBOOK_VERSION = '0.66.0-4';
|
|
24
24
|
// TODO: !!!! List here all the versions and annotate + put into script
|
|
25
25
|
|
|
26
26
|
/*! *****************************************************************************
|
|
@@ -835,7 +835,7 @@ function forEachAsync(array, options, callbackfunction) {
|
|
|
835
835
|
});
|
|
836
836
|
}
|
|
837
837
|
|
|
838
|
-
var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md",promptbookVersion:"0.66.0-
|
|
838
|
+
var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md",promptbookVersion:"0.66.0-4",parameters:[{name:"knowledgeContent",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledgePieces",description:"The knowledge JSON object",isInput:false,isOutput:true}],promptTemplates:[{blockType:"PROMPT_TEMPLATE",name:"knowledge",title:"Knowledge",modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},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}",dependentParameterNames:["knowledgeContent"],resultingParameterName:"knowledgePieces"}],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",promptbookVersion:"0.66.0-4",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],promptTemplates:[{blockType:"PROMPT_TEMPLATE",name:"knowledge",title:"Knowledge",modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},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}",dependentParameterNames:["knowledgePieceContent"],resultingParameterName:"keywords"}],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",promptbookVersion:"0.66.0-4",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"title",description:"The title of the document",isInput:false,isOutput:true}],promptTemplates:[{blockType:"PROMPT_TEMPLATE",name:"knowledge",title:"Knowledge",modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},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}",expectations:{words:{min:1,max:8}},dependentParameterNames:["knowledgePieceContent"],resultingParameterName:"title"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-knowledge-title.ptbk.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.ptbk.md",promptbookVersion:"0.66.0-4",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}],promptTemplates:[{blockType:"PROMPT_TEMPLATE",name:"make-model-requirements",title:"Make modelRequirements",modelRequirements:{modelVariant:"CHAT",modelName:"gpt-4-turbo"},content:"You are experienced AI engineer, you need to create virtual assistant.\nWrite\n\n## Sample\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### Option `modelName`\n\nPick from the following models:\n\n- {availableModelNames}\n\n### Option `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### Option `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}",expectFormat:"JSON",dependentParameterNames:["availableModelNames","personaDescription"],resultingParameterName:"modelRequirements"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-persona.ptbk.md"}];
|
|
839
839
|
|
|
840
840
|
/**
|
|
841
841
|
* This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
|
|
@@ -8111,7 +8111,7 @@ var createOpenAiExecutionTools = Object.assign(function (options) {
|
|
|
8111
8111
|
/**
|
|
8112
8112
|
* @@@
|
|
8113
8113
|
*
|
|
8114
|
-
* TODO: !!!!!!
|
|
8114
|
+
* TODO: !!!!!! Remove EXECUTION_TOOLS_CLASSES and use $llmToolsRegister instead
|
|
8115
8115
|
*
|
|
8116
8116
|
* @private internal type for `createLlmToolsFromConfiguration`
|
|
8117
8117
|
*/
|
|
@@ -8159,6 +8159,38 @@ function createLlmToolsFromConfiguration(configuration, options) {
|
|
|
8159
8159
|
* TODO: This should be maybe not under `_common` but under `utils`
|
|
8160
8160
|
*/
|
|
8161
8161
|
|
|
8162
|
+
/**
|
|
8163
|
+
* Register is @@@
|
|
8164
|
+
*
|
|
8165
|
+
* @private internal utility, exported are only signleton instances of this class
|
|
8166
|
+
*/
|
|
8167
|
+
var Register = /** @class */ (function () {
|
|
8168
|
+
function Register(storage) {
|
|
8169
|
+
this.storage = storage;
|
|
8170
|
+
}
|
|
8171
|
+
Register.prototype.list = function () {
|
|
8172
|
+
// <- TODO: ReadonlyDeep<Array<TRegistered>>
|
|
8173
|
+
return this.storage;
|
|
8174
|
+
};
|
|
8175
|
+
Register.prototype.register = function (registered) {
|
|
8176
|
+
// !!!!!! <- TODO: What to return here
|
|
8177
|
+
// TODO: !!!!!! Compare if same is not already registered
|
|
8178
|
+
this.storage.push(registered);
|
|
8179
|
+
};
|
|
8180
|
+
return Register;
|
|
8181
|
+
}());
|
|
8182
|
+
|
|
8183
|
+
/**
|
|
8184
|
+
* @@@
|
|
8185
|
+
*
|
|
8186
|
+
* Note: `$` is used to indicate that this interacts with the global scope
|
|
8187
|
+
* @singleton Only one instance of each register is created per build, but thare can be more @@@
|
|
8188
|
+
* @public exported from `@promptbook/core`
|
|
8189
|
+
*/
|
|
8190
|
+
var $llmToolsMetadataRegister = new Register([
|
|
8191
|
+
// TODO: !!!!!! Take from global scope
|
|
8192
|
+
]);
|
|
8193
|
+
|
|
8162
8194
|
/**
|
|
8163
8195
|
* @@@
|
|
8164
8196
|
*
|
|
@@ -8176,28 +8208,10 @@ function createLlmToolsFromConfigurationFromEnv() {
|
|
|
8176
8208
|
throw new EnvironmentMismatchError('Function `createLlmToolsFromEnv` works only in Node.js environment');
|
|
8177
8209
|
}
|
|
8178
8210
|
dotenv.config();
|
|
8179
|
-
var llmToolsConfiguration =
|
|
8180
|
-
|
|
8181
|
-
|
|
8182
|
-
|
|
8183
|
-
packageName: '@promptbook/openai',
|
|
8184
|
-
className: 'OpenAiExecutionTools',
|
|
8185
|
-
options: {
|
|
8186
|
-
apiKey: process.env.OPENAI_API_KEY,
|
|
8187
|
-
},
|
|
8188
|
-
});
|
|
8189
|
-
}
|
|
8190
|
-
if (typeof process.env.ANTHROPIC_CLAUDE_API_KEY === 'string') {
|
|
8191
|
-
llmToolsConfiguration.push({
|
|
8192
|
-
title: 'Claude (from env)',
|
|
8193
|
-
packageName: '@promptbook/antrhopic-claude',
|
|
8194
|
-
className: 'AnthropicClaudeExecutionTools',
|
|
8195
|
-
options: {
|
|
8196
|
-
apiKey: process.env.ANTHROPIC_CLAUDE_API_KEY,
|
|
8197
|
-
},
|
|
8198
|
-
});
|
|
8199
|
-
}
|
|
8200
|
-
// <- Note: [🦑] Add here new LLM provider
|
|
8211
|
+
var llmToolsConfiguration = $llmToolsMetadataRegister
|
|
8212
|
+
.list()
|
|
8213
|
+
.map(function (metadata) { return metadata.createConfigurationFromEnv(process.env); })
|
|
8214
|
+
.filter(function (configuration) { return configuration !== null; });
|
|
8201
8215
|
return llmToolsConfiguration;
|
|
8202
8216
|
}
|
|
8203
8217
|
/**
|
|
@@ -8232,7 +8246,7 @@ function createLlmToolsFromEnv(options) {
|
|
|
8232
8246
|
var configuration = createLlmToolsFromConfigurationFromEnv();
|
|
8233
8247
|
if (configuration.length === 0) {
|
|
8234
8248
|
// TODO: [🥃]
|
|
8235
|
-
throw new Error(spaceTrim("\n No LLM tools found in the environment\n\n Please set one of environment variables:\n - OPENAI_API_KEY\n - ANTHROPIC_CLAUDE_API_KEY\n "));
|
|
8249
|
+
throw new Error(spaceTrim("\n No LLM tools found in the environment\n\n !!!!!!!@@@@You have maybe forgotten to two things:\n\n Please set one of environment variables:\n - OPENAI_API_KEY\n - ANTHROPIC_CLAUDE_API_KEY\n "));
|
|
8236
8250
|
}
|
|
8237
8251
|
return createLlmToolsFromConfiguration(configuration, options);
|
|
8238
8252
|
}
|
|
@@ -8450,6 +8464,7 @@ function getLlmToolsForCli(options) {
|
|
|
8450
8464
|
* TODO: This should be maybe not under `_common` but under `utils-internal` / `utils/internal`
|
|
8451
8465
|
*/
|
|
8452
8466
|
|
|
8467
|
+
// TODO: !!!!!! Probbably all LLM tools should be registered in `@promptbook/cli`
|
|
8453
8468
|
/**
|
|
8454
8469
|
* Initializes `make` command for Promptbook CLI utilities
|
|
8455
8470
|
*
|
|
@@ -8634,7 +8649,7 @@ function initializeMakeCommand(program) {
|
|
|
8634
8649
|
});
|
|
8635
8650
|
}
|
|
8636
8651
|
/**
|
|
8637
|
-
* TODO: [🥃] !!! Allow `ptbk make` without llm tools
|
|
8652
|
+
* TODO: [🥃] !!! Allow `ptbk make` without configuring any llm tools
|
|
8638
8653
|
* TODO: Maybe remove this command - "about" command should be enough?
|
|
8639
8654
|
* TODO: [0] DRY Javascript and typescript - Maybe make ONLY typescript and for javascript just remove types
|
|
8640
8655
|
* Note: [🟡] This code should never be published outside of `@promptbook/cli`
|