Remove Azure.AI.OpenAI dependency from templates and tests #6873

Copilot · 2025-10-01T03:41:44Z

This PR removes all direct dependencies on the Azure.AI.OpenAI SDK package from project templates and test code, replacing them with the standard OpenAI client library configured to work with Azure OpenAI endpoints.

Background

Following the approach from PR #6861, this change eliminates the Azure.AI.OpenAI package dependency while preserving all Azure OpenAI functionality by using the standard OpenAI client with Azure-compatible endpoints.

Changes

Test Projects

Integration test helpers now use OpenAIClient instead of AzureOpenAIClient
- Azure endpoints are configured by appending /openai/v1 suffix to the base URL
- Managed identity authentication converts Azure tokens to ApiKeyCredential format
- Updated files:
  - test/Libraries/Microsoft.Extensions.AI.OpenAI.Tests/IntegrationTestHelpers.cs
  - test/Libraries/Microsoft.Extensions.AI.Evaluation.Integration.Tests/Setup.cs
Package references updated:
- Removed Azure.AI.OpenAI from test project .csproj files
- Added Azure.Core where needed for Azure authentication support

Project Templates

Template source code updated to use standard OpenAI client:
- src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.Web/Program.cs
- Replaced AzureOpenAIClient instantiation with OpenAIClient configured for Azure endpoints
- Preserved both API key and managed identity authentication modes
- Updated conditional compilation directives
Template snapshots updated:
- Removed Azure.AI.OpenAI package references from snapshot test .csproj files

Technical Details

For Azure OpenAI scenarios, the implementation:

Constructs Azure-compatible endpoint by appending /openai/v1 to the base URL
Uses OpenAIClientOptions to set the custom endpoint
For managed identity: obtains Azure token and passes it as ApiKeyCredential
For API key auth: passes the key directly as ApiKeyCredential

Example of the new pattern:

var azureEndpoint = new Uri(new Uri(endpoint), "/openai/v1");
var options = new OpenAIClientOptions { Endpoint = azureEndpoint };
var client = new OpenAIClient(new ApiKeyCredential(apiKey), options);

Notes

The Aspire.Azure.AI.OpenAI package reference remains in Aspire-enabled templates, as this is a higher-level integration package that abstracts the underlying client implementation.

All affected projects build successfully with these changes.

Original prompt

Re-apply the changes from PR #6861 (Remove Azure.AI.OpenAI dependency from templates and tests) to a new pull request. The solution should remove all references and dependencies on Azure.AI.OpenAI from project templates and test code within the dotnet/extensions repository, ensuring that templates and tests no longer depend on or use Azure.AI.OpenAI. Validate that all tests pass and no residual references remain.

*This pull request was created as a result of the following prompt from Copilot chat.* > Re-apply the changes from PR #6861 (Remove Azure.AI.OpenAI dependency from templates and tests) to a new pull request. The solution should remove all references and dependencies on Azure.AI.OpenAI from project templates and test code within the dotnet/extensions repository, ensuring that templates and tests no longer depend on or use Azure.AI.OpenAI. Validate that all tests pass and no residual references remain.

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Microsoft Reviewers: Open in CodeFlow

...soft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.Web/Program.cs

jeffhandley · 2025-10-01T11:48:23Z

@stephentoub I pushed a commit that addressed a related and some unrelated issues with our use of bool symbols in the template logic. The tests for this were failing and that sent me down a rabbit hole. Those changes ended up fixing a bug in the README where we were failing to include a block of text when we should have for Azure prereqs.

Everything should be passing now, and I cherry-picked the commit from #6874 into here too. That might result in a merge conflict, but I can help resolve if so.

Please review the actual changes you were aiming to have in this PR though to ensure those still land the way you expected.

stephentoub · 2025-10-01T19:55:09Z

@trrwilson, does this replacement for Azure.AI.OpenAI look like what you'd expect? e.g. https://github.com/dotnet/extensions/pull/6873/files#diff-07c36055059da3158abf7c72aabe24f5e5a634a6dcb05700b3654f3ce6d5c306R28

Copilot

Pull Request Overview

This PR removes all direct dependencies on the Azure.AI.OpenAI package from project templates and test code, replacing them with the standard OpenAI client library configured to work with Azure OpenAI endpoints. This aligns with the approach from a previous effort to consolidate on the standard OpenAI client.

Key changes include:

Updating integration test helpers to use OpenAIClient instead of AzureOpenAIClient
Removing Azure.AI.OpenAI package references from project files and replacing with Azure.Core where needed
Updating project template code to use the standard OpenAI client with Azure-compatible endpoints

Reviewed Changes

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

Show a summary per file

File	Description
test/Libraries/Microsoft.Extensions.AI.OpenAI.Tests/IntegrationTestHelpers.cs	Updated to use OpenAIClient with Azure endpoint configuration and Bearer token authentication
test/Libraries/Microsoft.Extensions.AI.Evaluation.Integration.Tests/Setup.cs	Migrated from AzureOpenAIClient to OpenAIClient with Azure endpoint support
Multiple .csproj files	Removed Azure.AI.OpenAI package references and added Azure.Core where needed
src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.Web/Program.cs	Updated template code to use OpenAIClient with Azure endpoint configuration
Multiple template files	Updated conditional compilation directives from "Use" to "Is" pattern

test/Libraries/Microsoft.Extensions.AI.OpenAI.Tests/IntegrationTestHelpers.cs

test/Libraries/Microsoft.Extensions.AI.Evaluation.Integration.Tests/Setup.cs

