Skip to content

A programming framework for agentic AI

Add documentation and TODOs for xlang (#4926)

peterychangd610d481cdcd
diff --git a/python/packages/autogen-core/docs/src/user-guide/core-user-guide/framework/distributed-agent-runtime.ipynb b/python/packages/autogen-core/docs/src/user-guide/core-user-guide/framework/distributed-agent-runtime.ipynb
index 7ba80bb98..bdf53792d 100644
--- a/python/packages/autogen-core/docs/src/user-guide/core-user-guide/framework/distributed-agent-runtime.ipynb
+++ b/python/packages/autogen-core/docs/src/user-guide/core-user-guide/framework/distributed-agent-runtime.ipynb
@@ -189,6 +189,9 @@
"cell_type": "markdown",
"metadata": {},
"source": [
+ "# Cross-Language Runtimes\n",
+ "The process described above is largely the same, however all message types MUST use shared protobuf schemas for all cross-agent message types.\n",
+ "\n",
"# Next Steps\n",
"To see complete examples of using distributed runtime, please take a look at the following samples:\n",
"\n",
diff --git a/python/packages/autogen-ext/src/autogen_ext/runtimes/grpc/_worker_runtime.py b/python/packages/autogen-ext/src/autogen_ext/runtimes/grpc/_worker_runtime.py
index 4ae66e44c..e764b0644 100644
--- a/python/packages/autogen-ext/src/autogen_ext/runtimes/grpc/_worker_runtime.py
+++ b/python/packages/autogen-ext/src/autogen_ext/runtimes/grpc/_worker_runtime.py
@@ -178,7 +178,32 @@ class HostConnection:
return await self._recv_queue.get()
+# TODO: Lots of types need to have protobuf equivalents:
+# Core:
+# - FunctionCall, CodeResult, possibly CodeBlock
+# - All the types in https://github.com/microsoft/autogen/blob/main/python/packages/autogen-core/src/autogen_core/models/_types.py
+#
+# Agentchat:
+# - All the types in https://github.com/microsoft/autogen/blob/main/python/packages/autogen-agentchat/src/autogen_agentchat/messages.py to protobufs.
+#
+# Ext --
+# CodeExecutor:
+# - CommandLineCodeResult
+
+
class GrpcWorkerAgentRuntime(AgentRuntime):
+ """An agent runtime for running remote or cross-language agents.
+
+ Agent messaging uses protobufs from `agent_worker.proto`_ and ``CloudEvent`` from `cloudevent.proto`_.
+
+ Cross-language agents will additionally require all agents use shared protobuf schemas for any message types that are sent between agents.
+
+ .. _agent_worker.proto: https://github.com/microsoft/autogen/blob/main/protos/agent_worker.proto
+
+ .. _cloudevent.proto: https://github.com/microsoft/autogen/blob/main/protos/cloudevent.proto
+
+ """
+
# TODO: Needs to handle agent close() call
def __init__(
self,