Skip to content

docs: add minimal Agent instantiation example to docstring #2324

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Arnav-Ajay wants to merge 1 commit into from
+8 −0
Closed

docs: add minimal Agent instantiation example to docstring #2324

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/agents/agent.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,14 @@ class Agent(AgentBase, Generic[TContext]):
Agents are generic on the context type. The context is a (mutable) object you create. It is
passed to tool functions, handoffs, guardrails, etc.

Example:
from agents import Agent

agent = Agent(
name="example",
instructions="Say hello"
)

See `AgentBase` for base parameters that are shared with `RealtimeAgent`s.
"""

Expand Down