@promptbook/core 0.100.0-21 → 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-21';
+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
@@ -207,6 +207,32 @@ class ActionCommitmentDefinition extends BaseCommitmentDefinition {
     constructor() {
         super('ACTION');
     }
+    /**
+     * 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',
+            '',
+            'Defines specific actions or capabilities that the agent can perform.',
+            '',
+            'Effects on system message:',
+            '- Appends a "Capability: ..." line to the system message.',
+            '',
+            'Examples:',
+            '```book',
+            'ACTION Can generate code snippets and explain programming concepts',
+            'ACTION Able to analyze data and provide insights',
+            '```',
+            '',
+        ].join('\n');
+    }
     applyToAgentModelRequirements(requirements, content) {
         const trimmedContent = content.trim();
         if (!trimmedContent) {
@@ -247,6 +273,32 @@ class FormatCommitmentDefinition extends BaseCommitmentDefinition {
     constructor() {
         super('FORMAT');
     }
+    /**
+     * Short one-line description of FORMAT.
+     */
+    get description() {
+        return 'Specify output structure or formatting requirements.';
+    }
+    /**
+     * Markdown documentation for FORMAT commitment.
+     */
+    get documentation() {
+        return [
+            '# FORMAT',
+            '',
+            'Defines the specific output structure and formatting for responses (data formats, templates, structure).',
+            '',
+            'Effects on system message:',
+            '- Appends an "Output Format: ..." line to the system message.',
+            '',
+            'Examples:',
+            '```book',
+            "FORMAT Always respond in JSON format with 'status' and 'data' fields",
+            'FORMAT Use markdown formatting for all code blocks',
+            '```',
+            '',
+        ].join('\n');
+    }
     applyToAgentModelRequirements(requirements, content) {
         const trimmedContent = content.trim();
         if (!trimmedContent) {
@@ -999,6 +1051,38 @@ class KnowledgeCommitmentDefinition extends BaseCommitmentDefinition {
         super('KNOWLEDGE');
         this.ragService = new FrontendRAGService();
     }
+    /**
+     * 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',
+            '',
+            'Adds specific knowledge, facts, or context to the agent using a RAG (Retrieval-Augmented Generation) approach for external sources.',
+            '',
+            'Two modes:',
+            '- Direct text knowledge: Appends a "Knowledge: ..." line to the system message.',
+            '- URL knowledge source: Stores the URL in metadata.knowledgeSources and a ragService for retrieval at chat time, and appends an informational line to the system message.',
+            '',
+            'Metadata effects when URL is used:',
+            '- metadata.ragService = FrontendRAGService instance',
+            '- metadata.knowledgeSources += [url]',
+            '',
+            'Examples:',
+            '```book',
+            'KNOWLEDGE The company was founded in 2020 and specializes in AI-powered solutions',
+            'KNOWLEDGE https://example.com/company-handbook.pdf',
+            'KNOWLEDGE https://example.com/product-documentation.pdf',
+            '```',
+            '',
+        ].join('\n');
+    }
     applyToAgentModelRequirements(requirements, content) {
         var _a;
         const trimmedContent = content.trim();
@@ -1078,6 +1162,35 @@ class MetaImageCommitmentDefinition extends BaseCommitmentDefinition {
     constructor() {
         super('META IMAGE');
     }
+    /**
+     * 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',
+            '',
+            "Sets the agent's avatar/profile image URL.",
+            '',
+            'Behavior:',
+            '- Does not modify the system message.',
+            '- Handled separately by parsing logic to extract and store a profile image URL.',
+            '',
+            'Examples:',
+            '```book',
+            'META IMAGE https://example.com/avatar.jpg',
+            'META IMAGE /assets/agent-avatar.png',
+            '```',
+            '',
+        ]
+            .join('\\n')
+            .replace(/\\\\n/g, '\\n');
+    }
     applyToAgentModelRequirements(requirements, content) {
         // META IMAGE doesn't modify the system message or model requirements
         // It's handled separately in the parsing logic for profile image extraction
@@ -1131,6 +1244,37 @@ class MetaLinkCommitmentDefinition extends BaseCommitmentDefinition {
     constructor() {
         super('META LINK');
     }
+    /**
+     * 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',
+            '',
+            'Represents a profile or source link for the person the agent is modeled after.',
+            '',
+            'Behavior:',
+            '- Does not modify the system message.',
+            '- Parsing logic extracts and stores the link for profile display.',
+            '- Multiple META LINK lines are allowed when there are multiple sources.',
+            '',
+            'Examples:',
+            '```book',
+            'META LINK https://twitter.com/username',
+            'META LINK https://linkedin.com/in/profile',
+            'META LINK https://github.com/username',
+            '```',
+            '',
+        ]
+            .join('\\n')
+            .replace(/\\\\n/g, '\\n');
+    }
     applyToAgentModelRequirements(requirements, content) {
         // META LINK doesn't modify the system message or model requirements
         // It's handled separately in the parsing logic for profile link extraction
@@ -1188,6 +1332,39 @@ class ModelCommitmentDefinition extends BaseCommitmentDefinition {
     constructor() {
         super('MODEL');
     }
+    /**
+     * 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',
+            '',
+            'Specifies which AI model to use and optional decoding parameters.',
+            '',
+            'Supported parameters:',
+            '- temperature: number',
+            '- topP (aka top_p): number',
+            '- topK (aka top_k): integer',
+            '',
+            'Effects on requirements:',
+            '- Sets modelName from the first token.',
+            '- Parses optional parameters and assigns them to requirements (temperature, topP, topK).',
+            '',
+            'Examples:',
+            '```book',
+            'MODEL gpt-4',
+            'MODEL claude-3-opus temperature=0.3',
+            'MODEL gpt-3.5-turbo temperature=0.8 topP=0.9',
+            '```',
+            '',
+        ].join('\n');
+    }
     applyToAgentModelRequirements(requirements, content) {
         const trimmedContent = content.trim();
         if (!trimmedContent) {
@@ -1273,6 +1450,35 @@ class NoteCommitmentDefinition extends BaseCommitmentDefinition {
     constructor() {
         super('NOTE');
     }
+    /**
+     * 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',
+            '',
+            'Adds comments for documentation without changing system message or model requirements.',
+            '',
+            'Key behaviors:',
+            '- Makes no changes to the system message.',
+            '- Makes no changes to requirements.',
+            '- Aggregates multiple NOTE lines into metadata.NOTE.',
+            '',
+            'Examples:',
+            '```book',
+            'NOTE This agent was designed for customer support scenarios',
+            'NOTE Remember to update the knowledge base monthly',
+            'NOTE Performance optimized for quick response times',
+            '```',
+            '',
+        ].join('\n');
+    }
     applyToAgentModelRequirements(requirements, content) {
         var _a;
         // The NOTE commitment makes no changes to the system message or model requirements
@@ -1335,6 +1541,43 @@ class PersonaCommitmentDefinition extends BaseCommitmentDefinition {
     constructor() {
         super('PERSONA');
     }
+    /**
+     * 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',
+            '',
+            'Defines who the agent is, their background, expertise, and personality traits.',
+            '',
+            'Key behaviors:',
+            '- Multiple PERSONA commitments are merged together.',
+            '- The merged content is placed at the beginning of the system message.',
+            '- Original PERSONA lines are preserved in metadata.PERSONA.',
+            '- Comment lines (# PERSONA) are removed from the final system message.',
+            '',
+            'Effects on system message:',
+            '- Creates a section:',
+            '  ```',
+            '  # PERSONA',
+            '  You are {agentName}',
+            '  {merged persona content}',
+            '  ```',
+            '',
+            'Examples:',
+            '```book',
+            'PERSONA You are a helpful programming assistant with expertise in TypeScript and React',
+            'PERSONA You have deep knowledge of modern web development practices',
+            '```',
+            '',
+        ].join('\n');
+    }
     applyToAgentModelRequirements(requirements, content) {
         var _a, _b;
         // The PERSONA commitment aggregates all persona content and places it at the beginning
@@ -1435,6 +1678,32 @@ class RuleCommitmentDefinition extends BaseCommitmentDefinition {
     constructor(type = 'RULE') {
         super(type);
     }
+    /**
+     * 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}`,
+            '',
+            'Adds behavioral constraints and guidelines that the agent must follow.',
+            '',
+            'Effects on system message:',
+            '- Appends a "Rule: ..." line to the system message.',
+            '',
+            'Examples:',
+            '```book',
+            "RULE Always ask for clarification if the user's request is ambiguous",
+            'RULES Never provide medical advice, always refer to healthcare professionals',
+            '```',
+            '',
+        ].join('\n');
+    }
     applyToAgentModelRequirements(requirements, content) {
         const trimmedContent = content.trim();
         if (!trimmedContent) {
@@ -1480,6 +1749,34 @@ class SampleCommitmentDefinition extends BaseCommitmentDefinition {
     constructor(type = 'SAMPLE') {
         super(type);
     }
+    /**
+     * 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}`,
+            '',
+            'Provides examples of how the agent should respond or behave in certain situations.',
+            '',
+            'Effects on system message:',
+            '- Appends an "Example: ..." line to the system message.',
+            '',
+            'Examples:',
+            '```book',
+            'SAMPLE When asked about pricing, respond: "Our basic plan starts at $10/month..."',
+            'EXAMPLE For code questions, always include working code snippets',
+            '```',
+            '',
+        ]
+            .join('\\n')
+            .replace(/\\\\n/g, '\\n');
+    }
     applyToAgentModelRequirements(requirements, content) {
         const trimmedContent = content.trim();
         if (!trimmedContent) {
@@ -1525,6 +1822,32 @@ class StyleCommitmentDefinition extends BaseCommitmentDefinition {
     constructor() {
         super('STYLE');
     }
+    /**
+     * 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',
+            '',
+            'Defines how the agent should format and present its responses (tone, writing style, formatting).',
+            '',
+            'Effects on system message:',
+            '- Appends a "Style: ..." line to the system message.',
+            '',
+            'Examples:',
+            '```book',
+            'STYLE Write in a professional but friendly tone, use bullet points for lists',
+            'STYLE Always provide code examples when explaining programming concepts',
+            '```',
+            '',
+        ].join('\n');
+    }
     applyToAgentModelRequirements(requirements, content) {
         const trimmedContent = content.trim();
         if (!trimmedContent) {
@@ -1557,6 +1880,32 @@ class NotYetImplementedCommitmentDefinition extends BaseCommitmentDefinition {
     constructor(type) {
         super(type);
     }
+    /**
+     * 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}`,
+            ``,
+            `This commitment is not yet fully implemented.`,
+            `Until it is, its content is appended 1:1 to the system message, preserving current behavior.`,
+            ``,
+            `- Status: Placeholder`,
+            `- Effect: Appends a line to the system message prefixed by the commitment type`,
+            ``,
+            `Example:`,
+            `\`\`\`book`,
+            `${this.type} Your content here`,
+            `\`\`\``,
+            ``,
+        ].join('\n');
+    }
     applyToAgentModelRequirements(requirements, content) {
         const trimmedContent = content.trim();
         if (!trimmedContent) {