@promptbook/core 0.100.0-22 → 0.100.0-23

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.100.0-22';
+const PROMPTBOOK_ENGINE_VERSION = '0.100.0-23';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -208,9 +208,15 @@ class ActionCommitmentDefinition extends BaseCommitmentDefinition {
         super('ACTION');
     }
     /**
-     * Markdown documentation for ACTION commitment.
+     * Short one-line description of ACTION.
      */
     get description() {
+        return 'Define agent capabilities and actions it can perform.';
+    }
+    /**
+     * Markdown documentation for ACTION commitment.
+     */
+    get documentation() {
         return [
             '# ACTION',
             '',
@@ -268,9 +274,15 @@ class FormatCommitmentDefinition extends BaseCommitmentDefinition {
         super('FORMAT');
     }
     /**
-     * Markdown documentation for FORMAT commitment.
+     * Short one-line description of FORMAT.
      */
     get description() {
+        return 'Specify output structure or formatting requirements.';
+    }
+    /**
+     * Markdown documentation for FORMAT commitment.
+     */
+    get documentation() {
         return [
             '# FORMAT',
             '',
@@ -1040,9 +1052,15 @@ class KnowledgeCommitmentDefinition extends BaseCommitmentDefinition {
         this.ragService = new FrontendRAGService();
     }
     /**
-     * Markdown documentation for KNOWLEDGE commitment.
+     * Short one-line description of KNOWLEDGE.
      */
     get description() {
+        return 'Add domain **knowledge** via direct text or external sources (RAG).';
+    }
+    /**
+     * Markdown documentation for KNOWLEDGE commitment.
+     */
+    get documentation() {
         return [
             '# KNOWLEDGE',
             '',
@@ -1145,9 +1163,15 @@ class MetaImageCommitmentDefinition extends BaseCommitmentDefinition {
         super('META IMAGE');
     }
     /**
-     * Markdown documentation for META IMAGE commitment.
+     * Short one-line description of META IMAGE.
      */
     get description() {
+        return "Set the agent's profile image URL.";
+    }
+    /**
+     * Markdown documentation for META IMAGE commitment.
+     */
+    get documentation() {
         return [
             '# META IMAGE',
             '',
@@ -1163,7 +1187,9 @@ class MetaImageCommitmentDefinition extends BaseCommitmentDefinition {
             'META IMAGE /assets/agent-avatar.png',
             '```',
             '',
-        ].join('\\n').replace(/\\\\n/g, '\\n');
+        ]
+            .join('\\n')
+            .replace(/\\\\n/g, '\\n');
     }
     applyToAgentModelRequirements(requirements, content) {
         // META IMAGE doesn't modify the system message or model requirements
@@ -1219,9 +1245,15 @@ class MetaLinkCommitmentDefinition extends BaseCommitmentDefinition {
         super('META LINK');
     }
     /**
-     * Markdown documentation for META LINK commitment.
+     * Short one-line description of META LINK.
      */
     get description() {
+        return 'Provide profile/source links for the person the agent models.';
+    }
+    /**
+     * Markdown documentation for META LINK commitment.
+     */
+    get documentation() {
         return [
             '# META LINK',
             '',
@@ -1239,7 +1271,9 @@ class MetaLinkCommitmentDefinition extends BaseCommitmentDefinition {
             'META LINK https://github.com/username',
             '```',
             '',
-        ].join('\\n').replace(/\\\\n/g, '\\n');
+        ]
+            .join('\\n')
+            .replace(/\\\\n/g, '\\n');
     }
     applyToAgentModelRequirements(requirements, content) {
         // META LINK doesn't modify the system message or model requirements
@@ -1299,9 +1333,15 @@ class ModelCommitmentDefinition extends BaseCommitmentDefinition {
         super('MODEL');
     }
     /**
-     * Markdown documentation for MODEL commitment.
+     * Short one-line description of MODEL.
      */
     get description() {
+        return 'Select the AI model and optional decoding parameters.';
+    }
+    /**
+     * Markdown documentation for MODEL commitment.
+     */
+    get documentation() {
         return [
             '# MODEL',
             '',
@@ -1411,9 +1451,15 @@ class NoteCommitmentDefinition extends BaseCommitmentDefinition {
         super('NOTE');
     }
     /**
-     * Markdown documentation for NOTE commitment.
+     * Short one-line description of NOTE.
      */
     get description() {
+        return 'Add developer-facing notes without changing behavior or output.';
+    }
+    /**
+     * Markdown documentation for NOTE commitment.
+     */
+    get documentation() {
         return [
             '# NOTE',
             '',
@@ -1496,9 +1542,15 @@ class PersonaCommitmentDefinition extends BaseCommitmentDefinition {
         super('PERSONA');
     }
     /**
-     * Markdown documentation for PERSONA commitment.
+     * Short one-line description of PERSONA.
      */
     get description() {
+        return 'Define who the agent is: background, expertise, and personality.';
+    }
+    /**
+     * Markdown documentation for PERSONA commitment.
+     */
+    get documentation() {
         return [
             '# PERSONA',
             '',
@@ -1627,9 +1679,15 @@ class RuleCommitmentDefinition extends BaseCommitmentDefinition {
         super(type);
     }
     /**
-     * Markdown documentation for RULE/RULES commitment.
+     * Short one-line description of RULE/RULES.
      */
     get description() {
+        return 'Add behavioral rules the agent must follow.';
+    }
+    /**
+     * Markdown documentation for RULE/RULES commitment.
+     */
+    get documentation() {
         return [
             `# ${this.type}`,
             '',
@@ -1640,7 +1698,7 @@ class RuleCommitmentDefinition extends BaseCommitmentDefinition {
             '',
             'Examples:',
             '```book',
-            'RULE Always ask for clarification if the user\'s request is ambiguous',
+            "RULE Always ask for clarification if the user's request is ambiguous",
             'RULES Never provide medical advice, always refer to healthcare professionals',
             '```',
             '',
@@ -1692,9 +1750,15 @@ class SampleCommitmentDefinition extends BaseCommitmentDefinition {
         super(type);
     }
     /**
-     * Markdown documentation for SAMPLE/EXAMPLE commitment.
+     * Short one-line description of SAMPLE/EXAMPLE.
      */
     get description() {
+        return 'Provide example responses to guide behavior.';
+    }
+    /**
+     * Markdown documentation for SAMPLE/EXAMPLE commitment.
+     */
+    get documentation() {
         return [
             `# ${this.type}`,
             '',
@@ -1709,7 +1773,9 @@ class SampleCommitmentDefinition extends BaseCommitmentDefinition {
             'EXAMPLE For code questions, always include working code snippets',
             '```',
             '',
-        ].join('\\n').replace(/\\\\n/g, '\\n');
+        ]
+            .join('\\n')
+            .replace(/\\\\n/g, '\\n');
     }
     applyToAgentModelRequirements(requirements, content) {
         const trimmedContent = content.trim();
@@ -1757,9 +1823,15 @@ class StyleCommitmentDefinition extends BaseCommitmentDefinition {
         super('STYLE');
     }
     /**
-     * Markdown documentation for STYLE commitment.
+     * Short one-line description of STYLE.
      */
     get description() {
+        return 'Control the tone and writing style of responses.';
+    }
+    /**
+     * Markdown documentation for STYLE commitment.
+     */
+    get documentation() {
         return [
             '# STYLE',
             '',
@@ -1809,9 +1881,15 @@ class NotYetImplementedCommitmentDefinition extends BaseCommitmentDefinition {
         super(type);
     }
     /**
-     * Markdown documentation available at runtime.
+     * Short one-line description of a placeholder commitment.
      */
     get description() {
+        return 'Placeholder commitment that appends content verbatim to the system message.';
+    }
+    /**
+     * Markdown documentation available at runtime.
+     */
+    get documentation() {
         return [
             `# ${this.type}`,
             ``,