Skip to content

Prompts

Comprehensive prompt management with security and versioning

Create, manage, and render safe prompts for LLMs across 400+ modules

Enterprise ML/AI

Part of 237 enterprise modules with 14 ML/AI infrastructure features including prompt versioning and A/B testing. See Enterprise Documentation.

Quick Navigation

  • Templates

    Create reusable prompt templates

    Create

  • Security

    Injection detection and sanitization

    Secure

  • Versioning

    Full lifecycle version control

    Manage

  • Library

    Reusable prompt components

    Browse

Overview

Enterprise ML/AI

Prompt management is part of 14 ML/AI infrastructure modules including LLM gateway, model versioning, and A/B testing.

What is the Prompts Module?

The Prompts module provides comprehensive prompt management with security features, version control, and safe rendering for Large Language Models (LLMs).

Template Variables
Dynamic placeholder substitution
Injection Prevention
Detect and block prompt injections
Metadata Support
Tags, descriptions, and versioning
Version History
Track prompt changes over time

Core Components

Prompt Class

The Prompt class represents a prompt template with security and versioning features.

Constructor

Python
1
2
3
4
5
Prompt(
    template: str,
    metadata: dict[str, Any] = None,
    enable_security: bool = True
)

Parameters:

  • template (str): The prompt template with {variable} placeholders
  • metadata (dict[str, Any]): Additional metadata (tags, description, etc.)
  • enable_security (bool): Enable injection detection and sanitization

Methods

Python
1
2
3
def render(**kwargs) -> str
def render_safe(**kwargs) -> str
def update_template(new_template: str) -> None

Example:

Python
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
import logging

logger = logging.getLogger(__name__)

from agenticaiframework.prompts import Prompt

# Create a prompt with security enabled
prompt = Prompt(
    template="Hello {name}, your task is: {task}",
    metadata={"category": "greeting", "version": "1.0"},
    enable_security=True
)

# Render with variables
result = prompt.render(name="Alice", task="analyze data")
logger.info(result)

# Safe rendering with automatic sanitization
safe_result = prompt.render_safe(
    name="Bob",
    task="<script>alert('xss')</script>"
)
logger.info(safe_result) # Script tags removed

PromptManager Class

The PromptManager manages a collection of prompts with security and versioning.

Constructor

Python
1
PromptManager(enable_security: bool = True)

Key Methods

Python
1
2
3
4
5
def register_prompt(prompt: Prompt) -> None
def get_prompt(prompt_id: str) -> Prompt | None
def render_prompt(prompt_id: str, **kwargs) -> str
def list_prompts() -> list[str]
def delete_prompt(prompt_id: str) -> None

Example:

Python
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
import logging

logger = logging.getLogger(__name__)

from agenticaiframework.prompts import Prompt, PromptManager

# Create manager with security enabled
manager = PromptManager(enable_security=True)

# Register multiple prompts
greeting_prompt = Prompt(
    template="Welcome {user}! How can I help you today?",
    metadata={"type": "greeting"}
)
manager.register_prompt(greeting_prompt)

task_prompt = Prompt(
    template="Task: {task}\nContext: {context}\nOutput format: {format}",
    metadata={"type": "task"}
)
manager.register_prompt(task_prompt)

# Render by ID
result = manager.render_prompt(
    greeting_prompt.id,
    user="Alice"
)
logger.info(result)

# List all prompts
prompts = manager.list_prompts()
logger.info(f"Registered prompts: {len(prompts)}")

Prompt Versioning

The Prompt Versioning module provides enterprise-grade version control for prompts with semantic versioning, lifecycle management, and full audit trails.

PromptVersionManager

Manages versioned prompts with full lifecycle support.

Python
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
import logging

logger = logging.getLogger(__name__)

from agenticaiframework.prompt_versioning import (
    PromptVersionManager,
    PromptVersion,
    PromptStatus,
    prompt_version_manager
)

# Create manager with persistent storage
manager = PromptVersionManager(storage_path="/path/to/prompts")

# Create a new prompt (starts at v1.0.0)
prompt = manager.create_prompt(
    name="customer_support",
    template="Hello {customer_name}, I'm here to help with {issue}. {instructions}",
    created_by="admin",
    tags=["support", "customer-facing"]
)

logger.info(f"Created: {prompt.name} v{prompt.version}") # v1.0.0

Version Lifecycle

