Azure OpenAI: 2.0.0 stable release (#46378)

* initial cross-apply of 2.0.0 changes

* minor: changelog update

* correct Packages.Data.props

* export-api

* correct cross-repo assets.json change

* prepare-release and assets re-fix

* temporary exclusion for search projectref

* exclusion via AOAI folder rather than search

* exclusion from search test project

* move exclusion to proper itemgroup

* circumvent binarydata tostring issue on mac

Author: trrwilson

eng/Packages.Data.props

@@ -175,7 +175,7 @@
   </ItemGroup>
 
   <ItemGroup Condition="$(MSBuildProjectName.StartsWith('Azure.AI.OpenAI'))">
-    <PackageReference Update="OpenAI" Version="2.0.0-beta.12" />
+    <PackageReference Update="OpenAI" Version="2.0.0" />
   </ItemGroup>
 
   <!--

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

@@ -1,5 +1,37 @@
 # Release History
 
+## 2.0.0 (2024-09-30)
+
+This update marks the first stable library version for `Azure.AI.OpenAI`. It snaps its dependency to `OpenAI`'s matched `2.0.0` stable version and targets the latest Azure OpenAI Service stable `api-version` label of `2024-06-01`. As a GA label, the `2.0.0` stable version exposes a subset of preview features, with preview library labels continuing to support preview features.
+
+Specifically included in the GA library release:
+
+- `AudioClient`, supporting transcription and translation using the `whisper` model
+- `ChatClient`, supporting chat completions, including Azure-specific features:
+  - Embedded request and response content filter annotations
+  - Azure Search and Cosmos DB data sources for Azure OpenAI On Your Data
+- `EmbeddingClient`, supporting `text-embedding` model embedding operations
+- `ImageClient`, supporting `dall-e-3` image generation
+
+Assistants, Audio Generation, Batch, Files, Fine-Tuning, and Vector Stores are not yet included in the GA surface; they will continue to be available in preview library releases and the originating Azure OpenAI Service `api-version` labels.
+
+### Breaking Changes
+
+- `AzureOpenAIClient` constructors accepting `AzureKeyCredential` have been removed; please use the `ApiKeyCredential` constructors, instead. Note that `AzureKeyCredential` will inherit from `ApiKeyCredential` in a future update and that `AzureKeyCredential` has [a non-browsable Key property](https://github.com/Azure/azure-sdk-for-net/blob/448d80d80ad0f3df69b96df080da6cf8b537e9d2/sdk/core/Azure.Core/src/AzureKeyCredential.cs#L19) that may be used for conversion in the interim.
+- The `AzureOpenAIClientOptions` `ApplicationId` has been renamed to a more descriptive `UserAgentApplicationId`.
+
+**From OpenAI 2.0.0 stable**
+
+- Implemented `ChatMessageContent` to encapsulate the representation of content parts in `ChatMessage`, `ChatCompletion`, and `StreamingChatCompletionUpdate`. (commit_hash)
+- Changed the representation of function arguments to `BinaryData` in `ChatToolCall`, `StreamingChatToolCallUpdate`, `ChatFunctionCall`, and `StreamingChatFunctionCallUpdate`. (commit_hash)
+- Renamed `OpenAIClientOptions`'s `ApplicationId` to `UserAgentApplicationId` (commit_hash)
+- Renamed `StreamingChatToolCallUpdate`'s `Id` to `ToolCallId` (commit_hash)
+- Renamed `StreamingChatCompletionUpdate`'s `Id` to `CompletionId` (commit_hash)
+- Replaced `Auto` and `None` in the deprecated `ChatFunctionChoice` with `CreateAutoChoice()` and `CreateNoneChoice()` (commit_hash)
+- Replaced the deprecated `ChatFunctionChoice(ChatFunction)` constructor with `CreateNamedChoice(string functionName)` (commit_hash)
+- Renamed `FileClient` to `OpenAIFileClient` and the corresponding `GetFileClient()` method in `OpenAIClient` to `GetOpenAIFileClient()`. (commit_hash)
+- Renamed `ModelClient` to `OpenAIModelClient` and the corresponding `GetModelClient()` method in `OpenAIClient` to `GetOpenAIModelClient()`. (commit_hash)
+
 ## 2.0.0-beta.6 (2024-09-23)
 
 This version increments library compatibility to `OpenAI 2.0.0-beta.12`, including support for `o1` models with reasoning tokens and a number of breaking changes to method names.

sdk/openai/Azure.AI.OpenAI/Directory.Build.props

@@ -1,5 +1,6 @@
 <Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <PropertyGroup>
+    <GAServiceVersionLabel>2024_06_01</GAServiceVersionLabel>
     <!--
       During development, we may want to get ahead of the published Nuget package versions. These next property flags
       allow you to replace Nuget package references with external assembly .dll references, or even the source code

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

@@ -88,7 +88,7 @@ string keyFromEnvironment = Environment.GetEnvironmentVariable("AZURE_OPENAI_API
 
 AzureOpenAIClient azureClient = new(
     new Uri("https://your-azure-openai-resource.com"),
-    new AzureKeyCredential(keyFromEnvironment));
+    new ApiKeyCredential(keyFromEnvironment));
 ChatClient chatClient = azureClient.GetChatClient("my-gpt-35-turbo-deployment");
 ```
 
@@ -319,10 +319,8 @@ tool call messages for assistant message history. Note that the model will ignor
 and that all streamed responses should map to a single, common choice index in the range of `[0..(ChoiceCount - 1)]`.
 
 ```C# Snippet:ChatTools:StreamingChatTools
-Dictionary<int, string> toolCallIdsByIndex = [];
-Dictionary<int, string> functionNamesByIndex = [];
-Dictionary<int, StringBuilder> functionArgumentBuildersByIndex = [];
 StringBuilder contentBuilder = new();
+StreamingChatToolCallsBuilder toolCallsBuilder = new();
 
 foreach (StreamingChatCompletionUpdate streamingChatUpdate
     in chatClient.CompleteChatStreaming(conversationMessages, options))
@@ -331,40 +329,22 @@ foreach (StreamingChatCompletionUpdate streamingChatUpdate
     {
         contentBuilder.Append(contentPart.Text);
     }
+
     foreach (StreamingChatToolCallUpdate toolCallUpdate in streamingChatUpdate.ToolCallUpdates)
     {
-        if (!string.IsNullOrEmpty(toolCallUpdate.Id))
-        {
-            toolCallIdsByIndex[toolCallUpdate.Index] = toolCallUpdate.Id;
-        }
-        if (!string.IsNullOrEmpty(toolCallUpdate.FunctionName))
-        {
-            functionNamesByIndex[toolCallUpdate.Index] = toolCallUpdate.FunctionName;
-        }
-        if (!string.IsNullOrEmpty(toolCallUpdate.FunctionArgumentsUpdate))
-        {
-            StringBuilder argumentsBuilder
-                = functionArgumentBuildersByIndex.TryGetValue(toolCallUpdate.Index, out StringBuilder existingBuilder)
-                    ? existingBuilder
-                    : new();
-            argumentsBuilder.Append(toolCallUpdate.FunctionArgumentsUpdate);
-            functionArgumentBuildersByIndex[toolCallUpdate.Index] = argumentsBuilder;
-        }
+        toolCallsBuilder.Append(toolCallUpdate);
     }
 }
 
-List<ChatToolCall> toolCalls = [];
-foreach (KeyValuePair<int, string> indexToIdPair in toolCallIdsByIndex)
+IReadOnlyList<ChatToolCall> toolCalls = toolCallsBuilder.Build();
+
+AssistantChatMessage assistantMessage = new AssistantChatMessage(toolCalls);
+if (contentBuilder.Length > 0)
 {
-    toolCalls.Add(ChatToolCall.CreateFunctionToolCall(
-        indexToIdPair.Value,
-        functionNamesByIndex[indexToIdPair.Key],
-        functionArgumentBuildersByIndex[indexToIdPair.Key].ToString()));
+    assistantMessage.Content.Add(ChatMessageContentPart.CreateTextPart(contentBuilder.ToString()));
 }
 
-var assistantChatMessage = new AssistantChatMessage(toolCalls);
-assistantChatMessage.Content.Add(ChatMessageContentPart.CreateTextPart(contentBuilder.ToString()));
-conversationMessages.Add(assistantChatMessage);
+conversationMessages.Add(assistantMessage);
 
 // Placeholder: each tool call must be resolved, like in the non-streaming case
 string GetToolCallOutput(ChatToolCall toolCall) => null;
@@ -404,13 +384,13 @@ ChatCompletion completion = chatClient.CompleteChat(
     ],
     options);
 
-AzureChatMessageContext onYourDataContext = completion.GetAzureMessageContext();
+ChatMessageContext onYourDataContext = completion.GetMessageContext();
 
 if (onYourDataContext?.Intent is not null)
 {
     Console.WriteLine($"Intent: {onYourDataContext.Intent}");
 }
-foreach (AzureChatCitation citation in onYourDataContext?.Citations ?? [])
+foreach (ChatCitation citation in onYourDataContext?.Citations ?? [])
 {
     Console.WriteLine($"Citation: {citation.Content}");
 }
@@ -470,7 +450,7 @@ RunCreationOptions runOptions = new()
     AdditionalInstructions = "When possible, talk like a pirate."
 };
 await foreach (StreamingUpdate streamingUpdate
-    in assistantClient.CreateRunStreamingAsync(thread, assistant, runOptions))
+    in assistantClient.CreateRunStreamingAsync(thread.Id, assistant.Id, runOptions))
 {
     if (streamingUpdate.UpdateKind == StreamingUpdateReason.RunCreated)
     {
@@ -492,8 +472,8 @@ reuse them later or, as demonstrated below, delete them when no longer desired.
 
 ```C# Snippet:Assistants:Cleanup
 // Optionally, delete persistent resources that are no longer needed.
-_ = await assistantClient.DeleteAssistantAsync(assistant);
-_ = await assistantClient.DeleteThreadAsync(thread);
+_ = await assistantClient.DeleteAssistantAsync(assistant.Id);
+_ = await assistantClient.DeleteThreadAsync(thread.Id);
 ```
 
 ## Next steps