Building AI agents, atomically
feat: add BaseSystemPromptGenerator class
Psharp72528cdd52cc7ab
diff --git a/atomic-agents/atomic_agents/agents/atomic_agent.py b/atomic-agents/atomic_agents/agents/atomic_agent.pyindex 48ed6db..be5866b 100644--- a/atomic-agents/atomic_agents/agents/atomic_agent.py+++ b/atomic-agents/atomic_agents/agents/atomic_agent.py@@ -8,6 +8,7 @@ from atomic_agents.context.chat_history import ChatHistoryfrom atomic_agents.context.system_prompt_generator import (BaseDynamicContextProvider,SystemPromptGenerator,+ BaseSystemPromptGenerator,)from atomic_agents.base.base_io_schema import BaseIOSchemafrom atomic_agents.utils.token_counter import get_token_counter, TokenCountResult@@ -66,7 +67,7 @@ class AgentConfig(BaseModel):client: instructor.core.client.Instructor = Field(..., description="Client for interacting with the language model.")model: str = Field(default="gpt-5-mini", description="The model to use for generating responses.")history: Optional[ChatHistory] = Field(default=None, description="History component for storing chat history.")- system_prompt_generator: Optional[SystemPromptGenerator] = Field(+ system_prompt_generator: Optional[BaseSystemPromptGenerator] = Field(default=None, description="Component for generating system prompts.")system_role: Optional[str] = Field(diff --git a/atomic-agents/atomic_agents/context/__init__.py b/atomic-agents/atomic_agents/context/__init__.pyindex b307f5f..487d54a 100644--- a/atomic-agents/atomic_agents/context/__init__.py+++ b/atomic-agents/atomic_agents/context/__init__.py@@ -2,6 +2,7 @@ from .chat_history import Message, ChatHistoryfrom .system_prompt_generator import (BaseDynamicContextProvider,SystemPromptGenerator,+ BaseSystemPromptGenerator,)__all__ = [@@ -9,4 +10,5 @@ __all__ = ["ChatHistory","SystemPromptGenerator","BaseDynamicContextProvider",+ "BaseSystemPromptGenerator",]diff --git a/atomic-agents/atomic_agents/context/system_prompt_generator.py b/atomic-agents/atomic_agents/context/system_prompt_generator.pyindex 1f23c3f..d6fb3f1 100644--- a/atomic-agents/atomic_agents/context/system_prompt_generator.py+++ b/atomic-agents/atomic_agents/context/system_prompt_generator.py@@ -12,9 +12,24 @@ class BaseDynamicContextProvider(ABC):def __repr__(self) -> str:return self.get_info()++class BaseSystemPromptGenerator(ABC):+ def __init__(+ self,+ context_providers: Optional[Dict[str, BaseDynamicContextProvider]] = None+ ):+ self.context_providers = context_providers or {}-class SystemPromptGenerator:+ @abstractmethod+ def generate_prompt(self) -> str:+ pass++ def __repr__(self) -> str:+ return self.generate_prompt()+++class SystemPromptGenerator(BaseSystemPromptGenerator):def __init__(self,background: Optional[List[str]] = None,@@ -22,10 +37,10 @@ class SystemPromptGenerator:output_instructions: Optional[List[str]] = None,context_providers: Optional[Dict[str, BaseDynamicContextProvider]] = None,):+ super().__init__(context_providers=context_providers)self.background = background or ["This is a conversation with a helpful and friendly AI assistant."]self.steps = steps or []self.output_instructions = output_instructions or []- self.context_providers = context_providers or {}self.output_instructions.extend([diff --git a/atomic-agents/tests/context/test_system_prompt_generator.py b/atomic-agents/tests/context/test_system_prompt_generator.pyindex 02ecfe5..7949183 100644--- a/atomic-agents/tests/context/test_system_prompt_generator.py+++ b/atomic-agents/tests/context/test_system_prompt_generator.py@@ -1,4 +1,8 @@-from atomic_agents.context import SystemPromptGenerator, BaseDynamicContextProvider+from atomic_agents.context import (+ SystemPromptGenerator,+ BaseDynamicContextProvider,+ BaseSystemPromptGenerator,+)class MockContextProvider(BaseDynamicContextProvider):@@ -128,3 +132,11 @@ def test_generate_prompt_with_empty_context_provider():# EXTRA INFORMATION AND CONTEXT"""assert generator.generate_prompt() == expected_prompt++def test_base_system_prompt_generator_repr():+ class Impl(BaseSystemPromptGenerator):+ def generate_prompt(self) -> str:+ return "X"++ impl = Impl()+ assert repr(impl) == "X"diff --git a/docs/api/context.md b/docs/api/context.mdindex ae50f8e..f635fcb 100644--- a/docs/api/context.md+++ b/docs/api/context.md@@ -104,6 +104,54 @@ generator = SystemPromptGenerator(prompt = generator.generate_prompt()```+### Custom System Prompt Generator++If you prefer to have more control over the system prompt generator you can create a custom system prompt generator by inheriting from `BaseSystemPromptGenerator`:++```python+from pathlib import Path+from typing import Dict, Optional, Union++from atomic_agents.context import BaseDynamicContextProvider, BaseSystemPromptGenerator+++# Define custom generator class+class MarkdownFileSystemPromptGenerator(BaseSystemPromptGenerator):++ def __init__(+ self,+ md_file: Union[Path, str],+ context_providers: Optional[Dict[str, BaseDynamicContextProvider]] = None,+ ):+ super().__init__(context_providers=context_providers)++ path = Path(md_file)+ if not path.exists():+ raise FileNotFoundError(f"System prompt file not found: {md_file}")++ self.system_prompt = path.read_text(encoding="utf-8")++ def generate_prompt(self) -> str:+ prompt_parts = [self.system_prompt]++ if self.context_providers:+ prompt_parts.append("# EXTRA INFORMATION AND CONTEXT")+ for provider in self.context_providers.values():+ info = provider.get_info()+ if info:+ prompt_parts.append(f"## {provider.title}")+ prompt_parts.append(info)+ prompt_parts.append("")++ return "\n".join(prompt_parts).strip()++# Create generator+generator = MarkdownFileSystemPromptGenerator("path/to/system_prompt.md")++# Generate prompt+prompt = generator.generate_prompt()+```+### Dynamic Context ProvidersContext providers inject dynamic information into prompts: