@promptbook/node 0.92.0-27 → 0.92.0-28

package/esm/index.es.js

@@ -30,7 +30,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-28';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -2534,7 +2534,7 @@ function union(...sets) {
 }
 
 /**
- * @@@
+ * Contains configuration options for parsing and generating CSV files, such as delimiters and quoting rules.
  *
  * @public exported from `@promptbook/core`
  */
@@ -3721,8 +3721,12 @@ function checkExpectations(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) {
@@ -4180,8 +4184,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) {
@@ -4189,7 +4197,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`
  */
@@ -4236,9 +4244,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`
  */
@@ -4457,7 +4464,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`
  */
@@ -6761,8 +6769,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`
  */
@@ -7003,14 +7009,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: [
@@ -7043,7 +7049,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"
@@ -7074,7 +7080,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`
  */
@@ -7118,13 +7125,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,
 };
@@ -9590,7 +9597,8 @@ function $execCommand(options) {
  */
 
 /**
- * @@@
+ * Attempts to locate the specified application on a Linux system using the 'which' command.
+ * Returns the path to the executable if found, or null otherwise.
  *
  * @private within the repository
  */
@@ -9657,7 +9665,8 @@ async function isExecutable(path, fs) {
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const userhome = require('userhome');
 /**
- * @@@
+ * Attempts to locate the specified application on a macOS system by checking standard application paths and using mdfind.
+ * Returns the path to the executable if found, or null otherwise.
  *
  * @private within the repository
  */
@@ -9689,7 +9698,8 @@ async function locateAppOnMacOs({ macOsName, }) {
  */
 
 /**
- * @@@
+ * Attempts to locate the specified application on a Windows system by searching common installation directories.
+ * Returns the path to the executable if found, or null otherwise.
  *
  * @private within the repository
  */
@@ -9760,7 +9770,8 @@ function locateApp(options) {
  */
 
 /**
- * @@@
+ * Locates the LibreOffice executable on the current system by searching platform-specific paths.
+ * Returns the path to the executable if found, or null otherwise.
  *
  * @private within the repository
  */
@@ -9778,7 +9789,8 @@ function locateLibreoffice() {
  */
 
 /**
- * @@@
+ * Locates the Pandoc executable on the current system by searching platform-specific paths.
+ * Returns the path to the executable if found, or null otherwise.
  *
  * @private within the repository
  */
@@ -9796,7 +9808,7 @@ function locatePandoc() {
  */
 
 /**
- * @@@
+ * Provides paths to required executables (i.e. as Pandoc and LibreOffice) for Node.js environments.
  *
  * @public exported from `@promptbook/node`
  */