[.Net] Add AutoGen.OpenAI package that uses OpenAI v2 SDK (microsoft#…

…3402)

* udpate

* add sample to connect to azure oai

* update comment

* ping to beta5

* add openai tests

* format code

* add structural output example

* update comment

* fix test

* resolve comments

* fix format issue

* update sk version

dotnet/AutoGen.sln

@@ -64,7 +64,7 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AutoGen.Gemini.Sample", "sa
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AutoGen.AotCompatibility.Tests", "test\AutoGen.AotCompatibility.Tests\AutoGen.AotCompatibility.Tests.csproj", "{6B82F26D-5040-4453-B21B-C8D1F913CE4C}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AutoGen.OpenAI.V1.Sample", "sample\AutoGen.OpenAI.Sample\AutoGen.OpenAI.V1.Sample.csproj", "{0E635268-351C-4A6B-A28D-593D868C2CA4}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AutoGen.OpenAI.Sample", "sample\AutoGen.OpenAI.Sample\AutoGen.OpenAI.Sample.csproj", "{0E635268-351C-4A6B-A28D-593D868C2CA4}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AutoGen.WebAPI.Sample", "sample\AutoGen.WebAPI.Sample\AutoGen.WebAPI.Sample.csproj", "{12079C18-A519-403F-BBFD-200A36A0C083}"
 EndProject
@@ -74,6 +74,10 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AutoGen.AzureAIInference.Te
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AutoGen.Tests.Share", "test\AutoGen.Test.Share\AutoGen.Tests.Share.csproj", "{143725E2-206C-4D37-93E4-9EDF699826B2}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AutoGen.OpenAI", "src\AutoGen.OpenAI\AutoGen.OpenAI.csproj", "{3AF1CBEC-2877-41E9-92AE-3A391B2AA9E8}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AutoGen.OpenAI.Tests", "test\AutoGen.OpenAI.Tests\AutoGen.OpenAI.Tests.csproj", "{42A8251C-E7B3-47BB-A82E-459952EBE132}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -212,6 +216,14 @@ Global
 		{143725E2-206C-4D37-93E4-9EDF699826B2}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{143725E2-206C-4D37-93E4-9EDF699826B2}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{143725E2-206C-4D37-93E4-9EDF699826B2}.Release|Any CPU.Build.0 = Release|Any CPU
