@promptbook/core 0.92.0-27 → 0.92.0-29

package/esm/index.es.js

@@ -27,7 +27,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.92.0-27';
+const PROMPTBOOK_ENGINE_VERSION = '0.92.0-29';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -1099,6 +1099,42 @@ function exportJson(options) {
  * TODO: [🧠] Is there a way how to meaningfully test this utility
  */
 
+/**
+ * How is the model provider trusted?
+ *
+ * @public exported from `@promptbook/core`
+ */
+const MODEL_TRUST_LEVELS = {
+    FULL: `Model is running on the local machine, training data and model weights are known, data are ethically sourced`,
+    OPEN: `Model is open source, training data and model weights are known`,
+    PARTIALLY_OPEN: `Model is open source, but training data and model weights are not (fully) known`,
+    CLOSED_LOCAL: `Model can be run locally, but it is not open source`,
+    CLOSED_FREE: `Model is behind API gateway but free to use`,
+    CLOSED_BUSINESS: `Model is behind API gateway and paid but has good SLA, TOS, privacy policy and in general is a good to use in business applications`,
+    CLOSED: `Model is behind API gateway and paid`,
+    UNTRUSTED: `Model has questions about the training data and ethics, but it is not known if it is a problem or not`,
+    VURNABLE: `Model has some known serious vulnerabilities, leaks, ethical problems, etc.`,
+};
+// <- TODO: Maybe do better levels of trust
+/**
+ * How is the model provider important?
+ *
+ * @public exported from `@promptbook/core`
+ */
+const MODEL_ORDERS = {
+    /**
+     * Top-tier models, e.g. OpenAI, Anthropic,...
+     */
+    TOP_TIER: 333,
+    /**
+     * Mid-tier models, e.g. Llama, Mistral, etc.
+     */
+    NORMAL: 100,
+    /**
+     * Low-tier models, e.g. Phi, Tiny, etc.
+     */
+    LOW_TIER: 0,
+};
 /**
  * Order of keys in the pipeline JSON
  *
@@ -2780,7 +2816,7 @@ function union(...sets) {
 }
 
 /**
- * @@@
+ * Contains configuration options for parsing and generating CSV files, such as delimiters and quoting rules.
  *
  * @public exported from `@promptbook/core`
  */
@@ -3989,8 +4025,12 @@ function isPassingExpectations(expectations, value) {
  */
 
 /**
- * @@@
+ * Executes a pipeline task with multiple attempts, including joker and retry logic. Handles different task types
+ * (prompt, script, dialog, etc.), applies postprocessing, checks expectations, and updates the execution report.
+ * Throws errors if execution fails after all attempts.
  *
+ * @param options - The options for execution, including task, parameters, pipeline, and configuration.
+ * @returns The result string of the executed task.
  * @private internal utility of `createPipelineExecutor`
  */
 async function executeAttempts(options) {
@@ -4448,8 +4488,12 @@ async function executeFormatSubvalues(options) {
 }
 
 /**
- * @@@
+ * Returns the context for a given task, typically used to provide additional information or variables
+ * required for the execution of the task within a pipeline. The context is returned as a string value
+ * that may include markdown formatting.
  *
+ * @param task - The task for which the context is being generated. This should be a deeply immutable TaskJson object.
+ * @returns The context as a string, formatted as markdown and parameter value.
  * @private internal utility of `createPipelineExecutor`
  */
 async function getContextForTask(task) {
@@ -4457,7 +4501,7 @@ async function getContextForTask(task) {
 }
 
 /**
- * @@@
+ * Retrieves example values or templates for a given task, used to guide or validate pipeline execution.
  *
  * @private internal utility of `createPipelineExecutor`
  */
@@ -4504,9 +4548,8 @@ function knowledgePiecesToString(knowledgePieces) {
 }
 
 /**
- * @@@
- *
- * Here is the place where RAG (retrieval-augmented generation) happens
+ * Retrieves the most relevant knowledge pieces for a given task using embedding-based similarity search.
+ * This is where retrieval-augmented generation (RAG) is performed to enhance the task with external knowledge.
  *
  * @private internal utility of `createPipelineExecutor`
  */
@@ -4725,7 +4768,8 @@ async function executeTask(options) {
  */
 
 /**
- * @@@
+ * Filters and returns only the output parameters from the provided pipeline execution options.
+ * Adds warnings for any expected output parameters that are missing.
  *
  * @private internal utility of `createPipelineExecutor`
  */
@@ -7035,8 +7079,6 @@ function validateParameterName(parameterName) {
 /**
  * Parses the foreach command
  *
- * Note: @@@ This command is used as foreach for new commands - it should NOT be used in any `.book` file
- *
  * @see `documentationUrl` for more details
  * @public exported from `@promptbook/editable`
  */
@@ -7277,14 +7319,14 @@ const formatCommandParser = {
 };
 
 /**
- * @@@
+ * Chatbot form factor definition for conversational interfaces that interact with users in a chat-like manner.
  *
  * @public exported from `@promptbook/core`
  */
 const ChatbotFormfactorDefinition = {
     name: 'CHATBOT',
     aliasNames: ['CHAT'],
-    description: `@@@`,
+    description: `A chatbot form factor for conversational user interfaces.`,
     documentationUrl: `https://github.com/webgptorg/promptbook/discussions/174`,
     pipelineInterface: {
         inputParameters: [
@@ -7317,7 +7359,7 @@ const ChatbotFormfactorDefinition = {
  */
 const CompletionFormfactorDefinition = {
     name: 'COMPLETION',
-    description: `@@@`,
+    description: `Completion is formfactor that emulates completion models`,
     documentationUrl: `https://github.com/webgptorg/promptbook/discussions/@@`,
     //                                                                     <- TODO: https://github.com/webgptorg/promptbook/discussions/new?category=concepts
     //                                                                              "🔠 Completion Formfactor"
@@ -7348,7 +7390,8 @@ const CompletionFormfactorDefinition = {
 };
 
 /**
- * Generator is form of app that @@@
+ * Generator form factor represents an application that generates content or data based on user input or predefined rules.
+ * This form factor is used for apps that produce outputs, such as text, images, or other media, based on provided input.
  *
  * @public exported from `@promptbook/core`
  */
@@ -7392,13 +7435,13 @@ const GENERIC_PIPELINE_INTERFACE = {
  */
 
 /**
- * @@@
+ * A generic pipeline
  *
  * @public exported from `@promptbook/core`
  */
 const GenericFormfactorDefinition = {
     name: 'GENERIC',
-    description: `@@@`,
+    description: `A generic pipeline`,
     documentationUrl: `https://github.com/webgptorg/promptbook/discussions/173`,
     pipelineInterface: GENERIC_PIPELINE_INTERFACE,
 };
@@ -9734,13 +9777,16 @@ function addAutoGeneratedSection(content, options) {
  */
 function renderPromptbookMermaid(pipelineJson, options) {
     const { linkTask = () => null } = options || {};
+    const MERMAID_PREFIX = 'mermaid_';
+    const KNOWLEDGE_NAME = MERMAID_PREFIX + 'knowledge';
+    const RESERVED_NAME = MERMAID_PREFIX + 'reserved';
     const parameterNameToTaskName = (parameterName) => {
         if (parameterName === 'knowledge') {
-            return 'knowledge';
+            return KNOWLEDGE_NAME;
             // <- TODO: !!!! Check that this works
         }
         else if (RESERVED_PARAMETER_NAMES.includes(parameterName)) {
-            return 'reserved';
+            return RESERVED_NAME;
         }
         const parameter = pipelineJson.parameters.find((parameter) => parameter.name === parameterName);
         if (!parameter) {
@@ -9748,13 +9794,13 @@ function renderPromptbookMermaid(pipelineJson, options) {
             // <- TODO: !!6 This causes problems when {knowledge} and other reserved parameters are used
         }
         if (parameter.isInput) {
-            return 'input';
+            return MERMAID_PREFIX + 'input';
         }
         const task = pipelineJson.tasks.find((task) => task.resultingParameterName === parameterName);
         if (!task) {
             throw new Error(`Could not find task for {${parameterName}}`);
         }
-        return task.name || normalizeTo_camelCase('task-' + titleToName(task.title));
+        return MERMAID_PREFIX + (task.name || normalizeTo_camelCase('task-' + titleToName(task.title)));
     };
     const promptbookMermaid = spaceTrim$1((block) => `
 
@@ -9766,8 +9812,8 @@ function renderPromptbookMermaid(pipelineJson, options) {
                   direction TB
 
                   input((Input)):::input
-                  other((Other)):::other
-                  knowledge((Knowledgebase)):::knowledge
+                  ${RESERVED_NAME}((Other)):::${RESERVED_NAME}
+                  ${KNOWLEDGE_NAME}((Knowledgebase)):::${KNOWLEDGE_NAME}
                   ${block(pipelineJson.tasks
         .flatMap(({ title, dependentParameterNames, resultingParameterName }) => [
         `${parameterNameToTaskName(resultingParameterName)}("${title}")`,
@@ -10565,48 +10611,6 @@ function createLlmToolsFromConfiguration(configuration, options = {}) {
  * TODO: [®] DRY Register logic
  */
 
-/**
- * How is the model provider trusted?
- *
- * @public exported from `@promptbook/core`
- */
-const MODEL_TRUST_LEVEL = {
-    FULL: `Model is running on the local machine, training data and model weights are known, data are ethically sourced`,
-    OPEN: `Model is open source, training data and model weights are known`,
-    PARTIALLY_OPEN: `Model is open source, but training data and model weights are not (fully) known`,
-    CLOSED_LOCAL: `Model can be run locally, but it is not open source`,
-    CLOSED_FREE: `Model is behind API gateway but free to use`,
-    CLOSED_BUSINESS: `Model is behind API gateway and paid but has good SLA, TOS, privacy policy and in general is a good to use in business applications`,
-    CLOSED: `Model is behind API gateway and paid`,
-    UNTRUSTED: `Model has questions about the training data and ethics, but it is not known if it is a problem or not`,
-    VURNABLE: `Model has some known serious vulnerabilities, leaks, ethical problems, etc.`,
-};
-// <- TODO: Maybe do better levels of trust
-/**
- * How is the model provider important?
- *
- * @public exported from `@promptbook/core`
- */
-const MODEL_ORDER = {
-    /**
-     * Top-tier models, e.g. OpenAI, Anthropic,...
-     */
-    TOP_TIER: 333,
-    /**
-     * Mid-tier models, e.g. Llama, Mistral, etc.
-     */
-    NORMAL: 100,
-    /**
-     * Low-tier models, e.g. Phi, Tiny, etc.
-     */
-    LOW_TIER: 0,
-};
-/**
- * TODO: Add configuration schema and maybe some documentation link
- * TODO: Maybe constrain LlmToolsConfiguration[number] by generic to ensure that `createConfigurationFromEnv` and `getBoilerplateConfiguration` always create same `packageName` and `className`
- * TODO: [®] DRY Register logic
- */
-
 /**
  * Stores data in memory (HEAP)
  *
@@ -10839,7 +10843,7 @@ const _AnthropicClaudeMetadataRegistration = $llmToolsMetadataRegister.register(
     className: 'AnthropicClaudeExecutionTools',
     envVariables: ['ANTHROPIC_CLAUDE_API_KEY'],
     trustLevel: 'CLOSED',
-    order: MODEL_ORDER.TOP_TIER,
+    order: MODEL_ORDERS.TOP_TIER,
     getBoilerplateConfiguration() {
         return {
             title: 'Anthropic Claude',
@@ -10886,7 +10890,7 @@ const _AzureOpenAiMetadataRegistration = $llmToolsMetadataRegister.register({
     className: 'AzureOpenAiExecutionTools',
     envVariables: ['AZUREOPENAI_RESOURCE_NAME', 'AZUREOPENAI_DEPLOYMENT_NAME', 'AZUREOPENAI_API_KEY'],
     trustLevel: 'CLOSED_BUSINESS',
-    order: MODEL_ORDER.NORMAL,
+    order: MODEL_ORDERS.NORMAL,
     getBoilerplateConfiguration() {
         return {
             title: 'Azure Open AI',
@@ -10974,7 +10978,7 @@ const _DeepseekMetadataRegistration = $llmToolsMetadataRegister.register({
     className: 'DeepseekExecutionTools',
     envVariables: ['DEEPSEEK_GENERATIVE_AI_API_KEY'],
     trustLevel: 'UNTRUSTED',
-    order: MODEL_ORDER.NORMAL,
+    order: MODEL_ORDERS.NORMAL,
     getBoilerplateConfiguration() {
         return {
             title: 'Deepseek',
@@ -11025,7 +11029,7 @@ const _GoogleMetadataRegistration = $llmToolsMetadataRegister.register({
     className: 'GoogleExecutionTools',
     envVariables: ['GOOGLE_GENERATIVE_AI_API_KEY'],
     trustLevel: 'CLOSED',
-    order: MODEL_ORDER.NORMAL,
+    order: MODEL_ORDERS.NORMAL,
     getBoilerplateConfiguration() {
         return {
             title: 'Google Gemini',
@@ -11076,7 +11080,7 @@ const _OpenAiMetadataRegistration = $llmToolsMetadataRegister.register({
     className: 'OpenAiExecutionTools',
     envVariables: ['OPENAI_API_KEY'],
     trustLevel: 'CLOSED',
-    order: MODEL_ORDER.TOP_TIER,
+    order: MODEL_ORDERS.TOP_TIER,
     getBoilerplateConfiguration() {
         return {
             title: 'Open AI',
@@ -11104,9 +11108,9 @@ const _OpenAiMetadataRegistration = $llmToolsMetadataRegister.register({
     },
 });
 /**
- * @@@ registration1 of default configuration for Open AI
+ * Registration of the OpenAI Assistant metadata
  *
- * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
+ * Note: [🏐] Configurations registrations are done in the metadata registration section, but the constructor registration is handled separately.
  *
  * @public exported from `@promptbook/core`
  * @public exported from `@promptbook/wizzard`
@@ -11119,7 +11123,7 @@ const _OpenAiAssistantMetadataRegistration = $llmToolsMetadataRegister.register(
     envVariables: null,
     //            <- TODO: ['OPENAI_API_KEY', 'OPENAI_ASSISTANT_ID']
     trustLevel: 'CLOSED',
-    order: MODEL_ORDER.NORMAL,
+    order: MODEL_ORDERS.NORMAL,
     getBoilerplateConfiguration() {
         return {
             title: 'Open AI Assistant',
@@ -11632,5 +11636,5 @@ class PrefixStorage {
     }
 }
 
-export { $llmToolsMetadataRegister, $llmToolsRegister, $scrapersMetadataRegister, $scrapersRegister, ADMIN_EMAIL, ADMIN_GITHUB_NAME, AbstractFormatError, AuthenticationError, BIG_DATASET_TRESHOLD, BOOK_LANGUAGE_VERSION, BlackholeStorage, BoilerplateError, BoilerplateFormfactorDefinition, CLAIM, CLI_APP_ID, CallbackInterfaceTools, ChatbotFormfactorDefinition, CollectionError, CompletionFormfactorDefinition, CsvFormatError, CsvFormatParser, DEFAULT_BOOKS_DIRNAME, DEFAULT_BOOK_OUTPUT_PARAMETER_NAME, DEFAULT_BOOK_TITLE, DEFAULT_CSV_SETTINGS, DEFAULT_DOWNLOAD_CACHE_DIRNAME, DEFAULT_EXECUTION_CACHE_DIRNAME, DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME, DEFAULT_INTERMEDIATE_FILES_STRATEGY, DEFAULT_IS_AUTO_INSTALLED, DEFAULT_IS_VERBOSE, DEFAULT_MAX_EXECUTION_ATTEMPTS, DEFAULT_MAX_FILE_SIZE, DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH, DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL, DEFAULT_MAX_PARALLEL_COUNT, DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME, DEFAULT_PROMPT_TASK_TITLE, DEFAULT_REMOTE_SERVER_URL, DEFAULT_RPM, DEFAULT_SCRAPE_CACHE_DIRNAME, DEFAULT_TASK_TITLE, EXPECTATION_UNITS, EnvironmentMismatchError, ExecutionReportStringOptionsDefaults, ExpectError, FAILED_VALUE_PLACEHOLDER, FORMFACTOR_DEFINITIONS, GENERIC_PIPELINE_INTERFACE, GeneratorFormfactorDefinition, GenericFormfactorDefinition, ImageGeneratorFormfactorDefinition, KnowledgeScrapeError, LimitReachedError, MANDATORY_CSV_SETTINGS, MAX_FILENAME_LENGTH, MODEL_ORDER, MODEL_TRUST_LEVEL, MODEL_VARIANTS, MatcherFormfactorDefinition, MemoryStorage, MissingToolsError, MultipleLlmExecutionTools, NAME, NonTaskSectionTypes, NotFoundError, NotYetImplementedError, ORDER_OF_PIPELINE_JSON, PENDING_VALUE_PLACEHOLDER, PLAYGROUND_APP_ID, PROMPTBOOK_ENGINE_VERSION, PROMPTBOOK_ERRORS, ParseError, PipelineExecutionError, PipelineLogicError, PipelineUrlError, PrefixStorage, PromptbookFetchError, REMOTE_SERVER_URLS, RESERVED_PARAMETER_NAMES, SET_IS_VERBOSE, SectionTypes, SheetsFormfactorDefinition, TaskTypes, TextFormatParser, TranslatorFormfactorDefinition, UNCERTAIN_USAGE, UNCERTAIN_ZERO_VALUE, UnexpectedError, WrappedError, ZERO_USAGE, ZERO_VALUE, _AnthropicClaudeMetadataRegistration, _AzureOpenAiMetadataRegistration, _BoilerplateScraperMetadataRegistration, _DeepseekMetadataRegistration, _DocumentScraperMetadataRegistration, _GoogleMetadataRegistration, _LegacyDocumentScraperMetadataRegistration, _MarkdownScraperMetadataRegistration, _MarkitdownScraperMetadataRegistration, _OpenAiAssistantMetadataRegistration, _OpenAiMetadataRegistration, _PdfScraperMetadataRegistration, _WebsiteScraperMetadataRegistration, addUsage, book, cacheLlmTools, collectionToJson, compilePipeline, computeCosineSimilarity, countUsage, createCollectionFromJson, createCollectionFromPromise, createCollectionFromUrl, createLlmToolsFromConfiguration, createPipelineExecutor, createSubcollection, embeddingVectorToString, executionReportJsonToString, extractParameterNamesFromTask, filterModels, getPipelineInterface, identificationToPromptbookToken, isPassingExpectations, isPipelineImplementingInterface, isPipelineInterfacesEqual, isPipelinePrepared, isValidPipelineString, joinLlmExecutionTools, limitTotalUsage, makeKnowledgeSourceHandler, migratePipeline, parsePipeline, pipelineJsonToString, prepareKnowledgePieces, preparePersona, preparePipeline, prettifyPipelineString, promptbookFetch, promptbookTokenToIdentification, unpreparePipeline, usageToHuman, usageToWorktime, validatePipeline, validatePipelineString };
+export { $llmToolsMetadataRegister, $llmToolsRegister, $scrapersMetadataRegister, $scrapersRegister, ADMIN_EMAIL, ADMIN_GITHUB_NAME, AbstractFormatError, AuthenticationError, BIG_DATASET_TRESHOLD, BOOK_LANGUAGE_VERSION, BlackholeStorage, BoilerplateError, BoilerplateFormfactorDefinition, CLAIM, CLI_APP_ID, CallbackInterfaceTools, ChatbotFormfactorDefinition, CollectionError, CompletionFormfactorDefinition, CsvFormatError, CsvFormatParser, DEFAULT_BOOKS_DIRNAME, DEFAULT_BOOK_OUTPUT_PARAMETER_NAME, DEFAULT_BOOK_TITLE, DEFAULT_CSV_SETTINGS, DEFAULT_DOWNLOAD_CACHE_DIRNAME, DEFAULT_EXECUTION_CACHE_DIRNAME, DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME, DEFAULT_INTERMEDIATE_FILES_STRATEGY, DEFAULT_IS_AUTO_INSTALLED, DEFAULT_IS_VERBOSE, DEFAULT_MAX_EXECUTION_ATTEMPTS, DEFAULT_MAX_FILE_SIZE, DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH, DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL, DEFAULT_MAX_PARALLEL_COUNT, DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME, DEFAULT_PROMPT_TASK_TITLE, DEFAULT_REMOTE_SERVER_URL, DEFAULT_RPM, DEFAULT_SCRAPE_CACHE_DIRNAME, DEFAULT_TASK_TITLE, EXPECTATION_UNITS, EnvironmentMismatchError, ExecutionReportStringOptionsDefaults, ExpectError, FAILED_VALUE_PLACEHOLDER, FORMFACTOR_DEFINITIONS, GENERIC_PIPELINE_INTERFACE, GeneratorFormfactorDefinition, GenericFormfactorDefinition, ImageGeneratorFormfactorDefinition, KnowledgeScrapeError, LimitReachedError, MANDATORY_CSV_SETTINGS, MAX_FILENAME_LENGTH, MODEL_ORDERS, MODEL_TRUST_LEVELS, MODEL_VARIANTS, MatcherFormfactorDefinition, MemoryStorage, MissingToolsError, MultipleLlmExecutionTools, NAME, NonTaskSectionTypes, NotFoundError, NotYetImplementedError, ORDER_OF_PIPELINE_JSON, PENDING_VALUE_PLACEHOLDER, PLAYGROUND_APP_ID, PROMPTBOOK_ENGINE_VERSION, PROMPTBOOK_ERRORS, ParseError, PipelineExecutionError, PipelineLogicError, PipelineUrlError, PrefixStorage, PromptbookFetchError, REMOTE_SERVER_URLS, RESERVED_PARAMETER_NAMES, SET_IS_VERBOSE, SectionTypes, SheetsFormfactorDefinition, TaskTypes, TextFormatParser, TranslatorFormfactorDefinition, UNCERTAIN_USAGE, UNCERTAIN_ZERO_VALUE, UnexpectedError, WrappedError, ZERO_USAGE, ZERO_VALUE, _AnthropicClaudeMetadataRegistration, _AzureOpenAiMetadataRegistration, _BoilerplateScraperMetadataRegistration, _DeepseekMetadataRegistration, _DocumentScraperMetadataRegistration, _GoogleMetadataRegistration, _LegacyDocumentScraperMetadataRegistration, _MarkdownScraperMetadataRegistration, _MarkitdownScraperMetadataRegistration, _OpenAiAssistantMetadataRegistration, _OpenAiMetadataRegistration, _PdfScraperMetadataRegistration, _WebsiteScraperMetadataRegistration, addUsage, book, cacheLlmTools, collectionToJson, compilePipeline, computeCosineSimilarity, countUsage, createCollectionFromJson, createCollectionFromPromise, createCollectionFromUrl, createLlmToolsFromConfiguration, createPipelineExecutor, createSubcollection, embeddingVectorToString, executionReportJsonToString, extractParameterNamesFromTask, filterModels, getPipelineInterface, identificationToPromptbookToken, isPassingExpectations, isPipelineImplementingInterface, isPipelineInterfacesEqual, isPipelinePrepared, isValidPipelineString, joinLlmExecutionTools, limitTotalUsage, makeKnowledgeSourceHandler, migratePipeline, parsePipeline, pipelineJsonToString, prepareKnowledgePieces, preparePersona, preparePipeline, prettifyPipelineString, promptbookFetch, promptbookTokenToIdentification, unpreparePipeline, usageToHuman, usageToWorktime, validatePipeline, validatePipelineString };
 //# sourceMappingURL=index.es.js.map