OpenAI library updates (#50548)

alexwolfmsft · web-flow · commit 15c0a2cf0d85 · 2025-12-12T12:05:05.000-05:00
* Updated to OpenAI libraries
diff --git a/docs/azure/sdk/dependency-injection.md b/docs/azure/sdk/dependency-injection.md
@@ -26,13 +26,13 @@ To register and configure service clients from an [`Azure.`-prefixed package](pa
     dotnet add package Azure.Identity
     ```
 
-For demonstration purposes, the sample code in this article uses the Key Vault Secrets, Blob Storage, Service Bus, and Azure OpenAI libraries. Install the following packages to follow along:
+For demonstration purposes, the sample code in this article uses the Key Vault Secrets, Blob Storage, Service Bus, and OpenAI libraries. Install the following packages to follow along:
 
 ```dotnetcli
 dotnet add package Azure.Security.KeyVault.Secrets
 dotnet add package Azure.Storage.Blobs
 dotnet add package Azure.Messaging.ServiceBus
-dotnet add package Azure.AI.OpenAI
+dotnet add package OpenAI
 ```
 
 ## Register clients and subclients
@@ -43,15 +43,15 @@ In the *Program.cs* file, invoke the <xref:Microsoft.Extensions.Azure.AzureClien
 
 ### [WebApplicationBuilder](#tab/web-app-builder)
 
-:::code language="csharp" source="snippets/dependency-injection/WebApplicationBuilder/Program.cs" id="snippet_WebApplicationBuilder" highlight="9-39":::
+:::code language="csharp" source="snippets/dependency-injection/WebApplicationBuilder/Program.cs" id="snippet_WebApplicationBuilder" highlight="11-48":::
 
 ### [HostApplicationBuilder](#tab/host-app-builder)
 
-:::code language="csharp" source="snippets/dependency-injection/HostApplicationBuilder/Program.cs" highlight="11-40":::
+:::code language="csharp" source="snippets/dependency-injection/HostApplicationBuilder/Program.cs" highlight="13-50":::
 
 ### [HostBuilder](#tab/host-builder)
 
-:::code language="csharp" source="snippets/dependency-injection/HostBuilder/Program.cs" id="snippet_HostBuilder" highlight="10-39":::
+:::code language="csharp" source="snippets/dependency-injection/HostBuilder/Program.cs" id="snippet_HostBuilder" highlight="12-49":::
 
 ---
 
@@ -60,7 +60,7 @@ In the preceding code:
 * Key Vault Secrets, Blob Storage, and Service Bus clients are registered using the <xref:Microsoft.Extensions.Azure.SecretClientBuilderExtensions.AddSecretClient%2A>, <xref:Microsoft.Extensions.Azure.BlobClientBuilderExtensions.AddBlobServiceClient%2A> and <xref:Microsoft.Extensions.Azure.ServiceBusClientBuilderExtensions.AddServiceBusClientWithNamespace%2A>, respectively. The `Uri`- and `string`-typed arguments are passed. To avoid specifying these URLs explicitly, see the [Store configuration separately from code](#store-configuration-separately-from-code) section.
 * Each registered client automatically uses <xref:Azure.Identity.DefaultAzureCredential> for `TokenCredential` unless you configure a different type of credential (for example, using `WithCredential`).
 * Service Bus subclients are registered for each queue on the service using the subclient and corresponding options types. The queue names for the subclients are retrieved using a separate method outside of the service registration because the `GetQueuesAsync` method must be run asynchronously.
-* An Azure OpenAI client is registered using a custom client factory via the <xref:Microsoft.Extensions.Azure.AzureClientFactoryBuilder.AddClient%2A> method, which provides control over how a client instance is created. Custom client factories are useful in the following cases:
+* A `ResponsesClient` is registered using a custom client factory via the <xref:Microsoft.Extensions.Azure.AzureClientFactoryBuilder.AddClient%2A> method, which provides control over how a client instance is created. Custom client factories are useful in the following cases:
   * You need to use other dependencies during the client construction.
   * A registration extension method doesn't exist for the service client you want to register.
 
diff --git a/docs/azure/sdk/snippets/authentication/Directory.Packages.props b/docs/azure/sdk/snippets/authentication/Directory.Packages.props
@@ -4,7 +4,7 @@
   </PropertyGroup>
   <ItemGroup>
     <!-- Azure SDK packages -->
-    <PackageVersion Include="Azure.AI.OpenAI" Version="2.1.0" />
+    <PackageVersion Include="OpenAI" Version="2.8.0" />
     <PackageVersion Include="Microsoft.Extensions.AI" Version="9.3.0-preview.1.25114.11" />
     <PackageVersion Include="Microsoft.Extensions.AI.OpenAI" Version="9.3.0-preview.1.25114.11" />
     <PackageVersion Include="Microsoft.Extensions.Azure" Version="1.13.1" />
diff --git a/docs/azure/sdk/snippets/dependency-injection/Directory.Packages.props b/docs/azure/sdk/snippets/dependency-injection/Directory.Packages.props
@@ -3,7 +3,6 @@
     <ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
   </PropertyGroup>
   <ItemGroup>
-    <PackageVersion Include="Azure.Identity" Version="1.17.1" />
     <PackageVersion Include="Microsoft.Identity.Client" Version="4.67.2" />
     <PackageVersion Include="Azure.Security.KeyVault.Secrets" Version="4.6.0" />
     <PackageVersion Include="Azure.Messaging.ServiceBus" Version="7.17.5" />
@@ -12,6 +11,7 @@
     <PackageVersion Include="Microsoft.AspNetCore.OpenApi" Version="8.0.8" />
     <PackageVersion Include="Microsoft.Extensions.Hosting" Version="10.0.0" />
     <PackageVersion Include="Swashbuckle.AspNetCore" Version="6.7.3" />
-    <PackageVersion Include="Azure.AI.OpenAI" Version="2.1.0" />
+    <PackageVersion Include="Azure.Identity" Version="1.17.1" />
+    <PackageVersion Include="OpenAI" Version="2.8.0" />
   </ItemGroup>
 </Project>
diff --git a/docs/azure/sdk/snippets/dependency-injection/HostApplicationBuilder/HostApplicationBuilder.csproj b/docs/azure/sdk/snippets/dependency-injection/HostApplicationBuilder/HostApplicationBuilder.csproj
@@ -14,6 +14,6 @@
     <PackageReference Include="Azure.Storage.Blobs" />
     <PackageReference Include="Microsoft.Extensions.Azure" />
     <PackageReference Include="Microsoft.Extensions.Hosting" />
-    <PackageReference Include="Azure.AI.OpenAI" />
+    <PackageReference Include="OpenAI" />
   </ItemGroup>
 </Project>
diff --git a/docs/azure/sdk/snippets/dependency-injection/HostApplicationBuilder/Program.cs b/docs/azure/sdk/snippets/dependency-injection/HostApplicationBuilder/Program.cs
@@ -3,7 +3,9 @@
 using Azure.Messaging.ServiceBus.Administration;
 using Microsoft.Extensions.Azure;
 using Microsoft.Extensions.Hosting;
-using Azure.AI.OpenAI;
+using OpenAI;
+using OpenAI.Responses;
+using System.ClientModel.Primitives;
 
 IHost host = Host.CreateDefaultBuilder(args)
     .ConfigureServices(services =>
@@ -33,10 +35,18 @@
                     }).WithName(queueName);
             }
 
+            var endpoint = Environment.GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT")
+                ?? throw new InvalidOperationException("AZURE_OPENAI_ENDPOINT is required.");
+
             // Register a custom client factory
-            clientBuilder.AddClient<AzureOpenAIClient, AzureOpenAIClientOptions>(
-                (options, credential, _) => new AzureOpenAIClient(
-                    new Uri("<url_here>"), credential, options));
+            #pragma warning disable OPENAI001 // Type is for evaluation purposes and is subject to change in future updates.
+            clientBuilder.AddClient<ResponsesClient, OpenAIClientOptions>(
+                (options, credential, _) => new ResponsesClient(
+                    "<deployment_name>",
+                    new BearerTokenPolicy(credential, "https://ai.azure.com/.default"),
+                    new OpenAIClientOptions { Endpoint = new Uri($"{endpoint}/openai/v1/") }
+                ));
+            #pragma warning restore OPENAI001
         });
     }).Build();
 
diff --git a/docs/azure/sdk/snippets/dependency-injection/HostBuilder/HostBuilder.csproj b/docs/azure/sdk/snippets/dependency-injection/HostBuilder/HostBuilder.csproj
@@ -8,12 +8,12 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Azure.Identity" />
     <PackageReference Include="Azure.Messaging.ServiceBus" />
     <PackageReference Include="Azure.Security.KeyVault.Secrets" />
     <PackageReference Include="Azure.Storage.Blobs" />
     <PackageReference Include="Microsoft.Extensions.Azure" />
     <PackageReference Include="Microsoft.Extensions.Hosting" />
-    <PackageReference Include="Azure.AI.OpenAI" />
+    <PackageReference Include="Azure.Identity" />
+    <PackageReference Include="OpenAI" />
   </ItemGroup>
 </Project>
diff --git a/docs/azure/sdk/snippets/dependency-injection/HostBuilder/Program.cs b/docs/azure/sdk/snippets/dependency-injection/HostBuilder/Program.cs
@@ -3,7 +3,9 @@
 using Azure.Messaging.ServiceBus;
 using Azure.Messaging.ServiceBus.Administration;
 using Microsoft.Extensions.Azure;
-using Azure.AI.OpenAI;
+using OpenAI;
+using OpenAI.Responses;
+using System.ClientModel.Primitives;
 
 IHost host = Host.CreateDefaultBuilder(args)
     .ConfigureServices(services =>
@@ -33,10 +35,18 @@
                     }).WithName(queueName);
             }
 
+            var endpoint = Environment.GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT")
+                ?? throw new InvalidOperationException("AZURE_OPENAI_ENDPOINT is required.");
+
             // Register a custom client factory
-            clientBuilder.AddClient<AzureOpenAIClient, AzureOpenAIClientOptions>(
-                (options, credential, _) => new AzureOpenAIClient(
-                    new Uri("<url_here>"), credential, options));
+            #pragma warning disable OPENAI001 // Type is for evaluation purposes and is subject to change in future updates.
+            clientBuilder.AddClient<ResponsesClient, OpenAIClientOptions>(
+                (options, credential, _) => new ResponsesClient(
+                    "<deployment_name>",
+                    new BearerTokenPolicy(credential, "https://ai.azure.com/.default"),
+                    new OpenAIClientOptions { Endpoint = new Uri($"{endpoint}/openai/v1/") }
+                ));
+            #pragma warning restore OPENAI001
         });
     }).Build();
 
diff --git a/docs/azure/sdk/snippets/dependency-injection/WebApplicationBuilder/Program.cs b/docs/azure/sdk/snippets/dependency-injection/WebApplicationBuilder/Program.cs
@@ -3,7 +3,9 @@
 using Azure.Messaging.ServiceBus;
 using Azure.Messaging.ServiceBus.Administration;
 using Microsoft.Extensions.Azure;
-using Azure.AI.OpenAI;
+using OpenAI;
+using OpenAI.Responses;
+using System.ClientModel.Primitives;
 
 WebApplicationBuilder builder = WebApplication.CreateBuilder(args);
 
@@ -32,10 +34,18 @@
             }).WithName(queueName);
     }
 
+    var endpoint = Environment.GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT")
+        ?? throw new InvalidOperationException("AZURE_OPENAI_ENDPOINT is required.");
+
     // Register a custom client factory
-    clientBuilder.AddClient<AzureOpenAIClient, AzureOpenAIClientOptions>(
-        (options, credential, _) => new AzureOpenAIClient(
-            new Uri("<url_here>"), credential, options));
+    #pragma warning disable OPENAI001 // Type is for evaluation purposes and is subject to change in future updates.
+    clientBuilder.AddClient<ResponsesClient, OpenAIClientOptions>(
+        (options, credential, _) => new ResponsesClient(
+            "<deployment_name>",
+            new BearerTokenPolicy(credential, "https://ai.azure.com/.default"),
+            new OpenAIClientOptions { Endpoint = new Uri($"{endpoint}/openai/v1/") }
+        ));
+    #pragma warning restore OPENAI001
 });
 
 WebApplication app = builder.Build();
diff --git a/docs/azure/sdk/snippets/dependency-injection/WebApplicationBuilder/WebApplicationBuilder.csproj b/docs/azure/sdk/snippets/dependency-injection/WebApplicationBuilder/WebApplicationBuilder.csproj
@@ -7,14 +7,14 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Azure.Identity" />
     <PackageReference Include="Azure.Security.KeyVault.Secrets" />
     <PackageReference Include="Azure.Storage.Blobs" />
     <PackageReference Include="Azure.Messaging.ServiceBus" />
     <PackageReference Include="Microsoft.Extensions.Azure" />
     <PackageReference Include="Microsoft.AspNetCore.OpenApi" />
     <PackageReference Include="Swashbuckle.AspNetCore" />
-    <PackageReference Include="Azure.AI.OpenAI" />
+    <PackageReference Include="Azure.Identity" />
+    <PackageReference Include="OpenAI" />
   </ItemGroup>
 
 </Project>
