Azure OpenAI: 2.2.0-beta.2 (Azure#48347)

* reflect latest from development location

* include eng folder for package.data.props pinning

Author: trrwilson

eng/Packages.Data.props

@@ -190,7 +190,7 @@
   </ItemGroup>
 
   <ItemGroup Condition="$(MSBuildProjectName.StartsWith('Azure.AI.OpenAI'))">
-    <PackageReference Update="OpenAI" Version="2.2.0-beta.1" />
+    <PackageReference Update="OpenAI" Version="2.2.0-beta.2" />
   </ItemGroup>
 
   <ItemGroup Condition="$(MSBuildProjectName.StartsWith('Azure.Developer.MicrosoftPlaywrightTesting'))">

sdk/openai/Azure.AI.OpenAI/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History
 
+## 2.2.0-beta.2 (2025-02-18)
+
+### Bugs fixed
+
+- Addressed a problem calling the `SetNewMaxCompletionTokensPropertyEnabled()` method, needed for o1/o3 model support, on `ChatCompletionOptions` instances prior to use in a method call. Related issue: [azure-sdk-for-net#46545](https://github.com/Azure/azure-sdk-for-net/issues/46545) with thanks to the PR  [azure-sdk-for-net#48218](https://github.com/Azure/azure-sdk-for-net/pull/48218).
+
 ## 2.2.0-beta.1 (2025-02-07)
 
 This preview release aligns with the corresponding `2.2.0` beta of `OpenAI` and the `2025-01-01-Preview` Azure OpenAI Service API version.

sdk/openai/Azure.AI.OpenAI/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "net",
   "TagPrefix": "net/openai/Azure.AI.OpenAI",
-  "Tag": "net/openai/Azure.AI.OpenAI_9db5b129ea"
+  "Tag": "net/openai/Azure.AI.OpenAI_0f09bc4c00"
 }

sdk/openai/Azure.AI.OpenAI/src/Azure.AI.OpenAI.csproj

@@ -34,7 +34,7 @@
     <Otherwise>
       <PropertyGroup>
         <VersionPrefix>2.2.0</VersionPrefix>
-        <VersionSuffix>beta.1</VersionSuffix>
+        <VersionSuffix>beta.2</VersionSuffix>
       </PropertyGroup>
     </Otherwise>
   </Choose>

sdk/openai/Azure.AI.OpenAI/src/Custom/Chat/AzureChatClient.cs

@@ -94,7 +94,8 @@ private static void PostfixClearStreamOptions(IEnumerable<ChatMessage> messages,
                 == true)
         {
             options ??= new();
-            options.StreamOptions = null;
+            options.SerializedAdditionalRawData ??= new Dictionary<string, BinaryData>();
+            AdditionalPropertyHelpers.SetEmptySentinelValue(options.SerializedAdditionalRawData, "stream_options");
         }
     }
 

sdk/openai/Azure.AI.OpenAI/src/Custom/Chat/AzureChatExtensions.cs

@@ -42,6 +42,7 @@ public static void SetNewMaxCompletionTokensPropertyEnabled(this ChatCompletionO
         if (newPropertyEnabled)
         {
             // Blocking serialization of max_tokens via dictionary acts as a signal to skip pre-serialization fixup
+            options.SerializedAdditionalRawData ??= new Dictionary<string, BinaryData>();
             AdditionalPropertyHelpers.SetEmptySentinelValue(options.SerializedAdditionalRawData, "max_tokens");
         }
         else

sdk/openai/Azure.AI.OpenAI/tests/Assets/playback_test_config.json

@@ -39,6 +39,11 @@
     "key": "Sanitized",
     "deployment": "o1"
   },
+  "chat_o3-mini": {
+    "endpoint": "https://Sanitized.openai.azure.com/",
+    "key": "Sanitized",
+    "deployment": "o3-mini"
+  },
   "chat_with_async_filter": {
     "endpoint": "https://Sanitized.openai.azure.com/",
     "key": "Sanitized",

sdk/openai/Azure.AI.OpenAI/tests/ChatTests.Audio.cs

@@ -79,11 +79,17 @@ public async Task ChatAudioWorks()
         DateTimeOffset? streamedExpiresAt = null;
         StringBuilder streamedTranscriptBuilder = new();
         using MemoryStream outputAudioStream = new();
+        ChatTokenUsage? streamedUsage = null;
         await foreach (StreamingChatCompletionUpdate update in client.CompleteChatStreamingAsync(messages, options))
         {
             Assert.That(update.ContentUpdate, Has.Count.EqualTo(0));
             StreamingChatOutputAudioUpdate outputAudioUpdate = update.OutputAudioUpdate;
 
+            if (update.Usage is not null)
+            {
+                Assert.That(streamedUsage, Is.Null);
+                streamedUsage = update.Usage;
+            }
             if (outputAudioUpdate is not null)
             {
                 string serializedOutputAudioUpdate = ModelReaderWriter.Write(outputAudioUpdate).ToString();
@@ -108,5 +114,7 @@ public async Task ChatAudioWorks()
         Assert.That(streamedExpiresAt.HasValue, Is.True);
         Assert.That(streamedTranscriptBuilder.ToString(), Is.Not.Null.And.Not.Empty);
         Assert.That(outputAudioStream.Length, Is.GreaterThan(9000));
+        Assert.That(streamedUsage?.InputTokenDetails?.AudioTokenCount, Is.GreaterThan(0));
+        Assert.That(streamedUsage?.OutputTokenDetails?.AudioTokenCount, Is.GreaterThan(0));
     }
 }

sdk/openai/Azure.AI.OpenAI/tests/ChatTests.cs

@@ -542,6 +542,43 @@ public async Task UserSecurityContextWorks()
         Assert.That(completion, Is.Not.Null);
     }
 
+    [RecordedTest]
+    [TestCase("chat", false)]
+    [TestCase("chat_o1", true)]
+    [TestCase("chat_o3-mini", true)]
+    public async Task MaxOutputTokensWorksAcrossModels(string testConfigName, bool useNewProperty)
+    {
+        IConfiguration testConfig = TestConfig.GetConfig(testConfigName)!;
+        ChatClient client = GetTestClient(testConfig);
+
+        ChatCompletionOptions options = new()
+        {
+            MaxOutputTokenCount = 16,
+        };
+
+        if (useNewProperty)
+        {
+            options.SetNewMaxCompletionTokensPropertyEnabled();
+        }
+
+        ChatCompletion completion = await client.CompleteChatAsync(
+            ["Hello, world! Please write a funny haiku to greet me."],
+            options);
+        Assert.That(completion.FinishReason, Is.EqualTo(ChatFinishReason.Length));
+
+        string serializedOptionsAfterUse = ModelReaderWriter.Write(options).ToString();
+
+        if (useNewProperty)
+        {
+            Assert.That(serializedOptionsAfterUse, Does.Contain("max_completion_tokens"));
+            Assert.That(serializedOptionsAfterUse, Does.Not.Contain("max_tokens"));
+        }
+        else
+        {
+            Assert.That(serializedOptionsAfterUse, Does.Not.Contain("max_completion_tokens"));
+            Assert.That(serializedOptionsAfterUse, Does.Contain("max_tokens"));
+        }
+    }
     #endregion
 
     #region Streaming chat completion tests