+		{3AF1CBEC-2877-41E9-92AE-3A391B2AA9E8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{3AF1CBEC-2877-41E9-92AE-3A391B2AA9E8}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{3AF1CBEC-2877-41E9-92AE-3A391B2AA9E8}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{3AF1CBEC-2877-41E9-92AE-3A391B2AA9E8}.Release|Any CPU.Build.0 = Release|Any CPU
+		{42A8251C-E7B3-47BB-A82E-459952EBE132}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{42A8251C-E7B3-47BB-A82E-459952EBE132}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{42A8251C-E7B3-47BB-A82E-459952EBE132}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{42A8251C-E7B3-47BB-A82E-459952EBE132}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -250,6 +262,8 @@ Global
 		{5C45981D-1319-4C25-935C-83D411CB28DF} = {18BF8DD7-0585-48BF-8F97-AD333080CE06}
 		{5970868F-831E-418F-89A9-4EC599563E16} = {F823671B-3ECA-4AE6-86DA-25E920D3FE64}
 		{143725E2-206C-4D37-93E4-9EDF699826B2} = {F823671B-3ECA-4AE6-86DA-25E920D3FE64}
+		{3AF1CBEC-2877-41E9-92AE-3A391B2AA9E8} = {18BF8DD7-0585-48BF-8F97-AD333080CE06}
+		{42A8251C-E7B3-47BB-A82E-459952EBE132} = {F823671B-3ECA-4AE6-86DA-25E920D3FE64}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {93384647-528D-46C8-922C-8DB36A382F0B}

dotnet/eng/Version.props

@@ -2,8 +2,9 @@
 <Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
     <PropertyGroup>
         <AzureOpenAIVersion>1.0.0-beta.17</AzureOpenAIVersion>
-        <SemanticKernelVersion>1.15.1</SemanticKernelVersion>
-        <SemanticKernelExperimentalVersion>1.15.1-alpha</SemanticKernelExperimentalVersion>
+        <AzureOpenAIV2Version>2.0.0-beta.3</AzureOpenAIV2Version>
+        <SemanticKernelVersion>1.18.1-rc</SemanticKernelVersion>
+        <SemanticKernelExperimentalVersion>1.18.1-alpha</SemanticKernelExperimentalVersion>
         <SystemCodeDomVersion>5.0.0</SystemCodeDomVersion>
         <MicrosoftCodeAnalysisVersion>4.3.0</MicrosoftCodeAnalysisVersion>
         <ApprovalTestVersion>6.0.0</ApprovalTestVersion>
@@ -16,6 +17,7 @@
         <GoogleCloudAPIPlatformVersion>3.0.0</GoogleCloudAPIPlatformVersion>
         <JsonSchemaVersion>4.3.0.2</JsonSchemaVersion>
         <AzureAIInferenceVersion>1.0.0-beta.1</AzureAIInferenceVersion>
+        <OpenAISDKVersion>2.0.0-beta.10</OpenAISDKVersion>
         <PowershellSDKVersion>7.4.4</PowershellSDKVersion>
     </PropertyGroup>
 </Project>

dotnet/sample/AutoGen.BasicSamples/CodeSnippet/CreateAnAgent.cs

@@ -3,8 +3,10 @@
 
 using AutoGen;
 using AutoGen.Core;
-using AutoGen.OpenAI.V1;
+using AutoGen.OpenAI;
+using AutoGen.OpenAI.Extension;
 using FluentAssertions;
+using OpenAI;
 
 public partial class AssistantCodeSnippet
 {
@@ -32,23 +34,18 @@ public void CodeSnippet2()
     {
         #region code_snippet_2
         // get OpenAI Key and create config
-        var apiKey = Environment.GetEnvironmentVariable("AZURE_OPENAI_API_KEY");
-        string endPoint = Environment.GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT"); // change to your endpoint
+        var apiKey = Environment.GetEnvironmentVariable("OPENAI_API_KEY");
+        var model = "gpt-4o-mini";
 
-        var llmConfig = new AzureOpenAIConfig(
-            endpoint: endPoint,
-            deploymentName: "gpt-3.5-turbo-16k", // change to your deployment name
-            apiKey: apiKey);
+        var openAIClient = new OpenAIClient(apiKey);
 
         // create assistant agent
-        var assistantAgent = new AssistantAgent(
+        var assistantAgent = new OpenAIChatAgent(
             name: "assistant",
             systemMessage: "You are an assistant that help user to do some tasks.",
-            llmConfig: new ConversableAgentConfig
-            {
-                Temperature = 0,
-                ConfigList = new[] { llmConfig },
-            });
+            chatClient: openAIClient.GetChatClient(model))
+            .RegisterMessageConnector()
+            .RegisterPrintMessage();
         #endregion code_snippet_2
     }
 
@@ -71,27 +68,21 @@ public async Task CodeSnippet4()
         // get OpenAI Key and create config
         var apiKey = Environment.GetEnvironmentVariable("AZURE_OPENAI_API_KEY");
         string endPoint = Environment.GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT"); // change to your endpoint
-
-        var llmConfig = new AzureOpenAIConfig(
-            endpoint: endPoint,
-            deploymentName: "gpt-3.5-turbo-16k", // change to your deployment name
-            apiKey: apiKey);
+        var model = "gpt-4o-mini";
+        var openAIClient = new OpenAIClient(new System.ClientModel.ApiKeyCredential(apiKey), new OpenAIClientOptions
+        {
+            Endpoint = new Uri(endPoint),
+        });
         #region code_snippet_4
-        var assistantAgent = new AssistantAgent(
+        var assistantAgent = new OpenAIChatAgent(
+            chatClient: openAIClient.GetChatClient(model),
             name: "assistant",
             systemMessage: "You are an assistant that convert user input to upper case.",
-            llmConfig: new ConversableAgentConfig
-            {
-                Temperature = 0,
-                ConfigList = new[]
-                {
-                    llmConfig
-                },
-                FunctionContracts = new[]
-                {
-                    this.UpperCaseFunctionContract, // The FunctionDefinition object for the UpperCase function
-                },
-            });
+            functions: [
+                this.UpperCaseFunctionContract.ToChatTool(), // The FunctionDefinition object for the UpperCase function
+            ])
+            .RegisterMessageConnector()
+            .RegisterPrintMessage();
 
         var response = await assistantAgent.SendAsync("hello");
         response.Should().BeOfType<ToolCallMessage>();
@@ -106,31 +97,24 @@ public async Task CodeSnippet5()
         // get OpenAI Key and create config
         var apiKey = Environment.GetEnvironmentVariable("AZURE_OPENAI_API_KEY");
         string endPoint = Environment.GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT"); // change to your endpoint
-
-        var llmConfig = new AzureOpenAIConfig(
-            endpoint: endPoint,
-            deploymentName: "gpt-3.5-turbo-16k", // change to your deployment name
-            apiKey: apiKey);
+        var model = "gpt-4o-mini";
+        var openAIClient = new OpenAIClient(new System.ClientModel.ApiKeyCredential(apiKey), new OpenAIClientOptions
+        {
+            Endpoint = new Uri(endPoint),
+        });
         #region code_snippet_5
-        var assistantAgent = new AssistantAgent(
-            name: "assistant",
-            systemMessage: "You are an assistant that convert user input to upper case.",
-            llmConfig: new ConversableAgentConfig
-            {
-                Temperature = 0,
-                ConfigList = new[]
-                {
-                    llmConfig
-                },
-                FunctionContracts = new[]
-                {
-                    this.UpperCaseFunctionContract, // The FunctionDefinition object for the UpperCase function
-                },
-            },
-            functionMap: new Dictionary<string, Func<string, Task<string>>>
+        var functionCallMiddleware = new FunctionCallMiddleware(
+            functions: [this.UpperCaseFunctionContract],
+            functionMap: new Dictionary<string, Func<string, Task<string>>>()
             {
-                { this.UpperCaseFunctionContract.Name, this.UpperCaseWrapper }, // The wrapper function for the UpperCase function
+                { this.UpperCaseFunctionContract.Name, this.UpperCase },
             });
+        var assistantAgent = new OpenAIChatAgent(
+            name: "assistant",
+            systemMessage: "You are an assistant that convert user input to upper case.",
+            chatClient: openAIClient.GetChatClient(model))
+            .RegisterMessageConnector()
+            .RegisterStreamingMiddleware(functionCallMiddleware);
 
         var response = await assistantAgent.SendAsync("hello");
         response.Should().BeOfType<TextMessage>();

dotnet/sample/AutoGen.BasicSamples/CodeSnippet/FunctionCallCodeSnippet.cs

@@ -3,7 +3,6 @@
 
 using AutoGen;
 using AutoGen.Core;
-using AutoGen.OpenAI.V1;
 using FluentAssertions;
 
 public partial class FunctionCallCodeSnippet

dotnet/sample/AutoGen.BasicSamples/CodeSnippet/GetStartCodeSnippet.cs

@@ -4,7 +4,9 @@
 #region snippet_GetStartCodeSnippet
 using AutoGen;
 using AutoGen.Core;
-using AutoGen.OpenAI.V1;
+using AutoGen.OpenAI;
+using AutoGen.OpenAI.Extension;
+using OpenAI;
 #endregion snippet_GetStartCodeSnippet
 
 public class GetStartCodeSnippet
@@ -13,16 +15,14 @@ public async Task CodeSnippet1()
     {
         #region code_snippet_1
         var openAIKey = Environment.GetEnvironmentVariable("OPENAI_API_KEY") ?? throw new Exception("Please set OPENAI_API_KEY environment variable.");
-        var gpt35Config = new OpenAIConfig(openAIKey, "gpt-3.5-turbo");
+        var openAIClient = new OpenAIClient(openAIKey);
+        var model = "gpt-4o-mini";
 
-        var assistantAgent = new AssistantAgent(
+        var assistantAgent = new OpenAIChatAgent(
             name: "assistant",
             systemMessage: "You are an assistant that help user to do some tasks.",
-            llmConfig: new ConversableAgentConfig
-            {
-                Temperature = 0,
-                ConfigList = [gpt35Config],
-            })
+            chatClient: openAIClient.GetChatClient(model))
+            .RegisterMessageConnector()
             .RegisterPrintMessage(); // register a hook to print message nicely to console
 
         // set human input mode to ALWAYS so that user always provide input

dotnet/sample/AutoGen.BasicSamples/CodeSnippet/MiddlewareAgentCodeSnippet.cs

@@ -3,7 +3,7 @@
 
 using System.Text.Json;
 using AutoGen.Core;
-using AutoGen.OpenAI.V1;
+using AutoGen.OpenAI;
 using FluentAssertions;
 
 namespace AutoGen.BasicSample.CodeSnippet;

dotnet/sample/AutoGen.BasicSamples/CodeSnippet/OpenAICodeSnippet.cs

@@ -3,11 +3,12 @@
 
 #region using_statement
 using AutoGen.Core;
-using AutoGen.OpenAI.V1;
-using AutoGen.OpenAI.V1.Extension;
-using Azure.AI.OpenAI;
+using AutoGen.OpenAI;
+using AutoGen.OpenAI.Extension;
 #endregion using_statement
 using FluentAssertions;
+using OpenAI;
+using OpenAI.Chat;
 
 namespace AutoGen.BasicSample.CodeSnippet;
 #region weather_function
@@ -32,40 +33,39 @@ public async Task CreateOpenAIChatAgentAsync()
     {
         #region create_openai_chat_agent
         var openAIKey = Environment.GetEnvironmentVariable("OPENAI_API_KEY") ?? throw new Exception("Please set OPENAI_API_KEY environment variable.");
-        var modelId = "gpt-3.5-turbo";
+        var modelId = "gpt-4o-mini";
         var openAIClient = new OpenAIClient(openAIKey);
 
         // create an open ai chat agent
         var openAIChatAgent = new OpenAIChatAgent(
-            openAIClient: openAIClient,
+            chatClient: openAIClient.GetChatClient(modelId),
             name: "assistant",
-            modelName: modelId,
             systemMessage: "You are an assistant that help user to do some tasks.");
 
         // OpenAIChatAgent supports the following message types:
         // - IMessage<ChatRequestMessage> where ChatRequestMessage is from Azure.AI.OpenAI
 
-        var helloMessage = new ChatRequestUserMessage("Hello");
+        var helloMessage = new UserChatMessage("Hello");
 
         // Use MessageEnvelope.Create to create an IMessage<ChatRequestMessage>
         var chatMessageContent = MessageEnvelope.Create(helloMessage);
         var reply = await openAIChatAgent.SendAsync(chatMessageContent);
 
-        // The type of reply is MessageEnvelope<ChatResponseMessage> where ChatResponseMessage is from Azure.AI.OpenAI
-        reply.Should().BeOfType<MessageEnvelope<ChatResponseMessage>>();
+        // The type of reply is MessageEnvelope<ChatCompletion> where ChatResponseMessage is from Azure.AI.OpenAI
+        reply.Should().BeOfType<MessageEnvelope<ChatCompletion>>();
 
         // You can un-envelop the reply to get the ChatResponseMessage
-        ChatResponseMessage response = reply.As<MessageEnvelope<ChatResponseMessage>>().Content;
-        response.Role.Should().Be(ChatRole.Assistant);
+        ChatCompletion response = reply.As<MessageEnvelope<ChatCompletion>>().Content;
+        response.Role.Should().Be(ChatMessageRole.Assistant);
         #endregion create_openai_chat_agent
 
         #region create_openai_chat_agent_streaming
         var streamingReply = openAIChatAgent.GenerateStreamingReplyAsync(new[] { chatMessageContent });
 
         await foreach (var streamingMessage in streamingReply)
         {
-            streamingMessage.Should().BeOfType<MessageEnvelope<StreamingChatCompletionsUpdate>>();
-            streamingMessage.As<MessageEnvelope<StreamingChatCompletionsUpdate>>().Content.Role.Should().Be(ChatRole.Assistant);
+            streamingMessage.Should().BeOfType<MessageEnvelope<StreamingChatCompletionUpdate>>();
+            streamingMessage.As<MessageEnvelope<StreamingChatCompletionUpdate>>().Content.Role.Should().Be(ChatMessageRole.Assistant);
         }
         #endregion create_openai_chat_agent_streaming
 
@@ -77,7 +77,7 @@ public async Task CreateOpenAIChatAgentAsync()
         // now the agentWithConnector supports more message types
         var messages = new IMessage[]
         {
-            MessageEnvelope.Create(new ChatRequestUserMessage("Hello")),
+            MessageEnvelope.Create(new UserChatMessage("Hello")),
             new TextMessage(Role.Assistant, "Hello", from: "user"),
             new MultiModalMessage(Role.Assistant,
                 [
@@ -106,9 +106,8 @@ public async Task OpenAIChatAgentGetWeatherFunctionCallAsync()
 
         // create an open ai chat agent
         var openAIChatAgent = new OpenAIChatAgent(
-            openAIClient: openAIClient,
+            chatClient: openAIClient.GetChatClient(modelId),
             name: "assistant",
-            modelName: modelId,
             systemMessage: "You are an assistant that help user to do some tasks.")
             .RegisterMessageConnector();
 

dotnet/sample/AutoGen.BasicSamples/CodeSnippet/PrintMessageMiddlewareCodeSnippet.cs

@@ -2,10 +2,8 @@
 // PrintMessageMiddlewareCodeSnippet.cs
 
 using AutoGen.Core;
-using AutoGen.OpenAI.V1;
-using AutoGen.OpenAI.V1.Extension;
-using Azure;
-using Azure.AI.OpenAI;
+using AutoGen.OpenAI;
+using AutoGen.OpenAI.Extension;
 
 namespace AutoGen.BasicSample.CodeSnippet;
 
@@ -15,8 +13,8 @@ public async Task PrintMessageMiddlewareAsync()
     {
         var config = LLMConfiguration.GetAzureOpenAIGPT3_5_Turbo();
         var endpoint = new Uri(config.Endpoint);
-        var openaiClient = new OpenAIClient(endpoint, new AzureKeyCredential(config.ApiKey));
-        var agent = new OpenAIChatAgent(openaiClient, "assistant", config.DeploymentName)
+        var gpt4o = LLMConfiguration.GetOpenAIGPT4o_mini();
+        var agent = new OpenAIChatAgent(gpt4o, "assistant", config.DeploymentName)
             .RegisterMessageConnector();
 
         #region PrintMessageMiddleware
@@ -31,10 +29,10 @@ public async Task PrintMessageStreamingMiddlewareAsync()
     {
         var config = LLMConfiguration.GetAzureOpenAIGPT3_5_Turbo();
         var endpoint = new Uri(config.Endpoint);
-        var openaiClient = new OpenAIClient(endpoint, new AzureKeyCredential(config.ApiKey));
+        var gpt4o = LLMConfiguration.GetOpenAIGPT4o_mini();
 
         #region print_message_streaming
-        var streamingAgent = new OpenAIChatAgent(openaiClient, "assistant", config.DeploymentName)
+        var streamingAgent = new OpenAIChatAgent(gpt4o, "assistant")
             .RegisterMessageConnector()
             .RegisterPrintMessage();