Add some OpenAI and Foundry extension methods #225

markwallace-microsoft · 2025-07-23T13:15:37Z

Motivation and Context

Proposed extension methods to make it easier to create an AIAgent instance from an OpenAIClient or PersistentAgentsClient.

Description

Contribution Checklist

The code builds clean without any errors or warnings
The PR follows the Contribution Guidelines
All unit tests pass, and I have added new tests where possible
I didn't break anyone 😄

Copilot

Pull Request Overview

This PR adds extension methods to simplify creating AI agents from OpenAI clients and Azure AI Foundry persistent agents, improving developer experience by providing convenient factory methods.

Adds OpenAI client extension methods for creating AI agents with both Chat Completion and Response APIs
Refactors Azure AI persistent agent methods with better naming and consolidated creation workflow
Updates sample code to demonstrate the new extension methods and agent patterns

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
PersistentAgentsClientExtensions.cs	Renames GetRunnableAgentAsync to GetAIAgentAsync and adds CreateAIAgentAsync method
ChatClientAgent_With_OpenAIClient.cs	New sample demonstrating OpenAI client extension methods with multiple API patterns
ChatClientAgent_With_OpenAIChatCompletion.cs	Removed file - functionality moved to new OpenAI client sample
ChatClientAgent_With_AzureOpenAIChatCompletion.cs	Updates variable type declaration for consistency
ChatClientAgent_With_AzureAIAgentsPersistent.cs	Refactored to use new CreateAIAgentAsync method and simplified workflow
OpenAIClientExtensions.cs	New extension methods for creating AI agents from OpenAI clients and chat clients
OpenAIAgentExtensions.cs	Internal extensions for OpenAI message conversion and agent interaction
AgentRunResponseExtensions.cs	Extensions to extract native OpenAI response objects from agent responses

Comments suppressed due to low confidence (1)

dotnet/src/Microsoft.Extensions.AI.Agents.AzureAI/PersistentAgentsClientExtensions.cs:84

The 'description' parameter is not being passed to the CreateAgentAsync method call. This will cause the description to be ignored when creating the agent.

            instructions,

dotnet/samples/GettingStarted/External/MEAI.OpenAI/AgentRunResponseExtensions.cs

dotnet/samples/GettingStarted/External/MEAI.OpenAI/OpenAIAgentExtensions.cs

dotnet/samples/GettingStarted/External/MEAI.OpenAI/AgentRunResponseExtensions.cs

dotnet/samples/GettingStarted/External/MEAI.OpenAI/OpenAIAgentExtensions.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…com/markwallace-microsoft/agent-framework into users/markwallace/openai_extensions

dotnet/src/Microsoft.Extensions.AI.Agents.OpenAI/OpenAIChatClientAgent.cs

dotnet/src/Microsoft.Extensions.AI.Agents.OpenAI/AIAgentWithOpenAIExtensions.cs

dotnet/src/Microsoft.Extensions.AI.Agents.OpenAI/AgentRunResponseExtensions.cs

dotnet/src/Microsoft.Extensions.AI.Agents.OpenAI/OpenAIAssistantClientExtensions.cs

* Add some OpenAI specific extensions * Update samples and extension methods * Apply suggestion from @Copilot Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Apply suggestion from @Copilot Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Add extension methods for creating agents using the Assistant API * Add orchestration sample * Add orchestration sample * Sample for the Foundry alignment document * Address code review feedback * Rename provider samples * Sample showing how to get an AI agent for Foundry SDK * Add OpenAI chat completion based implementation of AIAgent * Split OpenAI client extension methods by client type * Remove OpenAIClient extension methods * Rename AsRunnableAgent * Fix XML comments --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

markwallace-microsoft added 2 commits July 23, 2025 10:44

Add some OpenAI specific extensions

e360297

Update samples and extension methods

48ad3cf

Copilot AI review requested due to automatic review settings July 23, 2025 13:15

markwallace-microsoft temporarily deployed to integration July 23, 2025 13:15 — with GitHub Actions Inactive

eavanvalkenburg added the .NET label Jul 23, 2025

Copilot AI reviewed Jul 23, 2025

View reviewed changes

markwallace-microsoft marked this pull request as draft July 23, 2025 13:50

stephentoub reviewed Jul 23, 2025

View reviewed changes

dotnet/samples/GettingStarted/External/MEAI.OpenAI/AgentRunResponseExtensions.cs Outdated Show resolved Hide resolved

