From 361bf81c45f97dbf42a69fcdd0d77886b9c57829 Mon Sep 17 00:00:00 2001 From: UmmeHabiba1312 Date: Thu, 31 Jul 2025 21:59:12 +0500 Subject: [PATCH 1/8] docs: clarify behavior of 'name' vs 'instructions' in Agent --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 638f94b21..00a9389f8 100644 --- a/README.md +++ b/README.md @@ -168,6 +168,12 @@ print(result.final_output) (_For Jupyter notebook users, see [hello_world_jupyter.ipynb](examples/basic/hello_world_jupyter.ipynb)_) +### Note on `name` vs `instructions` + +- `name` is a **required** parameter used to identify your agent internally (for logs, tracing, handoffs, etc.), **but it is not passed to the LLM**. +- `instructions` is an **optional** parameter, but it **is sent to the LLM** as a system prompt to define how the agent should behave. + + ## Handoffs example ```python From 43be29effc594ad2f8b42e81dcd385b97653fa2e Mon Sep 17 00:00:00 2001 From: UmmeHabiba1312 Date: Thu, 31 Jul 2025 22:04:35 +0500 Subject: [PATCH 2/8] docs: clarify usage of ame and instructions in Agent --- README.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/README.md b/README.md index 00a9389f8..638f94b21 100644 --- a/README.md +++ b/README.md @@ -168,12 +168,6 @@ print(result.final_output) (_For Jupyter notebook users, see [hello_world_jupyter.ipynb](examples/basic/hello_world_jupyter.ipynb)_) -### Note on `name` vs `instructions` - -- `name` is a **required** parameter used to identify your agent internally (for logs, tracing, handoffs, etc.), **but it is not passed to the LLM**. -- `instructions` is an **optional** parameter, but it **is sent to the LLM** as a system prompt to define how the agent should behave. - - ## Handoffs example ```python From 6760bf839e15ef0edc88340deaf7a607d7bfa71b Mon Sep 17 00:00:00 2001 From: UmmeHabiba1312 Date: Thu, 31 Jul 2025 22:17:20 +0500 Subject: [PATCH 3/8] docs: clarify difference between ame and instructions in README --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 638f94b21..20f800a1d 100644 --- a/README.md +++ b/README.md @@ -168,6 +168,13 @@ print(result.final_output) (_For Jupyter notebook users, see [hello_world_jupyter.ipynb](examples/basic/hello_world_jupyter.ipynb)_) +### Note on `name` vs `instructions` + +- `name` is a **required** parameter used to identify your agent internally (for logs, tracing, handoffs, etc.), **but it is not passed to the LLM**. +- `instructions` is an **optional** parameter, but it **is sent to the LLM** as a system prompt to define how the agent should behave. + + + ## Handoffs example ```python From 2c481d20923cffaa5b6762d5a603d6ab5986d445 Mon Sep 17 00:00:00 2001 From: UmmeHabiba1312 Date: Sun, 3 Aug 2025 07:14:01 +0500 Subject: [PATCH 4/8] removefrom Readme.Md fix --- README.md | 7 ------- docs/agents.md | 15 +++++++-------- 2 files changed, 7 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 20f800a1d..638f94b21 100644 --- a/README.md +++ b/README.md @@ -168,13 +168,6 @@ print(result.final_output) (_For Jupyter notebook users, see [hello_world_jupyter.ipynb](examples/basic/hello_world_jupyter.ipynb)_) -### Note on `name` vs `instructions` - -- `name` is a **required** parameter used to identify your agent internally (for logs, tracing, handoffs, etc.), **but it is not passed to the LLM**. -- `instructions` is an **optional** parameter, but it **is sent to the LLM** as a system prompt to define how the agent should behave. - - - ## Handoffs example ```python diff --git a/docs/agents.md b/docs/agents.md index b11a4dd68..7c9b9cc68 100644 --- a/docs/agents.md +++ b/docs/agents.md @@ -1,25 +1,24 @@ -# Agents - -Agents are the core building block in your apps. An agent is a large language model (LLM), configured with instructions and tools. - ## Basic configuration The most common properties of an agent you'll configure are: -- `name`: A required string that identifies your agent. -- `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. +- name: A required string that identifies your agent. +- 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 @function_tool def get_weather(city: str) -> str: + """returns weather info for the specified city.""" return f"The weather in {city} is sunny" agent = Agent( + # The 'name' is the agent's identity, used for context and tool calling. 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], From 7da37ed0710ca26c1fd0ac962a80ae4d2a9fade1 Mon Sep 17 00:00:00 2001 From: UmmeHabiba1312 Date: Sun, 3 Aug 2025 07:15:30 +0500 Subject: [PATCH 5/8] Update agents.md --- docs/agents.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/agents.md b/docs/agents.md index 7c9b9cc68..e36c3326a 100644 --- a/docs/agents.md +++ b/docs/agents.md @@ -4,7 +4,7 @@ The most common properties of an agent you'll configure are: - name: A required string that identifies your agent. - 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. +- 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 e47ac692b605cbcf8bb06a080103ce15330a956c Mon Sep 17 00:00:00 2001 From: UmmeHabiba1312 Date: Sun, 3 Aug 2025 07:18:54 +0500 Subject: [PATCH 6/8] Update agents.md --- docs/agents.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/agents.md b/docs/agents.md index e36c3326a..d3d8055cd 100644 --- a/docs/agents.md +++ b/docs/agents.md @@ -1,3 +1,7 @@ +# Agents + +Agents are the core building block in your apps. An agent is a large language model (LLM), configured with instructions and tools. + ## Basic configuration The most common properties of an agent you'll configure are: @@ -6,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 From 53d4423ddf7101ec91a5534682a68495141a2328 Mon Sep 17 00:00:00 2001 From: UmmeHabiba1312 Date: Sun, 3 Aug 2025 07:22:16 +0500 Subject: [PATCH 7/8] Update agents.md --- docs/agents.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/agents.md b/docs/agents.md index d3d8055cd..83d2134c8 100644 --- a/docs/agents.md +++ b/docs/agents.md @@ -9,13 +9,12 @@ The most common properties of an agent you'll configure are: - name: A required string that identifies your agent. - 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. +- tools: Tools that the agent can use to achieve its tasks. ```python from agents import Agent, ModelSettings, function_tool @function_tool def get_weather(city: str) -> str: - """returns weather info for the specified city.""" return f"The weather in {city} is sunny" agent = Agent( From 028666d580cb52f4fa047f063cea50731f8b7ae3 Mon Sep 17 00:00:00 2001 From: UmmeHabiba1312 Date: Sun, 3 Aug 2025 07:23:51 +0500 Subject: [PATCH 8/8] Update agents.md --- docs/agents.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/agents.md b/docs/agents.md index 83d2134c8..f0bf5e662 100644 --- a/docs/agents.md +++ b/docs/agents.md @@ -6,10 +6,10 @@ Agents are the core building block in your apps. An agent is a large language mo The most common properties of an agent you'll configure are: -- name: A required string that identifies your agent. -- 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. +- `name`: A required string that identifies your agent. +- `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