Skip to content

A programming framework for agentic AI

Rename fields in agent id (#334)

Jack Gerrits437dbefc32c0
diff --git a/protos/agent_worker.proto b/protos/agent_worker.proto
index a71da103f..21bc410fd 100644
--- a/protos/agent_worker.proto
+++ b/protos/agent_worker.proto
@@ -2,6 +2,7 @@ syntax = "proto3";
package agents;
+// TODO: update
message AgentId {
string name = 1;
string namespace = 2;
diff --git a/python/samples/common/patterns/_group_chat_manager.py b/python/samples/common/patterns/_group_chat_manager.py
index 6301e739f..e119353be 100644
--- a/python/samples/common/patterns/_group_chat_manager.py
+++ b/python/samples/common/patterns/_group_chat_manager.py
@@ -60,18 +60,18 @@ class GroupChatManager(TypeRoutedAgent):
for key, value in transitions.items():
if not value:
# Make sure no empty transitions are provided.
- raise ValueError(f"Empty transition list provided for {key.name}.")
+ raise ValueError(f"Empty transition list provided for {key.type}.")
if key not in participants:
# Make sure all keys are in the list of participants.
- raise ValueError(f"Transition key {key.name} not found in participants.")
+ raise ValueError(f"Transition key {key.type} not found in participants.")
for v in value:
if v not in participants:
# Make sure all values are in the list of participants.
- raise ValueError(f"Transition value {v.name} not found in participants.")
+ raise ValueError(f"Transition value {v.type} not found in participants.")
if self._client is None:
# Make sure there is only one transition for each key if no model client is provided.
if len(value) > 1:
- raise ValueError(f"Multiple transitions provided for {key.name} but no model client is provided.")
+ raise ValueError(f"Multiple transitions provided for {key.type} but no model client is provided.")
self._tranistions = transitions
self._on_message_received = on_message_received
@@ -100,7 +100,7 @@ class GroupChatManager(TypeRoutedAgent):
# Get the last speaker.
last_speaker_name = message.source
- last_speaker_index = next((i for i, p in enumerate(self._participants) if p.name == last_speaker_name), None)
+ last_speaker_index = next((i for i, p in enumerate(self._participants) if p.type == last_speaker_name), None)
# Get the candidates for the next speaker.
if last_speaker_index is not None:
@@ -112,7 +112,7 @@ class GroupChatManager(TypeRoutedAgent):
candidates = self._participants
else:
candidates = self._participants
- logger.debug(f"Group chat manager next speaker candidates: {[c.name for c in candidates]}")
+ logger.debug(f"Group chat manager next speaker candidates: {[c.type for c in candidates]}")
# Select speaker.
if len(candidates) == 0:
@@ -138,7 +138,7 @@ class GroupChatManager(TypeRoutedAgent):
)
speaker = candidates[speaker_index]
- logger.debug(f"Group chat manager selected speaker: {speaker.name if speaker is not None else None}")
+ logger.debug(f"Group chat manager selected speaker: {speaker.type if speaker is not None else None}")
if speaker is not None:
# Send the message to the selected speaker to ask it to publish a response.
diff --git a/python/samples/common/patterns/_orchestrator_chat.py b/python/samples/common/patterns/_orchestrator_chat.py
index 862db4f15..9ebb438dd 100644
--- a/python/samples/common/patterns/_orchestrator_chat.py
+++ b/python/samples/common/patterns/_orchestrator_chat.py
@@ -136,7 +136,7 @@ Some additional points to consider:
# Find the speaker.
try:
- speaker = next(agent for agent in self._specialists if agent.name == data["next_speaker"]["answer"])
+ speaker = next(agent for agent in self._specialists if agent.type == data["next_speaker"]["answer"])
except StopIteration as e:
raise ValueError(f"Invalid next speaker: {data['next_speaker']['answer']}") from e
@@ -171,11 +171,11 @@ Some additional points to consider:
# A reusable description of the team.
team = "\n".join(
[
- agent.name + ": " + (await self.runtime.agent_metadata(agent))["description"]
+ agent.type + ": " + (await self.runtime.agent_metadata(agent))["description"]
for agent in self._specialists
]
)
- names = ", ".join([agent.name for agent in self._specialists])
+ names = ", ".join([agent.type for agent in self._specialists])
# A place to store relevant facts.
facts = ""
diff --git a/python/samples/demos/chat_room.py b/python/samples/demos/chat_room.py
index fe8ce4911..da9966992 100644
--- a/python/samples/demos/chat_room.py
+++ b/python/samples/demos/chat_room.py
@@ -98,7 +98,7 @@ async def chat_room(runtime: AgentRuntime, app: TextualChatApp) -> None:
alice = await runtime.register_and_get_proxy(
"Alice",
lambda: ChatRoomAgent(
- name=AgentInstantiationContext.current_agent_id().name,
+ name=AgentInstantiationContext.current_agent_id().type,
description="Alice in the chat room.",
background_story="Alice is a software engineer who loves to code.",
memory=BufferedChatMemory(buffer_size=10),
@@ -108,7 +108,7 @@ async def chat_room(runtime: AgentRuntime, app: TextualChatApp) -> None:
bob = await runtime.register_and_get_proxy(
"Bob",
lambda: ChatRoomAgent(
- name=AgentInstantiationContext.current_agent_id().name,
+ name=AgentInstantiationContext.current_agent_id().type,
description="Bob in the chat room.",
background_story="Bob is a data scientist who loves to analyze data.",
memory=BufferedChatMemory(buffer_size=10),
@@ -118,7 +118,7 @@ async def chat_room(runtime: AgentRuntime, app: TextualChatApp) -> None:
charlie = await runtime.register_and_get_proxy(
"Charlie",
lambda: ChatRoomAgent(
- name=AgentInstantiationContext.current_agent_id().name,
+ name=AgentInstantiationContext.current_agent_id().type,
description="Charlie in the chat room.",
background_story="Charlie is a designer who loves to create art.",
memory=BufferedChatMemory(buffer_size=10),
@@ -126,9 +126,9 @@ async def chat_room(runtime: AgentRuntime, app: TextualChatApp) -> None:
),
)
app.welcoming_notice = f"""Welcome to the chat room demo with the following participants:
-1. πŸ‘§ {alice.id.name}: {(await alice.metadata)['description']}
-2. πŸ‘±πŸΌβ€β™‚οΈ {bob.id.name}: {(await bob.metadata)['description']}
-3. πŸ‘¨πŸΎβ€πŸ¦³ {charlie.id.name}: {(await charlie.metadata)['description']}
+1. πŸ‘§ {alice.id.type}: {(await alice.metadata)['description']}
+2. πŸ‘±πŸΌβ€β™‚οΈ {bob.id.type}: {(await bob.metadata)['description']}
+3. πŸ‘¨πŸΎβ€πŸ¦³ {charlie.id.type}: {(await charlie.metadata)['description']}
Each participant decides on its own whether to respond to the latest message.
diff --git a/python/src/agnext/application/_single_threaded_agent_runtime.py b/python/src/agnext/application/_single_threaded_agent_runtime.py
index 3a7e4e33d..e70dfadc9 100644
--- a/python/src/agnext/application/_single_threaded_agent_runtime.py
+++ b/python/src/agnext/application/_single_threaded_agent_runtime.py
@@ -170,16 +170,16 @@ class SingleThreadedAgentRuntime(AgentRuntime):
# )
future = asyncio.get_event_loop().create_future()
- if recipient.name not in self._known_agent_names:
+ if recipient.type not in self._known_agent_names:
future.set_exception(Exception("Recipient not found"))
- if sender is not None and sender.namespace != recipient.namespace:
+ if sender is not None and sender.key != recipient.key:
raise ValueError("Sender and recipient must be in the same namespace to communicate.")
- await self._process_seen_namespace(recipient.namespace)
+ await self._process_seen_namespace(recipient.key)
content = message.__dict__ if hasattr(message, "__dict__") else message
- logger.info(f"Sending message of type {type(message).__name__} to {recipient.name}: {content}")
+ logger.info(f"Sending message of type {type(message).__name__} to {recipient.type}: {content}")
self._message_queue.append(
SendMessageEnvelope(
@@ -221,7 +221,7 @@ class SingleThreadedAgentRuntime(AgentRuntime):
if sender is None and namespace is None:
raise ValueError("Namespace must be provided if sender is not provided.")
- sender_namespace = sender.namespace if sender is not None else None
+ sender_namespace = sender.key if sender is not None else None
explicit_namespace = namespace
if explicit_namespace is not None and sender_namespace is not None and explicit_namespace != sender_namespace:
raise ValueError(
@@ -250,7 +250,7 @@ class SingleThreadedAgentRuntime(AgentRuntime):
async def load_state(self, state: Mapping[str, Any]) -> None:
for agent_id_str in state:
agent_id = AgentId.from_str(agent_id_str)
- if agent_id.name in self._known_agent_names:
+ if agent_id.type in self._known_agent_names:
(await self._get_agent(agent_id)).load_state(state[str(agent_id)])
async def _process_send(self, message_envelope: SendMessageEnvelope) -> None:
@@ -259,7 +259,8 @@ class SingleThreadedAgentRuntime(AgentRuntime):
# assert recipient in self._agents
try:
- sender_name = message_envelope.sender.name if message_envelope.sender is not None else "Unknown"
+ # TODO use id
+ sender_name = message_envelope.sender.type if message_envelope.sender is not None else "Unknown"
logger.info(
f"Calling message handler for {recipient} with message type {type(message_envelope.message).__name__} sent by {sender_name}"
)
@@ -297,15 +298,16 @@ class SingleThreadedAgentRuntime(AgentRuntime):
for agent_id in self._per_type_subscribers[
(target_namespace, MESSAGE_TYPE_REGISTRY.type_name(message_envelope.message))
]:
- if message_envelope.sender is not None and agent_id.name == message_envelope.sender.name:
+ if message_envelope.sender is not None and agent_id.type == message_envelope.sender.type:
continue
sender_agent = (
await self._get_agent(message_envelope.sender) if message_envelope.sender is not None else None
)
+ # TODO use id
sender_name = sender_agent.metadata["name"] if sender_agent is not None else "Unknown"
logger.info(
- f"Calling message handler for {agent_id.name} with message type {type(message_envelope.message).__name__} published by {sender_name}"
+ f"Calling message handler for {agent_id.type} with message type {type(message_envelope.message).__name__} published by {sender_name}"
)
# event_logger.info(
# MessageEvent(
@@ -342,7 +344,7 @@ class SingleThreadedAgentRuntime(AgentRuntime):
else message_envelope.message
)
logger.info(
- f"Resolving response with message type {type(message_envelope.message).__name__} for recipient {message_envelope.recipient} from {message_envelope.sender.name}: {content}"
+ f"Resolving response with message type {type(message_envelope.message).__name__} for recipient {message_envelope.recipient} from {message_envelope.sender.type}: {content}"
)
# event_logger.info(
# MessageEvent(
@@ -455,7 +457,7 @@ class SingleThreadedAgentRuntime(AgentRuntime):
# For all already prepared namespaces we need to prepare this agent
for namespace in self._known_namespaces:
- await self._get_agent(AgentId(name=name, namespace=namespace))
+ await self._get_agent(AgentId(type=name, key=namespace))
async def _invoke_agent_factory(
self,
@@ -482,23 +484,23 @@ class SingleThreadedAgentRuntime(AgentRuntime):
return agent
async def _get_agent(self, agent_id: AgentId) -> Agent:
- await self._process_seen_namespace(agent_id.namespace)
+ await self._process_seen_namespace(agent_id.key)
if agent_id in self._instantiated_agents:
return self._instantiated_agents[agent_id]
- if agent_id.name not in self._agent_factories:
- raise LookupError(f"Agent with name {agent_id.name} not found.")
+ if agent_id.type not in self._agent_factories:
+ raise LookupError(f"Agent with name {agent_id.type} not found.")
- agent_factory = self._agent_factories[agent_id.name]
+ agent_factory = self._agent_factories[agent_id.type]
agent = await self._invoke_agent_factory(agent_factory, agent_id)
for message_type in agent.metadata["subscriptions"]:
- self._per_type_subscribers[(agent_id.namespace, message_type)].add(agent_id)
+ self._per_type_subscribers[(agent_id.key, message_type)].add(agent_id)
self._instantiated_agents[agent_id] = agent
return agent
async def get(self, name: str, *, namespace: str = "default") -> AgentId:
- return (await self._get_agent(AgentId(name=name, namespace=namespace))).id
+ return (await self._get_agent(AgentId(type=name, key=namespace))).id
async def get_proxy(self, name: str, *, namespace: str = "default") -> AgentProxy:
id = await self.get(name, namespace=namespace)
@@ -506,14 +508,14 @@ class SingleThreadedAgentRuntime(AgentRuntime):
# TODO: uncomment out the following type ignore when this is fixed in mypy: https://github.com/python/mypy/issues/3737
async def try_get_underlying_agent_instance(self, id: AgentId, type: Type[T] = Agent) -> T: # type: ignore[assignment]
- if id.name not in self._agent_factories:
- raise LookupError(f"Agent with name {id.name} not found.")
+ if id.type not in self._agent_factories:
+ raise LookupError(f"Agent with name {id.type} not found.")
# TODO: check if remote
agent_instance = await self._get_agent(id)
if not isinstance(agent_instance, type):
- raise TypeError(f"Agent with name {id.name} is not of type {type.__name__}")
+ raise TypeError(f"Agent with name {id.type} is not of type {type.__name__}")
return agent_instance
@@ -525,4 +527,4 @@ class SingleThreadedAgentRuntime(AgentRuntime):
self._known_namespaces.add(namespace)
for name in self._known_agent_names:
- await self._get_agent(AgentId(name=name, namespace=namespace))
+ await self._get_agent(AgentId(type=name, key=namespace))
diff --git a/python/src/agnext/application/logging/events.py b/python/src/agnext/application/logging/events.py
index 7fd270af9..f3fc71151 100644
--- a/python/src/agnext/application/logging/events.py
+++ b/python/src/agnext/application/logging/events.py
@@ -2,7 +2,7 @@ import json
from enum import Enum
from typing import Any, cast
-from ...core import Agent
+from agnext.core import AgentId
class LLMCallEvent:
@@ -57,16 +57,16 @@ class MessageEvent:
self,
*,
payload: Any,
- sender: Agent | None,
- receiver: Agent | None,
+ sender: AgentId | None,
+ receiver: AgentId | None,
kind: MessageKind,
delivery_stage: DeliveryStage,
**kwargs: Any,
) -> None:
self.kwargs = kwargs
self.kwargs["payload"] = payload
- self.kwargs["sender"] = None if sender is None else sender.metadata["name"]
- self.kwargs["receiver"] = None if receiver is None else receiver.metadata["name"]
+ self.kwargs["sender"] = None if sender is None else str(sender)
+ self.kwargs["receiver"] = None if receiver is None else str(receiver)
self.kwargs["kind"] = kind
self.kwargs["delivery_stage"] = delivery_stage
self.kwargs["type"] = "Message"
diff --git a/python/src/agnext/components/_closure_agent.py b/python/src/agnext/components/_closure_agent.py
index 29da06fbb..792ed1ed0 100644
--- a/python/src/agnext/components/_closure_agent.py
+++ b/python/src/agnext/components/_closure_agent.py
@@ -68,16 +68,12 @@ class ClosureAgent(Agent):
def metadata(self) -> AgentMetadata:
assert self._id is not None
return AgentMetadata(
- namespace=self._id.namespace,
- name=self._id.name,
+ namespace=self._id.key,
+ name=self._id.type,
description=self._description,
subscriptions=self._subscriptions,
)
- @property
- def name(self) -> str:
- return self.id.name
-
@property
def id(self) -> AgentId:
return self._id
diff --git a/python/src/agnext/components/_type_subscription.py b/python/src/agnext/components/_type_subscription.py
index 899feaa7e..437eabb7b 100644
--- a/python/src/agnext/components/_type_subscription.py
+++ b/python/src/agnext/components/_type_subscription.py
@@ -43,4 +43,4 @@ class TypeSubscription(Subscription):
raise CantHandleException("TopicId does not match the subscription")
# TODO: Update agentid to reflect agent type and key
- return AgentId(name=self._agent_type, namespace=topic_id.source)
+ return AgentId(type=self._agent_type, key=topic_id.source)
diff --git a/python/src/agnext/core/_agent_id.py b/python/src/agnext/core/_agent_id.py
index 1a39482e6..a1d9ae6d5 100644
--- a/python/src/agnext/core/_agent_id.py
+++ b/python/src/agnext/core/_agent_id.py
@@ -2,33 +2,39 @@ from typing_extensions import Self
class AgentId:
- def __init__(self, name: str, namespace: str) -> None:
- self._name = name
- self._namespace = namespace
+ def __init__(self, type: str, key: str) -> None:
+ if type.isidentifier() is False:
+ raise ValueError(f"Invalid type: {type}")
- def __str__(self) -> str:
- return f"{self._namespace}/{self._name}"
+ self._type = type
+ self._key = key
def __hash__(self) -> int:
- return hash((self._namespace, self._name))
+ return hash((self._type, self._key))
+
+ def __str__(self) -> str:
+ return f"{self._type}:{self._key}"
def __repr__(self) -> str:
- return f"AgentId({self._name}, {self._namespace})"
+ return f'AgentId(type="{self._type}", key="{self._key}")'
def __eq__(self, value: object) -> bool:
if not isinstance(value, AgentId):
return False
- return self._name == value.name and self._namespace == value.namespace
+ return self._type == value.type and self._key == value.key
@classmethod
def from_str(cls, agent_id: str) -> Self:
- namespace, name = agent_id.split("/")
- return cls(name, namespace)
+ items = agent_id.split(":", maxsplit=1)
+ if len(items) != 2:
+ raise ValueError(f"Invalid agent id: {agent_id}")
+ type, key = items[0], items[1]
+ return cls(type, key)
@property
- def namespace(self) -> str:
- return self._namespace
+ def type(self) -> str:
+ return self._type
@property
- def name(self) -> str:
- return self._name
+ def key(self) -> str:
+ return self._key
diff --git a/python/src/agnext/core/_base_agent.py b/python/src/agnext/core/_base_agent.py
index 3b72e2dea..738881dc8 100644
--- a/python/src/agnext/core/_base_agent.py
+++ b/python/src/agnext/core/_base_agent.py
@@ -15,8 +15,8 @@ class BaseAgent(ABC, Agent):
def metadata(self) -> AgentMetadata:
assert self._id is not None
return AgentMetadata(
- namespace=self._id.namespace,
- name=self._id.name,
+ namespace=self._id.key,
+ name=self._id.type,
description=self._description,
subscriptions=self._subscriptions,
)
@@ -38,8 +38,8 @@ class BaseAgent(ABC, Agent):
self._subscriptions = subscriptions
@property
- def name(self) -> str:
- return self.id.name
+ def type(self) -> str:
+ return self.id.type
@property
def id(self) -> AgentId:
diff --git a/python/src/agnext/worker/worker_runtime.py b/python/src/agnext/worker/worker_runtime.py
index a81d3db27..71bfc71de 100644
--- a/python/src/agnext/worker/worker_runtime.py
+++ b/python/src/agnext/worker/worker_runtime.py
@@ -292,8 +292,8 @@ class WorkerAgentRuntime(AgentRuntime):
runtime_message = Message(
request=RpcRequest(
request_id=request_id_str,
- target=AgentIdProto(name=recipient.name, namespace=recipient.namespace),
- source=AgentIdProto(name=sender.name, namespace=sender.namespace),
+ target=AgentIdProto(name=recipient.type, namespace=recipient.key),
+ source=AgentIdProto(name=sender.type, namespace=sender.key),
data=message,
)
)
@@ -310,7 +310,7 @@ class WorkerAgentRuntime(AgentRuntime):
cancellation_token: CancellationToken | None = None,
) -> None:
assert self._runtime_connection is not None
- sender_namespace = sender.namespace if sender is not None else None
+ sender_namespace = sender.key if sender is not None else None
explicit_namespace = namespace
if explicit_namespace is not None and sender_namespace is not None and explicit_namespace != sender_namespace:
raise ValueError(
@@ -356,7 +356,7 @@ class WorkerAgentRuntime(AgentRuntime):
# For all already prepared namespaces we need to prepare this agent
for namespace in self._known_namespaces:
- await self._get_agent(AgentId(name=name, namespace=namespace))
+ await self._get_agent(AgentId(type=name, key=namespace))
await self.send_register_agent_type(name)
@@ -385,25 +385,25 @@ class WorkerAgentRuntime(AgentRuntime):
return agent
async def _get_agent(self, agent_id: AgentId) -> Agent:
- await self._process_seen_namespace(agent_id.namespace)
+ await self._process_seen_namespace(agent_id.key)
if agent_id in self._instantiated_agents:
return self._instantiated_agents[agent_id]
- if agent_id.name not in self._agent_factories:
- raise ValueError(f"Agent with name {agent_id.name} not found.")
+ if agent_id.type not in self._agent_factories:
+ raise ValueError(f"Agent with name {agent_id.type} not found.")
- agent_factory = self._agent_factories[agent_id.name]
+ agent_factory = self._agent_factories[agent_id.type]
agent = await self._invoke_agent_factory(agent_factory, agent_id)
for message_type in agent.metadata["subscriptions"]:
- self._per_type_subscribers[(agent_id.namespace, message_type)].add(agent_id)
+ self._per_type_subscribers[(agent_id.key, message_type)].add(agent_id)
self._instantiated_agents[agent_id] = agent
return agent
async def get(self, name: str, *, namespace: str = "default") -> AgentId:
- return (await self._get_agent(AgentId(name=name, namespace=namespace))).id
+ return (await self._get_agent(AgentId(type=name, key=namespace))).id
async def get_proxy(self, name: str, *, namespace: str = "default") -> AgentProxy:
id = await self.get(name, namespace=namespace)
@@ -421,4 +421,4 @@ class WorkerAgentRuntime(AgentRuntime):
self._known_namespaces.add(namespace)
for name in self._known_agent_names:
- await self._get_agent(AgentId(name=name, namespace=namespace))
+ await self._get_agent(AgentId(type=name, key=namespace))
diff --git a/python/tests/test_closure_agent.py b/python/tests/test_closure_agent.py
index 4543d8fe2..cb5512041 100644
--- a/python/tests/test_closure_agent.py
+++ b/python/tests/test_closure_agent.py
@@ -25,8 +25,8 @@ async def test_register_receives_publish() -> None:
queue = asyncio.Queue[tuple[str, str]]()
async def log_message(_runtime: AgentRuntime, id: AgentId, message: Message, cancellation_token: CancellationToken) -> None:
- namespace = id.namespace
- await queue.put((namespace, message.content))
+ key = id.key
+ await queue.put((key, message.content))
await runtime.register("name", lambda: ClosureAgent("My agent", log_message))
run_context = runtime.start()
diff --git a/python/tests/test_subscription.py b/python/tests/test_subscription.py
index d5d6cf702..849d2f008 100644
--- a/python/tests/test_subscription.py
+++ b/python/tests/test_subscription.py
@@ -16,7 +16,7 @@ def test_type_subscription_match() -> None:
def test_type_subscription_map() -> None:
sub = TypeSubscription(topic_type="t1", agent_type="a1")
- assert sub.map_to_agent(TopicId(type="t1", source="s1")) == AgentId(name="a1", namespace="s1")
+ assert sub.map_to_agent(TopicId(type="t1", source="s1")) == AgentId(type="a1", key="s1")
with pytest.raises(CantHandleException):
_agent_id = sub.map_to_agent(TopicId(type="t0", source="s1"))