Skip to content

Commit 720b5f3

Browse files
moonbox3eavanvalkenburgwestey-mMAF Dashboard Bot
authored
Clarify endpoint requirements for Azure AI Foundry and Azure OpenAI providers (#927)
* Clarify endpoint requirements for Azure AI Foundry and Azure OpenAI providers Source issue: microsoft/agent-framework#3361 * Address review feedback for #927: review comment fixes * Address review feedback for #927: review comment fixes --------- Co-authored-by: Eduard van Valkenburg <eavanvalkenburg@users.noreply.github.com> Co-authored-by: westey <164392973+westey-m@users.noreply.github.com> Co-authored-by: MAF Dashboard Bot <maf-dashboard-bot@users.noreply.github.com>
1 parent 8e357c7 commit 720b5f3

2 files changed

Lines changed: 7 additions & 1 deletion

File tree

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,9 @@ pip install agent-framework --pre
148148

149149
## Configuration
150150

151+
> [!IMPORTANT]
152+
> The `AzureOpenAIChatClient` and `AzureOpenAIAssistantsClient` require an **Azure OpenAI resource** endpoint (format: `https://<myresource>.openai.azure.com`). The `AzureOpenAIResponsesClient` can use either an Azure OpenAI resource endpoint **or** a [Microsoft Foundry project](/azure/ai-foundry/what-is-ai-foundry) endpoint (format: `https://<your-project>.services.ai.azure.com/api/projects/<project-id>`). If you need to use the Foundry Agent Service instead, see the [Foundry Agents provider page](./azure-ai-foundry.md).
153+
151154
Each client type uses different environment variables:
152155

153156
# [Chat Completion](#tab/aoai-chat-completion)
@@ -228,7 +231,7 @@ asyncio.run(main())
228231

229232
### Responses Client with Microsoft Foundry project endpoint
230233

231-
`AzureOpenAIResponsesClient` can also be created from a Foundry project endpoint:
234+
Instead of an Azure OpenAI resource endpoint, `AzureOpenAIResponsesClient` can also be created from a [Microsoft Foundry project](/azure/ai-foundry/what-is-ai-foundry) endpoint. Use a Foundry project endpoint when you want to access models deployed through a Microsoft Foundry project rather than a standalone Azure OpenAI resource:
232235

233236
```python
234237
from agent_framework.azure import AzureOpenAIResponsesClient

agent-framework/agents/providers/microsoft-foundry.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,9 @@ For more information on how to run and interact with agents, see the [Agent gett
9898

9999
### Environment Variables
100100

101+
> [!IMPORTANT]
102+
> `AzureAIAgentClient` (Foundry Agent Service v1) and `AzureAIClient` (Foundry Agent Service v2) both require an **Azure AI Foundry project** endpoint (format: `https://<your-project>.services.ai.azure.com/api/projects/<project-id>`), **not** an Azure OpenAI resource endpoint. You must have an [Azure AI Foundry project](/azure/ai-foundry/what-is-ai-foundry) to use this provider. If you have a standalone Azure OpenAI resource instead, see the [Azure OpenAI provider page](./azure-openai.md).
103+
101104
Before using Foundry Agents, you need to set up these environment variables:
102105

103106
```bash

0 commit comments

Comments
 (0)