Skip to content

Commit 7253030

Browse files
authored
Fix typo on Agent documentation (openai#151)
Argument name is not description but handoff_description
2 parents 7f1b04e + 268ea2f commit 7253030

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/agents/agent.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ class Agent(Generic[TContext]):
2727
"""An agent is an AI model configured with instructions, tools, guardrails, handoffs and more.
2828
2929
We strongly recommend passing `instructions`, which is the "system prompt" for the agent. In
30-
addition, you can pass `description`, which is a human-readable description of the agent, used
31-
when the agent is used inside tools/handoffs.
30+
addition, you can pass `handoff_description`, which is a human-readable description of the
31+
agent, used when the agent is used inside tools/handoffs.
3232
3333
Agents are generic on the context type. The context is a (mutable) object you create. It is
3434
passed to tool functions, handoffs, guardrails, etc.

0 commit comments

Comments
 (0)