Skip to content

docs: clarify usage of name and instructions fields in README #1331

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.

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
Closed
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion docs/agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ The most common properties of an agent you'll configure are:
- `instructions`: also known as a developer message or system prompt.
- `model`: which LLM to use, and optional `model_settings` to configure model tuning parameters like temperature, top_p, etc.
- `tools`: Tools that the agent can use to achieve its tasks.

```python
from agents import Agent, ModelSettings, function_tool

Expand All @@ -19,7 +18,9 @@ def get_weather(city: str) -> str:
return f"The weather in {city} is sunny"

agent = Agent(
# The 'name' is the agent's identity, used for context and tool calling.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What I meant was mentioning "required" or not for these two parameters rather than adding these description

name="Haiku agent",
# The 'instructions' define the agent's core behavior and rules.
instructions="Always respond in haiku form",
model="o3-mini",
tools=[get_weather],
Expand Down