Skip to content

Building AI agents, atomically

updating tests and readme docs with SystemPromptContextProviderBase -> BaseDynamicContextProvider

jon fox889fbb8c0117
diff --git a/README.md b/README.md
index 9708def..ce00a7c 100644
--- a/README.md
+++ b/README.md
@@ -227,14 +227,14 @@ Atomic Agents allows you to enhance your agents with dynamic context using **Con
### Using Context Providers
-To use a Context Provider, create a class that inherits from `SystemPromptContextProviderBase` and implements the `get_info()` method, which returns the context string to be added to the system prompt.
+To use a Context Provider, create a class that inherits from `BaseDynamicContextProvider` and implements the `get_info()` method, which returns the context string to be added to the system prompt.
Here's a simple example:
```python
-from atomic_agents.lib.components.system_prompt_generator import SystemPromptContextProviderBase
+from atomic_agents.lib.components.system_prompt_generator import BaseDynamicContextProvider
-class SearchResultsProvider(SystemPromptContextProviderBase):
+class SearchResultsProvider(BaseDynamicContextProvider):
def __init__(self, title: str, search_results: List[str]):
super().__init__(title=title)
self.search_results = search_results
diff --git a/atomic-agents/atomic_agents/agents/base_agent.py b/atomic-agents/atomic_agents/agents/base_agent.py
index d91a420..519c7de 100644
--- a/atomic-agents/atomic_agents/agents/base_agent.py
+++ b/atomic-agents/atomic_agents/agents/base_agent.py
@@ -287,7 +287,7 @@ class BaseAgent[InputSchema: BaseIOSchema, OutputSchema: BaseIOSchema]:
provider_name (str): The name of the context provider.
Returns:
- SystemPromptContextProviderBase: The context provider if found.
+ BaseDynamicContextProvider: The context provider if found.
Raises:
KeyError: If the context provider is not found.
@@ -302,7 +302,7 @@ class BaseAgent[InputSchema: BaseIOSchema, OutputSchema: BaseIOSchema]:
Args:
provider_name (str): The name of the context provider.
- provider (SystemPromptContextProviderBase): The context provider instance.
+ provider (BaseDynamicContextProvider): The context provider instance.
"""
self.system_prompt_generator.context_providers[provider_name] = provider
diff --git a/atomic-agents/tests/agents/test_base_agent.py b/atomic-agents/tests/agents/test_base_agent.py
index b704e55..6c1c1df 100644
--- a/atomic-agents/tests/agents/test_base_agent.py
+++ b/atomic-agents/tests/agents/test_base_agent.py
@@ -10,7 +10,7 @@ from atomic_agents.agents.base_agent import (
BaseAgentOutputSchema,
SystemPromptGenerator,
ChatHistory,
- SystemPromptContextProviderBase,
+ BaseDynamicContextProvider,
)
from instructor.dsl.partial import PartialBase
@@ -185,7 +185,7 @@ def test_reset_history(agent, mock_history):
def test_get_context_provider(agent, mock_system_prompt_generator):
- mock_provider = Mock(spec=SystemPromptContextProviderBase)
+ mock_provider = Mock(spec=BaseDynamicContextProvider)
mock_system_prompt_generator.context_providers = {"test_provider": mock_provider}
result = agent.get_context_provider("test_provider")
@@ -196,7 +196,7 @@ def test_get_context_provider(agent, mock_system_prompt_generator):
def test_register_context_provider(agent, mock_system_prompt_generator):
- mock_provider = Mock(spec=SystemPromptContextProviderBase)
+ mock_provider = Mock(spec=BaseDynamicContextProvider)
agent.register_context_provider("new_provider", mock_provider)
assert "new_provider" in mock_system_prompt_generator.context_providers
@@ -204,7 +204,7 @@ def test_register_context_provider(agent, mock_system_prompt_generator):
def test_unregister_context_provider(agent, mock_system_prompt_generator):
- mock_provider = Mock(spec=SystemPromptContextProviderBase)
+ mock_provider = Mock(spec=BaseDynamicContextProvider)
mock_system_prompt_generator.context_providers = {"test_provider": mock_provider}
agent.unregister_context_provider("test_provider")
diff --git a/docs/api/agents.md b/docs/api/agents.md
index b0a376e..33214e7 100644
--- a/docs/api/agents.md
+++ b/docs/api/agents.md
@@ -166,7 +166,7 @@ class BaseAgentOutputSchema(BaseIOSchema):
- `get_response(response_model=None) -> Type[BaseModel]`: Get direct model response
- `reset_history()`: Reset history to initial state
- `get_context_provider(provider_name: str)`: Get a registered context provider
-- `register_context_provider(provider_name: str, provider: SystemPromptContextProviderBase)`: Register a new context provider
+- `register_context_provider(provider_name: str, provider: BaseDynamicContextProvider)`: Register a new context provider
- `unregister_context_provider(provider_name: str)`: Remove a context provider
### Context Providers
@@ -174,9 +174,9 @@ class BaseAgentOutputSchema(BaseIOSchema):
Context providers can be used to inject dynamic information into the system prompt:
```python
-from atomic_agents.lib.components.system_prompt_generator import SystemPromptContextProviderBase
+from atomic_agents.lib.components.system_prompt_generator import BaseDynamicContextProvider
-class SearchResultsProvider(SystemPromptContextProviderBase):
+class SearchResultsProvider(BaseDynamicContextProvider):
def __init__(self, title: str):
super().__init__(title=title)
self.results = []
diff --git a/docs/api/components.md b/docs/api/components.md
index 71df4cf..bce00b5 100644
--- a/docs/api/components.md
+++ b/docs/api/components.md
@@ -75,7 +75,7 @@ The `SystemPromptGenerator` creates structured system prompts for AI agents:
```python
from atomic_agents.lib.components.system_prompt_generator import (
SystemPromptGenerator,
- SystemPromptContextProviderBase
+ BaseDynamicContextProvider
)
# Create generator with static content
@@ -113,7 +113,7 @@ class SearchResult:
content: str
metadata: dict
-class SearchResultsProvider(SystemPromptContextProviderBase):
+class SearchResultsProvider(BaseDynamicContextProvider):
def __init__(self, title: str):
super().__init__(title=title)
self.results: List[SearchResult] = []
diff --git a/docs/api/index.md b/docs/api/index.md
index 08c3ca0..91ea7f9 100644
--- a/docs/api/index.md
+++ b/docs/api/index.md
@@ -43,7 +43,7 @@ The components module contains essential building blocks:
- Output instructions
- Dynamic context through context providers
-- `SystemPromptContextProviderBase`: Base class for creating custom context providers that can inject dynamic information into system prompts
+- `BaseDynamicContextProvider`: Base class for creating custom context providers that can inject dynamic information into system prompts
[Learn more about components](components.md)