...soft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.Web/Program.cs

stephentoub · 2025-10-03T13:25:30Z

@jeffhandley, would you mind taking a look at the CI failures in the template tests? (CreateRestoreAndBuild_BasicTemplate)

Co-authored-by: stephentoub <2642209+stephentoub@users.noreply.github.com>

… in Program.cs.

shyamnamboodiripad · 2025-10-05T23:19:30Z

test/Libraries/Microsoft.Extensions.AI.Evaluation.Integration.Tests/Setup.cs

-        var endpoint = new Uri(Settings.Current.Endpoint);
-        AzureOpenAIClientOptions options = new();
-        var credential = new ChainedTokenCredential(new AzureCliCredential(), new DefaultAzureCredential());
+        // Use Azure endpoint with /openai/v1 suffix


If this is documented on MS learn somewhere, could you please include a link in this comment?

Also wondering whether we should demostrate the same in the eval samples (in the dotnet/ai-samples repo). Out of curiosity, what is the motivation for removing the Azure.OpenAI reference?

eiriktsarpalis · 2025-10-06T11:51:41Z

....Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.AppHost/AppHost.cs

    modelVersion: "1");
 #endif
-#if (UseAzureAISearch)
+#if (IsAzureAISearch)


Why the parens?

Ah, is this some kind of metavariable that gets substituted during template expansion?

Copilot AI assigned Copilot and stephentoub Oct 1, 2025

Copilot started work on behalf of stephentoub October 1, 2025 03:41 View session

Copilot AI changed the title ~~[WIP] Remove Azure.AI.OpenAI dependency from templates and tests (re-apply solution from PR #6861)~~ Remove Azure.AI.OpenAI dependency from templates and tests Oct 1, 2025

Copilot AI requested a review from stephentoub October 1, 2025 04:12

Copilot finished work on behalf of stephentoub October 1, 2025 04:12

jeffhandley mentioned this pull request Oct 1, 2025

Fix mcpserver test baselines #6874

Merged

jeffhandley reviewed Oct 1, 2025

View reviewed changes

...soft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.Web/Program.cs Outdated Show resolved Hide resolved

...soft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.Web/Program.cs Outdated Show resolved Hide resolved

stephentoub force-pushed the copilot/fix-b3488ec2-c062-4235-b182-df700865df87 branch from 6ec55f7 to ebd5d3f Compare October 1, 2025 19:54

stephentoub marked this pull request as ready for review October 1, 2025 19:54

stephentoub requested review from a team as code owners October 1, 2025 19:54

Copilot AI review requested due to automatic review settings October 1, 2025 19:54

stephentoub requested a review from a team as a code owner October 1, 2025 19:54

Copilot AI reviewed Oct 1, 2025

View reviewed changes

Copilot AI and others added 8 commits October 3, 2025 20:56

Initial plan

a052e9f

Remove Azure.AI.OpenAI package references from test projects

5bd6d4d

Co-authored-by: stephentoub <2642209+stephentoub@users.noreply.github.com>

Fix Azure authentication to use OpenAI client with token credentials

07694e8

Co-authored-by: stephentoub <2642209+stephentoub@users.noreply.github.com>

Update template source to use OpenAI client for Azure OpenAI

954afe4

Co-authored-by: stephentoub <2642209+stephentoub@users.noreply.github.com>

Remove remaining package references to Azure.AI.OpenAI

b743590

Use computed symbols for all bool checks in the template. Sort usings…

1fc85eb

… in Program.cs.

Update to use BearerTokenPolicy

b8f6134

Change scope

4b0880d

stephentoub force-pushed the copilot/fix-b3488ec2-c062-4235-b182-df700865df87 branch from ebd5d3f to 4b0880d Compare October 4, 2025 00:58

shyamnamboodiripad reviewed Oct 5, 2025

View reviewed changes

shyamnamboodiripad approved these changes Oct 5, 2025

View reviewed changes

eiriktsarpalis reviewed Oct 6, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Remove Azure.AI.OpenAI dependency from templates and tests #6873

Remove Azure.AI.OpenAI dependency from templates and tests #6873

Uh oh!

Copilot AI commented Oct 1, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

jeffhandley commented Oct 1, 2025

Uh oh!

stephentoub commented Oct 1, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stephentoub commented Oct 3, 2025

Uh oh!

shyamnamboodiripad Oct 5, 2025

Uh oh!

eiriktsarpalis Oct 6, 2025

Uh oh!

eiriktsarpalis Oct 6, 2025

Uh oh!

Uh oh!

Remove Azure.AI.OpenAI dependency from templates and tests #6873

Are you sure you want to change the base?

Remove Azure.AI.OpenAI dependency from templates and tests #6873

Uh oh!

Conversation

Copilot AI commented Oct 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Background

Changes

Test Projects

Project Templates

Technical Details

Notes

Microsoft Reviewers: Open in CodeFlow

Uh oh!

Uh oh!

Uh oh!

jeffhandley commented Oct 1, 2025

Uh oh!

stephentoub commented Oct 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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!

stephentoub commented Oct 3, 2025

Uh oh!

shyamnamboodiripad Oct 5, 2025

Choose a reason for hiding this comment

Uh oh!

eiriktsarpalis Oct 6, 2025

Choose a reason for hiding this comment

Uh oh!

eiriktsarpalis Oct 6, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI commented Oct 1, 2025 •

edited

Loading

stephentoub commented Oct 1, 2025 •

edited

Loading