From cb77ea3f651f12679aa35620eb50556c00789ef0 Mon Sep 17 00:00:00 2001
From: jhills20 <james.hills@openai.com>
Date: Tue, 25 Mar 2025 10:45:34 -0700
Subject: [PATCH 1/2] triage agent tool choice requried + respond to user
---
docs/examples.md | 9 ++++---
examples/customer_service/main.py | 43 +++++++++++++++++++++++--------
2 files changed, 37 insertions(+), 15 deletions(-)
diff --git a/docs/examples.md b/docs/examples.md
index 1d3ebde7..16ee9f50 100644
--- a/docs/examples.md
+++ b/docs/examples.md
@@ -7,14 +7,14 @@ Check out a variety of sample implementations of the SDK in the examples section
- **agent_patterns:**
Examples in this category illustrate common agent design patterns, such as
-
+
- Deterministic workflows
- Agents as tools
- Parallel agent execution
- **basic:**
These examples showcase foundational capabilities of the SDK, such as
-
+
- Dynamic system prompts
- Streaming outputs
- Lifecycle events
@@ -31,6 +31,7 @@ Check out a variety of sample implementations of the SDK in the examples section
- **customer_service** and **research_bot:**
Two more built-out examples that illustrate real-world applications
-
- - **customer_service**: Example customer service system for an airline.
+
+ - **customer_service**: Example customer service system for an airline, with
+ `tool_choice` required for the triage agent.
- **research_bot**: Simple deep research clone.
diff --git a/examples/customer_service/main.py b/examples/customer_service/main.py
index bd802e22..4f6d0e4d 100644
--- a/examples/customer_service/main.py
+++ b/examples/customer_service/main.py
@@ -1,4 +1,4 @@
-from __future__ import annotations as _annotations
+from __future__ import annotations
import asyncio
import random
@@ -6,12 +6,14 @@
from pydantic import BaseModel
-from agents import (
+from src.agents import (
Agent,
HandoffOutputItem,
ItemHelpers,
MessageOutputItem,
+ ModelSettings,
RunContextWrapper,
+ RunConfig,
Runner,
ToolCallItem,
ToolCallOutputItem,
@@ -20,7 +22,7 @@
handoff,
trace,
)
-from agents.extensions.handoff_prompt import RECOMMENDED_PROMPT_PREFIX
+from src.agents.extensions.handoff_prompt import RECOMMENDED_PROMPT_PREFIX
### CONTEXT
@@ -74,9 +76,13 @@ async def update_seat(
assert context.context.flight_number is not None, "Flight number is required"
return f"Updated seat to {new_seat} for confirmation number {confirmation_number}"
-
-### HOOKS
-
+@function_tool
+async def respond_to_user(response: str) -> str:
+ """
+ Use this function to send a message back to the end user. The agent should call this whenever
+ you want to produce a user-facing response.
+ """
+ return response
async def on_seat_booking_handoff(context: RunContextWrapper[AirlineAgentContext]) -> None:
flight_number = f"FLT-{random.randint(100, 999)}"
@@ -95,7 +101,7 @@ async def on_seat_booking_handoff(context: RunContextWrapper[AirlineAgentContext
1. Identify the last question asked by the customer.
2. Use the faq lookup tool to answer the question. Do not rely on your own knowledge.
3. If you cannot answer the question, transfer back to the triage agent.""",
- tools=[faq_lookup_tool],
+ tools=[faq_lookup_tool, respond_to_user],
)
seat_booking_agent = Agent[AirlineAgentContext](
@@ -109,7 +115,7 @@ async def on_seat_booking_handoff(context: RunContextWrapper[AirlineAgentContext
2. Ask the customer what their desired seat number is.
3. Use the update seat tool to update the seat on the flight.
If the customer asks a question that is not related to the routine, transfer back to the triage agent. """,
- tools=[update_seat],
+ tools=[update_seat, respond_to_user],
)
triage_agent = Agent[AirlineAgentContext](
@@ -122,7 +128,12 @@ async def on_seat_booking_handoff(context: RunContextWrapper[AirlineAgentContext
handoffs=[
faq_agent,
handoff(agent=seat_booking_agent, on_handoff=on_seat_booking_handoff),
+ respond_to_user
],
+ tools=[respond_to_user],
+ model_settings=ModelSettings(tool_choice="required"),
+ tool_use_behavior={"stop_at_tool_names": ["respond_to_user"]},
+
)
faq_agent.handoffs.append(triage_agent)
@@ -145,20 +156,30 @@ async def main():
user_input = input("Enter your message: ")
with trace("Customer service", group_id=conversation_id):
input_items.append({"content": user_input, "role": "user"})
- result = await Runner.run(current_agent, input_items, context=context)
+ result = await Runner.run(current_agent, input_items, context=context,run_config=RunConfig(tracing_disabled=True))
+ last_tool_name: str | None = None
for new_item in result.new_items:
agent_name = new_item.agent.name
if isinstance(new_item, MessageOutputItem):
+ # In tool_choice="required" scenarios, the agent won't produce bare messages;
+ # instead it will call `respond_to_user`. But if the example is run without
+ # requiring tool_choice, this branch will handle direct messages.
print(f"{agent_name}: {ItemHelpers.text_message_output(new_item)}")
elif isinstance(new_item, HandoffOutputItem):
print(
f"Handed off from {new_item.source_agent.name} to {new_item.target_agent.name}"
)
elif isinstance(new_item, ToolCallItem):
- print(f"{agent_name}: Calling a tool")
+ # Stash the name of the tool call so we can treat respond_to_user specially
+ last_tool_name = getattr(new_item.raw_item, "name", None)
+ print(f"{agent_name} called tool:{f' {last_tool_name}' if last_tool_name else ''}")
elif isinstance(new_item, ToolCallOutputItem):
- print(f"{agent_name}: Tool call output: {new_item.output}")
+ # If the tool call was respond_to_user, treat its output as the message to display.
+ if last_tool_name == "respond_to_user":
+ print(f"{agent_name}: {new_item.output}")
+ else:
+ print(f"{agent_name}: Tool call output: {new_item.output}")
else:
print(f"{agent_name}: Skipping item: {new_item.__class__.__name__}")
input_items = result.to_input_list()
From 9402b82b3b4e0adf3dbc61fe24ed1d0cde0a5289 Mon Sep 17 00:00:00 2001
From: jhills20 <james.hills@openai.com>
Date: Tue, 25 Mar 2025 10:49:11 -0700
Subject: [PATCH 2/2] remove comments
---
examples/customer_service/main.py | 11 +++--------
1 file changed, 3 insertions(+), 8 deletions(-)
diff --git a/examples/customer_service/main.py b/examples/customer_service/main.py
index 4f6d0e4d..0201380f 100644
--- a/examples/customer_service/main.py
+++ b/examples/customer_service/main.py
@@ -1,4 +1,4 @@
-from __future__ import annotations
+from __future__ import annotations as _annotations
import asyncio
import random
@@ -6,7 +6,7 @@
from pydantic import BaseModel
-from src.agents import (
+from agents import (
Agent,
HandoffOutputItem,
ItemHelpers,
@@ -22,7 +22,7 @@
handoff,
trace,
)
-from src.agents.extensions.handoff_prompt import RECOMMENDED_PROMPT_PREFIX
+from agents.extensions.handoff_prompt import RECOMMENDED_PROMPT_PREFIX
### CONTEXT
@@ -162,20 +162,15 @@ async def main():
for new_item in result.new_items:
agent_name = new_item.agent.name
if isinstance(new_item, MessageOutputItem):
- # In tool_choice="required" scenarios, the agent won't produce bare messages;
- # instead it will call `respond_to_user`. But if the example is run without
- # requiring tool_choice, this branch will handle direct messages.
print(f"{agent_name}: {ItemHelpers.text_message_output(new_item)}")
elif isinstance(new_item, HandoffOutputItem):
print(
f"Handed off from {new_item.source_agent.name} to {new_item.target_agent.name}"
)
elif isinstance(new_item, ToolCallItem):
- # Stash the name of the tool call so we can treat respond_to_user specially
last_tool_name = getattr(new_item.raw_item, "name", None)
print(f"{agent_name} called tool:{f' {last_tool_name}' if last_tool_name else ''}")
elif isinstance(new_item, ToolCallOutputItem):
- # If the tool call was respond_to_user, treat its output as the message to display.
if last_tool_name == "respond_to_user":
print(f"{agent_name}: {new_item.output}")
else: