Skip to content

Building AI agents, atomically

Add turn IDs

KennyVaneetveldeb8d37fb03677
diff --git a/atomic_agents/agents/base_agent.py b/atomic_agents/agents/base_agent.py
index d62f310..97ae92b 100644
--- a/atomic_agents/agents/base_agent.py
+++ b/atomic_agents/agents/base_agent.py
@@ -150,6 +150,7 @@ class BaseAgent:
Type[BaseIOSchema]: The response from the chat agent.
"""
if user_input:
+ self.memory.initialize_turn()
self.current_user_input = user_input
self.memory.add_message("user", str(user_input))
diff --git a/atomic_agents/lib/components/agent_memory.py b/atomic_agents/lib/components/agent_memory.py
index 5704cfc..bc4b975 100644
--- a/atomic_agents/lib/components/agent_memory.py
+++ b/atomic_agents/lib/components/agent_memory.py
@@ -1,6 +1,7 @@
+import uuid
from typing import Dict, List, Optional, Union
-from pydantic import BaseModel, ValidationError
+from pydantic import BaseModel, ValidationError, Field
class Message(BaseModel):
@@ -12,12 +13,14 @@ class Message(BaseModel):
content (Union[str, Dict]): The content of the message.
tool_calls (Optional[List[Dict]]): Optional list of tool call messages.
tool_call_id (Optional[str]): Optional unique identifier for the tool call.
+ turn_id (Optional[str]): Unique identifier for the turn this message belongs to.
"""
role: str
content: Union[str, Dict]
tool_calls: Optional[List[Dict]] = None
tool_call_id: Optional[str] = None
+ turn_id: Optional[str] = None
class AgentMemory:
@@ -27,6 +30,7 @@ class AgentMemory:
Attributes:
history (List[Message]): A list of messages representing the chat history.
max_messages (Optional[int]): Maximum number of turns to keep in history.
+ current_turn_id (Optional[str]): The ID of the current turn.
"""
def __init__(self, max_messages: Optional[int] = None):
@@ -38,6 +42,13 @@ class AgentMemory:
"""
self.history: List[Message] = []
self.max_messages = max_messages
+ self.current_turn_id: Optional[str] = None
+
+ def initialize_turn(self) -> None:
+ """
+ Initializes a new turn by generating a random turn ID.
+ """
+ self.current_turn_id = str(uuid.uuid4())
def add_message(
self,
@@ -55,13 +66,13 @@ class AgentMemory:
tool_message (Optional[Dict]): Optional tool message to be included.
tool_id (Optional[str]): Optional unique identifier for the tool call.
"""
- message = Message(role=role, content=content)
- if tool_message:
- if tool_id is None:
- tool_id = tool_message["id"]
+ if self.current_turn_id is None:
+ self.initialize_turn()
+ message = Message(role=role, content=content, turn_id=self.current_turn_id)
+ if tool_message:
message.tool_calls = [tool_message]
- message.tool_call_id = tool_id
+ message.tool_call_id = tool_id or tool_message.get("id")
elif role == "tool":
message.tool_call_id = tool_id
@@ -76,23 +87,31 @@ class AgentMemory:
while len(self.history) > self.max_messages:
self.history.pop(0)
- def get_history(self) -> List[Message]:
+ def get_history(self) -> List[Dict]:
"""
- Retrieves the chat history.
+ Retrieves the chat history, filtering out unnecessary fields.
Returns:
- List[Message]: The list of messages in the chat history.
- """
- return self.history
+ List[Dict]: The list of messages in the chat history as dictionaries.
+ """
+ return [
+ {
+ "role": message.role,
+ "content": message.content,
+ **({"tool_calls": message.tool_calls} if message.tool_calls else {}),
+ **({"tool_call_id": message.tool_call_id} if message.tool_call_id else {}),
+ }
+ for message in self.history
+ ]
def dump(self) -> List[Dict]:
"""
- Converts the chat history to a list of dictionaries.
+ Converts the chat history to a list of dictionaries, including turn_id.
Returns:
- List[Dict]: The list of messages as dictionaries.
+ List[Dict]: The list of messages as dictionaries, including turn_id.
"""
- return [message.model_dump() for message in self.history]
+ return [message.model_dump(exclude_none=True) for message in self.history]
def load(self, dict_list: List[Dict]) -> None:
"""
@@ -107,14 +126,11 @@ class AgentMemory:
message = Message.model_validate(message_dict)
self.history.append(message)
except ValidationError as e:
- # Handle validation errors, e.g., log them or raise a custom exception
print(f"Error parsing message: {e}")
- # Optionally, you might want to skip invalid messages or raise an exception
- # depending on your error handling strategy
continue
-
- # Optionally, manage overflow after loading all messages
- self._manage_overflow()
+ # Set the current_turn_id to the last message's turn_id if available
+ if self.history:
+ self.current_turn_id = self.history[-1].turn_id
def copy(self) -> "AgentMemory":
"""
@@ -125,9 +141,18 @@ class AgentMemory:
"""
new_memory = AgentMemory(max_messages=self.max_messages)
new_memory.load(self.dump())
-
+ new_memory.current_turn_id = self.current_turn_id
return new_memory
+ def get_current_turn_id(self) -> Optional[str]:
+ """
+ Returns the current turn ID.
+
+ Returns:
+ Optional[str]: The current turn ID, or None if not set.
+ """
+ return self.current_turn_id
+
def get_message_count(self) -> int:
"""
Returns the number of messages in the chat history.
diff --git a/examples/conversing_agents.py b/examples/conversing_agents.py
index d9db447..b5fb8cf 100644
--- a/examples/conversing_agents.py
+++ b/examples/conversing_agents.py
@@ -29,12 +29,13 @@ agent2_system_prompt_generator = SystemPromptGenerator(
# You can use the same client for both agents if you prefer. For a list of supported clients, refer to the `instructor` library documentation.
agent1 = BaseAgent(
config=BaseAgentConfig(
- client=instructor.from_groq(groq.Groq(api_key=os.getenv("GROQ_API_KEY"))),
- model=os.getenv("GROQ_CHAT_MODEL"),
- system_prompt_generator=agent1_system_prompt_generator,
+ client=instructor.from_openai(openai.OpenAI()),
+ model="gpt-4o-mini",
+ system_prompt_generator=agent2_system_prompt_generator,
)
)
+
agent2 = BaseAgent(
config=BaseAgentConfig(
client=instructor.from_openai(openai.OpenAI()),
@@ -58,6 +59,8 @@ def simulate_conversation(num_turns=5):
console.print(f"[bold green]Agent 2:[/bold green] {agent2_response.chat_message}")
next_input = agent2_response.chat_message
+ print("Done")
+
if __name__ == "__main__":
simulate_conversation(num_turns=5)