Skip to content

Commit e4bac46

Browse files
authored
Merge pull request #923 from MicrosoftDocs/main
Merge main to live
2 parents 9de3a6b + 7a5bd5a commit e4bac46

16 files changed

Lines changed: 735 additions & 181 deletions

.openpublishing.redirection.json

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1022,17 +1022,22 @@
10221022
},
10231023
{
10241024
"source_path": "agent-framework/user-guide/agents/agent-types/azure-ai-foundry-agent.md",
1025-
"redirect_url": "/agent-framework/agents/providers/azure-ai-foundry",
1025+
"redirect_url": "/agent-framework/agents/providers/microsoft-foundry",
10261026
"redirect_document_id": true
10271027
},
10281028
{
10291029
"source_path": "agent-framework/user-guide/agents/agent-types/azure-ai-foundry-models-chat-completion-agent.md",
1030-
"redirect_url": "/agent-framework/agents/providers/azure-ai-foundry",
1030+
"redirect_url": "/agent-framework/agents/providers/microsoft-foundry",
10311031
"redirect_document_id": false
10321032
},
10331033
{
10341034
"source_path": "agent-framework/user-guide/agents/agent-types/azure-ai-foundry-models-responses-agent.md",
1035-
"redirect_url": "/agent-framework/agents/providers/azure-ai-foundry",
1035+
"redirect_url": "/agent-framework/agents/providers/microsoft-foundry",
1036+
"redirect_document_id": false
1037+
},
1038+
{
1039+
"source_path": "agent-framework/agents/providers/azure-ai-foundry.md",
1040+
"redirect_url": "/agent-framework/agents/providers/microsoft-foundry",
10361041
"redirect_document_id": false
10371042
},
10381043
{

agent-framework/TOC.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ items:
9999
- name: OpenAI
100100
href: agents/providers/openai.md
101101
- name: Microsoft Foundry
102-
href: agents/providers/azure-ai-foundry.md
102+
href: agents/providers/microsoft-foundry.md
103103
- name: Anthropic
104104
href: agents/providers/anthropic.md
105105
- name: Ollama

agent-framework/agents/background-responses.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ zone_pivot_groups: programming-languages
55
author: sergeymenshykh
66
ms.topic: reference
77
ms.author: semenshi
8-
ms.date: 10/16/2025
8+
ms.date: 03/13/2026
99
ms.service: agent-framework
1010
---
1111

@@ -58,7 +58,7 @@ For non-streaming scenarios, when you initially run an agent, it may or may not
5858
AIAgent agent = new AzureOpenAIClient(
5959
new Uri("https://<myresource>.openai.azure.com"),
6060
new DefaultAzureCredential())
61-
.GetOpenAIResponseClient("<deployment-name>")
61+
.GetResponsesClient("<deployment-name>")
6262
.AsAIAgent();
6363

6464
AgentRunOptions options = new()
@@ -103,7 +103,7 @@ In streaming scenarios, background responses work much like regular streaming re
103103
AIAgent agent = new AzureOpenAIClient(
104104
new Uri("https://<myresource>.openai.azure.com"),
105105
new DefaultAzureCredential())
106-
.GetOpenAIResponseClient("<deployment-name>")
106+
.GetResponsesClient("<deployment-name>")
107107
.AsAIAgent();
108108

109109
AgentRunOptions options = new()
@@ -180,7 +180,7 @@ agent = Agent(
180180
client=OpenAIResponsesClient(model_id="o3"),
181181
)
182182

183-
session = await agent.create_session()
183+
session = agent.create_session()
184184

185185
# Start a background run — returns immediately
186186
response = await agent.run(
@@ -212,7 +212,7 @@ print(response.text)
212212
In streaming scenarios, background responses work like regular streaming — the agent streams updates back in real time. The key difference is that each update includes a `continuation_token`, enabling stream resumption if the connection is interrupted:
213213

214214
```python
215-
session = await agent.create_session()
215+
session = agent.create_session()
216216

217217
# Start a streaming background run
218218
last_token = None

agent-framework/agents/index.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The Microsoft Agent Framework provides support for several types of agents to ac
1919
All agents are derived from a common base class, `AIAgent`, which provides a consistent interface for all agent types. This allows for building common, agent agnostic, higher level functionality such as multi-agent orchestrations.
2020
::: zone-end
2121
::: zone pivot="programming-language-python"
22-
All agents are derived from a common base class, [`Agent`](/python/api/agent-framework-core/agent_framework.agent?view=agent-framework-python-latest), which provides a consistent interface for all agent types. This allows for building common, agent agnostic, higher level functionality such as multi-agent orchestrations.
22+
All agents are derived from a common base class, `Agent`, which provides a consistent interface for all agent types. This allows for building common, agent agnostic, higher level functionality such as multi-agent orchestrations.
2323
::: zone-end
2424

2525
## Default Agent Runtime Execution Model
@@ -57,9 +57,9 @@ To make creating these agents even easier, Agent Framework provides helpers for
5757

5858
| Underlying inference service | Description | Service chat history storage supported | InMemory/Custom chat history storage supported |
5959
|------------------------------|-------------|----------------------------------------|------------------------------------------------|
60-
|[Microsoft Foundry Agent](./providers/azure-ai-foundry.md)|An agent that uses the Foundry Agent Service as its backend.|Yes|No|
61-
|[Foundry Models ChatCompletion](./providers/azure-ai-foundry.md)|An agent that uses any of the models deployed in the Foundry Service as its backend via ChatCompletion.|No|Yes|
62-
|[Foundry Models Responses](./providers/azure-ai-foundry.md)|An agent that uses any of the models deployed in the Foundry Service as its backend via Responses.|Yes|Yes|
60+
|[Microsoft Foundry Agent](./providers/microsoft-foundry.md)|An agent that uses the Foundry Agent Service as its backend.|Yes|No|
61+
|[Foundry Models ChatCompletion](./providers/microsoft-foundry.md)|An agent that uses any of the models deployed in the Foundry Service as its backend via ChatCompletion.|No|Yes|
62+
|[Foundry Models Responses](./providers/microsoft-foundry.md)|An agent that uses any of the models deployed in the Foundry Service as its backend via Responses.|Yes|Yes|
6363
|[Foundry Anthropic](./providers/anthropic.md)|An agent that uses a Claude model via the Foundry Anthropic Service as its backend.|No|Yes|
6464
|[Azure OpenAI ChatCompletion](./providers/azure-openai.md)|An agent that uses the Azure OpenAI ChatCompletion service.|No|Yes|
6565
|[Azure OpenAI Responses](./providers/azure-openai.md)|An agent that uses the Azure OpenAI Responses service.|Yes|Yes|
@@ -101,7 +101,7 @@ When using Foundry, Azure OpenAI, OpenAI services, or Anthropic services, you ha
101101
| [Azure OpenAI](/azure/ai-foundry/openai/overview) <sup>1</sup> | Azure OpenAI SDK <sup>2</sup> | [Azure.AI.OpenAI](https://www.nuget.org/packages/Azure.AI.OpenAI) | https://&lt;resource&gt;.openai.azure.com/ |
102102
| [Azure OpenAI](/azure/ai-foundry/openai/overview) <sup>1</sup> | OpenAI SDK | [OpenAI](https://www.nuget.org/packages/OpenAI) | https://&lt;resource&gt;.openai.azure.com/openai/v1/ |
103103
| OpenAI | OpenAI SDK | [OpenAI](https://www.nuget.org/packages/OpenAI) | No url required |
104-
| [Azure AI Foundry Anthropic](/azure/ai-foundry/foundry-models/how-to/use-foundry-models-claude?view=foundry-classic) | Anthropic Foundry SDK | [Anthropic.Foundry](https://www.nuget.org/packages/Anthropic.Foundry) | Resource name required |
104+
| [Azure AI Foundry Anthropic](/azure/ai-foundry/foundry-models/how-to/use-foundry-models-claude) | Anthropic Foundry SDK | [Anthropic.Foundry](https://www.nuget.org/packages/Anthropic.Foundry) | Resource name required |
105105
| Anthropic | Anthropic SDK | [Anthropic](https://www.nuget.org/packages/Anthropic) | No url or resource name required |
106106

107107
1. [Upgrading from Azure OpenAI to Foundry](/azure/ai-foundry/how-to/upgrade-azure-openai)
@@ -201,7 +201,7 @@ AIAgent agent = client.AsAIAgent(
201201

202202
Agent Framework makes it easy to create simple agents based on many different inference services.
203203
Any inference service that provides a chat client implementation can be used to build these agents.
204-
This can be done using the [`SupportsChatGetResponse`](/python/api/agent-framework-core/agent_framework.supportschatgetresponse?view=agent-framework-python-latest), which defines a standard for the methods that a client needs to support to be used with the standard [`Agent`](/python/api/agent-framework-core/agent_framework.agent?view=agent-framework-python-latest) class.
204+
This can be done using the `SupportsChatGetResponse` protocol, which defines a standard for the methods that a client needs to support to be used with the standard `Agent` class.
205205

206206
These agents support a wide range of functionality out of the box:
207207

@@ -211,7 +211,7 @@ These agents support a wide range of functionality out of the box:
211211
1. Structured output
212212
1. Streaming responses
213213

214-
To create one of these agents, simply construct an [`Agent`](/python/api/agent-framework-core/agent_framework.agent?view=agent-framework-python-latest) using the chat client implementation of your choice.
214+
To create one of these agents, simply construct an `Agent` using the chat client implementation of your choice.
215215

216216

217217
```python
@@ -239,15 +239,15 @@ agent = AzureOpenAIResponsesClient(credential=DefaultAzureCredential(), project_
239239
```
240240

241241
> [!NOTE]
242-
> This example shows using the AzureOpenAIResponsesClient, but the same pattern applies to any chat client that implements [`SupportsChatGetResponse`](/python/api/agent-framework-core/agent_framework.supportschatgetresponse?view=agent-framework-python-latest), see [providers overview](./providers/index.md) for more details on other clients.
242+
> This example shows using the AzureOpenAIResponsesClient, but the same pattern applies to any chat client that implements `SupportsChatGetResponse`, see [providers overview](./providers/index.md) for more details on other clients.
243243
244244
For detailed examples, see the agent-specific documentation sections below.
245245

246246
### Supported Chat Providers
247247

248248
|Underlying Inference Service|Description|Service Chat History storage supported|
249249
|---|---|---|
250-
|[Foundry Agent](./providers/azure-ai-foundry.md)|An agent that uses the Agent Service as its backend.|Yes|
250+
|[Foundry Agent](./providers/microsoft-foundry.md)|An agent that uses the Agent Service as its backend.|Yes|
251251
|[Azure OpenAI Chat Completion](./providers/azure-openai.md)|An agent that uses the Azure OpenAI Chat Completion service.|No|
252252
|[Azure OpenAI Responses](./providers/azure-openai.md)|An agent that uses the Azure OpenAI Responses service.|Yes|
253253
|[Azure OpenAI Assistants](./providers/azure-openai.md)|An agent that uses the Azure OpenAI Assistants service.|Yes|
@@ -258,7 +258,7 @@ For detailed examples, see the agent-specific documentation sections below.
258258
|[Amazon Bedrock](https://github.com/microsoft/agent-framework/tree/main/python/packages/bedrock)|An agent that uses Amazon Bedrock models through the Agent Framework Bedrock chat client.|No|
259259
|[GitHub Copilot](./providers/github-copilot.md)|An agent that uses the GitHub Copilot SDK backend.|No|
260260
|[Ollama (OpenAI-compatible)](./providers/ollama.md)|An agent that uses locally hosted Ollama models via OpenAI-compatible APIs.|No|
261-
|[Any other ChatClient](./providers/custom.md)|You can also use any other implementation of [`SupportsChatGetResponse`](/python/api/agent-framework-core/agent_framework.supportschatgetresponse?view=agent-framework-python-latest) to create an agent.|Varies|
261+
|[Any other ChatClient](./providers/custom.md)|You can also use any other implementation of `SupportsChatGetResponse` to create an agent.|Varies|
262262

263263
Custom chat history storage is supported whenever session-based conversation state is supported.
264264

@@ -315,7 +315,7 @@ For tools and tool patterns, see [Tools overview](./tools/index.md).
315315

316316
## Custom agents
317317

318-
For fully custom implementations (for example deterministic agents or API-backed agents), see [Custom Agents](./providers/custom.md). That page covers implementing [`SupportsAgentRun`](/python/api/agent-framework-core/agent_framework.supportsagentrun?view=agent-framework-python-latest) or extending [`BaseAgent`](/python/api/agent-framework-core/agent_framework.baseagent?view=agent-framework-python-latest), including streaming updates with [`AgentResponseUpdate`](/python/api/agent-framework-core/agent_framework.agentresponseupdate?view=agent-framework-python-latest).
318+
For fully custom implementations (for example deterministic agents or API-backed agents), see [Custom Agents](./providers/custom.md). That page covers implementing `SupportsAgentRun` or extending `BaseAgent`, including streaming updates with `AgentResponseUpdate`.
319319

320320
## Other agent types
321321

agent-framework/agents/providers/anthropic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -515,4 +515,4 @@ See the [Agent getting started tutorials](../../get-started/your-first-agent.md)
515515
## Next steps
516516

517517
> [!div class="nextstepaction"]
518-
> [Azure AI Agents](./azure-ai-foundry.md)
518+
> [Azure AI Agents](./microsoft-foundry.md)

agent-framework/agents/providers/azure-openai.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -150,27 +150,29 @@ pip install agent-framework --pre
150150

151151
Each client type uses different environment variables:
152152

153-
### Chat Completion
153+
# [Chat Completion](#tab/aoai-chat-completion)
154154

155155
```bash
156156
AZURE_OPENAI_ENDPOINT="https://<myresource>.openai.azure.com"
157157
AZURE_OPENAI_CHAT_DEPLOYMENT_NAME="gpt-4o-mini"
158158
```
159159

160-
### Responses
160+
# [Responses](#tab/aoai-responses)
161161

162162
```bash
163163
AZURE_OPENAI_ENDPOINT="https://<myresource>.openai.azure.com"
164164
AZURE_OPENAI_RESPONSES_DEPLOYMENT_NAME="gpt-4o-mini"
165165
```
166166

167-
### Assistants
167+
# [Assistants](#tab/aoai-assistants)
168168

169169
```bash
170170
AZURE_OPENAI_ENDPOINT="https://<myresource>.openai.azure.com"
171171
AZURE_OPENAI_CHAT_DEPLOYMENT_NAME="gpt-4o-mini"
172172
```
173173

174+
---
175+
174176
Optionally, you can also set:
175177

176178
```bash
@@ -180,7 +182,9 @@ AZURE_OPENAI_API_KEY="<your-api-key>" # If not using Azure CLI authentication
180182

181183
All clients use Azure credentials for authentication. The simplest approach is `AzureCliCredential` after running `az login`. All Azure clients accept a unified `credential` parameter that supports `TokenCredential`, `AsyncTokenCredential`, or a callable token provider — token caching and refresh are handled automatically.
182184

183-
## Chat Completion Client
185+
## Create Azure OpenAI Agents
186+
187+
# [Chat Completion](#tab/aoai-chat-completion)
184188

185189
`AzureOpenAIChatClient` uses the Chat Completions API — the simplest option with broad model support.
186190

@@ -202,7 +206,7 @@ asyncio.run(main())
202206

203207
**Supported tools:** Function tools, web search, local MCP tools.
204208

205-
## Responses Client
209+
# [Responses](#tab/aoai-responses)
206210

207211
`AzureOpenAIResponsesClient` uses the Responses API — the most feature-rich option with hosted tools.
208212

@@ -269,7 +273,7 @@ async def hosted_tools_example():
269273
print(result)
270274
```
271275

272-
## Assistants Client
276+
# [Assistants](#tab/aoai-assistants)
273277

274278
`AzureOpenAIAssistantsClient` uses the Assistants API — server-managed agents with built-in code interpreter and file search. Note the `async with` context manager for automatic assistant lifecycle management.
275279

@@ -291,6 +295,8 @@ asyncio.run(main())
291295

292296
**Supported tools:** Function tools, code interpreter, file search, local MCP tools.
293297

298+
---
299+
294300
## Common Features
295301

296302
All three client types support these standard agent features:

agent-framework/agents/providers/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Microsoft Agent Framework supports several types of agents to accommodate differ
1919
|----------|:---:|:---:|:---:|:---:|:---:|:---:|
2020
| [Azure OpenAI](./azure-openai.md) |||||||
2121
| [OpenAI](./openai.md) |||||||
22-
| [Microsoft Foundry](./azure-ai-foundry.md) |||||||
22+
| [Microsoft Foundry](./microsoft-foundry.md) |||||||
2323
| [Anthropic](./anthropic.md) |||||||
2424
| [Ollama](./ollama.md) |||||||
2525
| [GitHub Copilot](./github-copilot.md) |||||||
@@ -39,7 +39,7 @@ The following providers are available for .NET:
3939

4040
- **[Azure OpenAI](./azure-openai.md)** — Full-featured provider with chat completion, responses API, and tool support.
4141
- **[OpenAI](./openai.md)** — Direct OpenAI API access with chat completion and responses API.
42-
- **[Foundry](./azure-ai-foundry.md)** — Persistent server-side agents with managed chat history.
42+
- **[Foundry](./microsoft-foundry.md)** — Persistent server-side agents with managed chat history.
4343
- **[Anthropic](./anthropic.md)** — Claude models with function tools and streaming support.
4444
- **[Ollama](./ollama.md)** — Run open-source models locally.
4545
- **[GitHub Copilot](./github-copilot.md)** — GitHub Copilot SDK integration with shell and file access.
@@ -56,7 +56,7 @@ Agent Framework supports many different inference services through chat clients.
5656

5757
- **[Azure OpenAI](./azure-openai.md)** — Full-featured provider with Azure identity support.
5858
- **[OpenAI](./openai.md)** — Direct OpenAI API access.
59-
- **[Foundry](./azure-ai-foundry.md)** — Persistent server-side agents with managed chat history.
59+
- **[Foundry](./microsoft-foundry.md)** — Persistent server-side agents with managed chat history.
6060
- **[Anthropic](./anthropic.md)** — Claude models with extended thinking and hosted tools support.
6161
- **[Ollama](./ollama.md)** — Run open-source models locally.
6262
- **[GitHub Copilot](./github-copilot.md)** — GitHub Copilot SDK integration.

0 commit comments

Comments
 (0)