dotnet-microsoft-agent-framework: refresh Azure AI Foundry Models Responses Agent docs for OpenAI SDK API promotion#28
Merged
KSemenenko merged 2 commits intomainfrom Mar 17, 2026
Conversation
…onses Agent upstream doc change - GetOpenAIResponseClient → GetResponsesClient (OpenAI SDK API rename) - Remove OPENAI001 pragma warnings (no longer needed) - Add using OpenAI.Responses namespace - Update endpoint to ai-foundry- prefix format - Switch AzureCliCredential to DefaultAzureCredential with production note - Fix ResponseClient → ResponsesClient in prose - Update providers.md reference table - Bump SKILL.md version to 1.5.0 Co-authored-by: KSemenenko <4385716+KSemenenko@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update azure ai foundry models responses agent documentation
dotnet-microsoft-agent-framework: refresh Azure AI Foundry Models Responses Agent docs for OpenAI SDK API promotion
Mar 17, 2026
There was a problem hiding this comment.
Pull request overview
Refreshes the dotnet-microsoft-agent-framework skill’s mirrored documentation to reflect recent Azure AI Foundry Models “Responses agent” guidance and the OpenAI .NET SDK’s updated Responses client factory method.
Changes:
- Updated Azure AI Foundry Models Responses Agent doc to use
GetResponsesClient, removeOPENAI001pragmas, addOpenAI.Responsesimport, and refresh endpoint/auth guidance. - Updated provider matrix rows for Azure OpenAI Responses and OpenAI Responses to use
GetResponsesClient. - Bumped skill version to
1.5.0.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| skills/dotnet-microsoft-agent-framework/references/providers.md | Updates provider matrix samples to GetResponsesClient(...) for Responses-based agents. |
| skills/dotnet-microsoft-agent-framework/references/official-docs/user-guide/agents/agent-types/azure-ai-foundry-models-responses-agent.md | Refreshes mirrored Learn page snippet for Foundry Models Responses agent setup (endpoint/auth/client creation). |
| skills/dotnet-microsoft-agent-framework/SKILL.md | Increments the skill version to reflect the documentation refresh. |
You can also share your feedback on Copilot code review. Take the survey.
Comment on lines
+34
to
+36
| | Azure OpenAI Responses | `AzureOpenAIClient(...).GetResponsesClient(...).AsAIAgent(...)` | Service-backed or local, depending on mode | New OpenAI-style apps | Preview packages and mode-specific behavior | | ||
| | OpenAI Chat Completions | `OpenAIClient(...).GetChatClient(...).AsAIAgent(...)` | Local or custom store | Straightforward request/response chat | No service-backed history by default | | ||
| | OpenAI Responses | `OpenAIClient(...).GetOpenAIResponseClient(...).AsAIAgent(...)` | Service-backed or local, depending on mode | Long-running or richer response flows | Requires discipline about state mode | | ||
| | OpenAI Responses | `OpenAIClient(...).GetResponsesClient(...).AsAIAgent(...)` | Service-backed or local, depending on mode | Long-running or richer response flows | Requires discipline about state mode | |
Comment on lines
+41
to
+45
| var clientOptions = new OpenAIClientOptions() { Endpoint = new Uri("https://ai-foundry-<myresource>.services.ai.azure.com/openai/v1/") }; | ||
|
|
||
| #pragma warning disable OPENAI001 // Type is for evaluation purposes only and is subject to change or removal in future updates. | ||
| OpenAIClient client = new OpenAIClient(new BearerTokenPolicy(new AzureCliCredential(), "https://ai.azure.com/.default"), clientOptions); | ||
| #pragma warning restore OPENAI001 | ||
| // WARNING: DefaultAzureCredential is convenient for development but requires careful consideration in production. | ||
| // In production, consider using a specific credential (e.g., ManagedIdentityCredential) to avoid | ||
| // latency issues, unintended credential probing, and potential security risks from fallback mechanisms. |
Member
|
@copilot resolve conflicts |
Copilot stopped work on behalf of
KSemenenko due to an error
March 17, 2026 21:50
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The upstream Microsoft Learn page for Azure AI Foundry Models Responses Agent changed (ETag updated), reflecting the OpenAI .NET SDK promoting the Responses API out of evaluation status — renaming the client factory method and removing the
OPENAI001experimental diagnostic.Changes
references/official-docs/…/azure-ai-foundry-models-responses-agent.md(mirrored snapshot)GetOpenAIResponseClient→GetResponsesClient#pragma warning disable/restore OPENAI001blocks (no longer needed)using OpenAI.Responses;(required forResponsesClient)https://ai-foundry-<myresource>.services.ai.azure.com/openai/v1/AzureCliCredential→DefaultAzureCredentialwith inline production caveat, matching official sample guidanceResponseClient→ResponsesClientms.dateto03/17/2026references/providers.mdGetOpenAIResponseClient→GetResponsesClientfor Azure OpenAI Responses and OpenAI Responses rowsSKILL.md1.4.0→1.5.0Before / After (C#)
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
https://api.github.com/repos/MicrosoftDocs/agent-framework/git/trees/main/usr/bin/curl curl -sL REDACTED(http block)https://api.github.com/repos/microsoft/agent-framework/contents/docs/user-guide/agents/agent-types/usr/bin/curl curl -s REDACTED(http block)learn.microsoft.com/home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js(dns block)/usr/bin/curl curl -sL REDACTED(dns block)/usr/bin/curl curl -s -I REDACTED(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.