stephentoub reviewed Jul 23, 2025

View reviewed changes

dotnet/samples/GettingStarted/External/MEAI.OpenAI/OpenAIAgentExtensions.cs Outdated Show resolved Hide resolved

crickman added this to Agent Framework Jul 24, 2025

Apply suggestion from @Copilot

f798ca4

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

markwallace-microsoft had a problem deploying to integration July 24, 2025 16:43 — with GitHub Actions Error

Apply suggestion from @Copilot

c781aca

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

markwallace-microsoft had a problem deploying to integration July 24, 2025 16:44 — with GitHub Actions Error

Merge branch 'main' into users/markwallace/openai_extensions

ea4f59c

markwallace-microsoft temporarily deployed to integration July 24, 2025 16:47 — with GitHub Actions Inactive

Add extension methods for creating agents using the Assistant API

4b7858a

markwallace-microsoft temporarily deployed to integration July 28, 2025 12:59 — with GitHub Actions Inactive

Add orchestration sample

c42226c

markwallace-microsoft had a problem deploying to integration July 28, 2025 13:19 — with GitHub Actions Error

markwallace-microsoft added 3 commits July 28, 2025 14:21

Add orchestration sample

2269b1a

Merge branch 'main' into users/markwallace/openai_extensions

7a08b19

Merge branch 'users/markwallace/openai_extensions' of https://github.…

4ff3894

…com/markwallace-microsoft/agent-framework into users/markwallace/openai_extensions

markwallace-microsoft temporarily deployed to integration July 28, 2025 13:22 — with GitHub Actions Inactive

markwallace-microsoft temporarily deployed to integration July 31, 2025 10:57 — with GitHub Actions Inactive

Split OpenAI client extension methods by client type

6fbc11e

stephentoub reviewed Jul 31, 2025

View reviewed changes

Remove OpenAIClient extension methods

8008699

markwallace-microsoft temporarily deployed to integration July 31, 2025 13:57 — with GitHub Actions Inactive

markwallace-microsoft temporarily deployed to integration July 31, 2025 14:27 — with GitHub Actions Inactive

Rename AsRunnableAgent

786b5e3

markwallace-microsoft force-pushed the users/markwallace/openai_extensions branch from e7cdb7f to 786b5e3 Compare July 31, 2025 15:46

markwallace-microsoft temporarily deployed to integration July 31, 2025 15:46 — with GitHub Actions Inactive

Merge branch 'main' into users/markwallace/openai_extensions

b20f2a2

markwallace-microsoft temporarily deployed to integration July 31, 2025 15:54 — with GitHub Actions Inactive

westey-m reviewed Jul 31, 2025

View reviewed changes

dotnet/src/Microsoft.Extensions.AI.Agents.OpenAI/OpenAIAssistantClientExtensions.cs Outdated Show resolved Hide resolved

westey-m reviewed Jul 31, 2025

View reviewed changes

dotnet/src/Microsoft.Extensions.AI.Agents.OpenAI/OpenAIAssistantClientExtensions.cs Outdated Show resolved Hide resolved

westey-m reviewed Jul 31, 2025

View reviewed changes

dotnet/src/Microsoft.Extensions.AI.Agents.OpenAI/OpenAIAssistantClientExtensions.cs Outdated Show resolved Hide resolved

westey-m reviewed Jul 31, 2025

View reviewed changes

dotnet/src/Microsoft.Extensions.AI.Agents.OpenAI/OpenAIAssistantClientExtensions.cs Outdated Show resolved Hide resolved

westey-m approved these changes Jul 31, 2025

View reviewed changes

rogerbarreto approved these changes Jul 31, 2025

View reviewed changes

Fix XML comments

4361c64

markwallace-microsoft temporarily deployed to integration July 31, 2025 17:57 — with GitHub Actions Inactive

markwallace-microsoft added this pull request to the merge queue Jul 31, 2025

Merged via the queue into microsoft:main with commit 624709e Jul 31, 2025
14 checks passed

github-project-automation bot moved this to Done in Agent Framework Jul 31, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add some OpenAI and Foundry extension methods #225

Add some OpenAI and Foundry extension methods #225

Uh oh!

markwallace-microsoft commented Jul 23, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Add some OpenAI and Foundry extension methods #225

Add some OpenAI and Foundry extension methods #225

Uh oh!

Conversation

markwallace-microsoft commented Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation and Context

Description

Contribution Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

markwallace-microsoft commented Jul 23, 2025 •

edited

Loading