Prompt References

​

Overview

• Managing large projects with reusable prompt components.
• Reducing duplication by reusing common sections (e.g., policies, instructions).
• Simplifying maintenance by centralizing updates to shared prompts.

​

Syntax

​

Basic Usage

<prompt path="policies" assistant_name={{ assistant_name }} />

<user>{{ user_question }}</user>

You are {{ assistant_name }}, an AI assistant created to help users.

Before answering any questions, follow these rules:
- Be respectful.
- Avoid sharing personal information.
- Use appropriate language.

1. The parent prompt references policies.promptl and passes the assistant_name variable.
2. The assistant_name variable is interpolated in the referenced prompt.

​

Setup

• Storing prompts in a file system.
• Using a database to store prompts.
• Fetching prompts from an API.

​

Basic referenceFn

import fs from 'fs';

function getPrompt(path) {
  return fs.readFileSync(path, 'utf8');
}

​

Supporting Relative Paths

import path from 'path';
import fs from 'fs';

function getPrompt(relativePath, currentPath) {
  const fullPath = path.resolve(path.dirname(currentPath), relativePath);
  return fs.readFileSync(fullPath, 'utf8');
}

​

Using the referenceFn

import { render } from 'promptl-ai';
import getPrompt from './getPrompt'; // Import your custom resolve function

const { messages, config } = await render({
  prompt: mainPrompt, // Your main PromptL prompt as a string
  referenceFn: getPrompt, // Provide the resolve function
});

​

Real-World Examples

​

Modular Prompts for Instructions

<prompt path="instructions" assistant_name="HelperBot" />

<user>
  What can you do for me?
</user>

You are {{ assistant_name }}, an assistant trained to provide technical support.

Capabilities:
- Debugging code.
- Explaining concepts.
- Recommending resources.

​

Nested References

<prompt path="policies" />
<prompt path="faq" />

<prompt path="instructions" assistant_name="FAQBot" />

<user>
  What are your rules?
</user>

​

Best Practices

1. Use Descriptive Paths:
   • Organize prompts logically (e.g., prompts/policies.promptl).
2. Centralize Shared Logic:
   • Store common instructions, rules, or templates in reusable prompts.
3. Pass Variables Explicitly:
   • Always pass required variables to avoid missing or mismatched data.
4. Avoid Circular References:
   • Ensure prompts don’t reference each other in loops.

​

Debugging Tips

1. Check File Paths:
   • Ensure path in the <prompt> tag matches the actual file structure.
2. Log Resolved Prompts:
   • Add a console.log() in referenceFn to verify the correct prompt is being loaded.
3. Handle Missing Prompts:
   • Add error handling in referenceFn to handle missing or unreadable prompts gracefully:
   function getPrompt(path) {
     try {
       return fs.readFileSync(path, 'utf8');
     } catch (error) {
       console.error(`Error loading prompt: ${path}`);
       throw error;
     }
   }
   
4. Inspect Variables:
   • Confirm that required variables are being passed correctly.

​

Summary