Fix typo on Agent documentation (#151)

Argument name is not description but handoff_description
This commit is contained in:
Rohan Mehta 2025-03-17 16:51:47 -04:00 committed by GitHub
commit d0a7b00086
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

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