graph LR
    DRAFT[Draft] --> ACTIVE[Active]
    ACTIVE --> DEPRECATED[Deprecated]
    DEPRECATED --> ARCHIVED[Archived]
    ACTIVE -->|Rollback| DRAFT

Creating New Versions

Python
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import logging

logger = logging.getLogger(__name__)

# Create a new version with semantic versioning
new_version = manager.create_version(
    prompt_id=prompt.prompt_id,
    template="Hi {customer_name}! I'll assist you with {issue}. {instructions}",
    version_bump="minor", # major, minor, or patch
    created_by="developer",
    changelog="Improved greeting tone"
)

logger.info(f"New version: v{new_version.version}") # v1.1.0

Activation and Rollback

Python
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import logging

logger = logging.getLogger(__name__)

# Activate a version (makes it the default)
manager.activate(
    prompt_id=prompt.prompt_id,
    version="1.1.0",
    activated_by="admin"
)

# Rollback to a previous version
rolled_back = manager.rollback(
    prompt_id=prompt.prompt_id,
    target_version="1.0.0",
    rolled_back_by="admin"
)
logger.info(f"Rolled back, new version: v{rolled_back.version}") # v1.1.1

Rendering Prompts

Python
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
# Render the active version
result = manager.render(
    prompt_id=prompt.prompt_id,
    variables={
        "customer_name": "Alice",
        "issue": "billing",
        "instructions": "I'll look into this right away."
    }
)

# Render a specific version
result_v1 = manager.render(
    prompt_id=prompt.prompt_id,
    variables={"customer_name": "Bob", "issue": "shipping", "instructions": ""},
    version="1.0.0"
)

Audit Trail

Python
1
2
3
4
5
6
7
8
9
import logging

logger = logging.getLogger(__name__)

# Get audit log for a prompt
audit_log = manager.get_audit_log(prompt_id=prompt.prompt_id, limit=50)

for entry in audit_log:
    logger.info(f"{entry['action']} by {entry['actor']} at {entry['timestamp']}")

PromptLibrary

Library for reusable prompt components with template inheritance.

Python
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
from agenticaiframework.prompt_versioning import PromptLibrary, prompt_library

# Register reusable components
prompt_library.register_component(
    name="system_header",
    content="You are a helpful AI assistant. Be concise and accurate.",
    category="system",
    description="Standard system message header"
)

prompt_library.register_component(
    name="safety_footer",
    content="Remember: Never share sensitive information. If unsure, ask for clarification.",
    category="safety",
    description="Safety guidelines footer"
)

prompt_library.register_component(
    name="code_assistant_base",
    content="You are a coding assistant specializing in {language}. {context}",
    category="code",
    description="Base template for code assistants"
)

Composing Prompts

Python
1
2
3
4
5
# Compose multiple components
full_prompt = prompt_library.compose(
    components=["system_header", "code_assistant_base", "safety_footer"],
    separator="\n\n"
)

Template Inheritance

Python
1
2
3
4
5
6
7
8
9
# Extend a base component
python_prompt = prompt_library.extend(
    base_component="code_assistant_base",
    extensions={
        "replace_language": "Python",
        "replace_context": "Focus on clean, PEP8-compliant code.",
        "suffix": "Include type hints where appropriate."
    }
)

Search and Discovery

Python
1
2
3
4
5
6
7
8
# Search components
results = prompt_library.search("code")

# List by category
code_components = prompt_library.list_by_category("code")

# Get all categories
categories = prompt_library.get_categories()

PromptStatus Enum

Status Description
DRAFT Newly created, not yet activated
ACTIVE Currently in use (default for rendering)
DEPRECATED Replaced by newer version
ARCHIVED No longer in use

Use Cases

  • Creating consistent prompts for chatbots and virtual assistants.
  • Dynamically generating prompts based on user input or context.
  • Optimizing prompts for specific LLM providers.
  • Managing large prompt libraries for enterprise applications.
  • Version-controlled prompt updates with rollback capability.
  • A/B testing different prompt versions.
  • Audit compliance for regulated industries.

Best Practices

  • Keep prompts concise and clear to avoid ambiguity.
  • Use placeholders for dynamic values to improve reusability.
  • Test prompts with different LLMs to ensure compatibility.
  • Store prompts in version-controlled files for maintainability.
  • Use semantic versioning: major for breaking changes, minor for features, patch for fixes.
  • Always add changelog messages when creating new versions.
  • Use PromptLibrary for reusable components to ensure consistency.