add details

Author: Charlotte Zhuang

examples/tutorials/10_agentic/10_temporal/011_custom_agent_chat/example.env

@@ -0,0 +1,3 @@
+OPENAI_API_KEY=123
+SCALE_GP_API_KEY=abc
+SCALE_GP_ACCOUNT_ID=456

examples/tutorials/10_agentic/10_temporal/011_custom_agent_chat/project/special_run_agent.py

@@ -66,6 +66,8 @@ class SpecialRunAgentParams:
 
 
 class SpecialRunAgentResult(TypedDict):
+    """Note that activities must return a serializable dict."""
+
     final_output: Any
     """The final output of the agent. This should not be None."""
 
@@ -75,7 +77,11 @@ class SpecialRunAgentResult(TypedDict):
 
 @activity.defn(name=SPECIAL_RUN_AGENT_ACTIVITY_NAME)
 async def special_run_agent(params: SpecialRunAgentParams) -> SpecialRunAgentResult:
-    """Run an agent with streaming and automatic TaskMessage creation."""
+    """
+    Run an agent with streaming and automatic TaskMessage creation.
+    
+    Note that activities must return a serializable dict.
+    """
 
     tool_call_map: dict[str, ResponseFunctionToolCall] = {}
     redacted_params = redact_mcp_server_params(

examples/tutorials/10_agentic/10_temporal/011_custom_agent_chat/project/workflow.py

@@ -118,7 +118,7 @@ async def on_task_event_send(self, params: SendEventParams) -> None:
                     parent_span_id=span.id if span else None,
                 )
 
-            # Custom activity that generates a response
+            # Custom activity that we implemented in special_run_agent.py
             run_result: SpecialRunAgentResult = await workflow.execute_activity(
                 activity=SPECIAL_RUN_AGENT_ACTIVITY_NAME,
                 arg=SpecialRunAgentParams(