Merge pull request #264 from Avanade/feat/newcartridges

lucianareginalino · web-flow · commit 001f57384073 · 2025-04-22T18:25:50.000-03:00
feat: upgrade Azure.Ai.OpenAi package version
diff --git a/src/Liquid.ChatCompletions.OpenAi/IOpenAiClientFactory.cs b/src/Liquid.ChatCompletions.OpenAi/IOpenAiClientFactory.cs
@@ -1,16 +1,17 @@
 ﻿using Azure.AI.OpenAI;
+using OpenAI.Chat;
 
 namespace Liquid.ChatCompletions.OpenAi
 {
     /// <summary>
-    /// Provide <see cref="OpenAIClient"/> generator methods.
+    /// Provide <see cref="ChatClient"/> generator methods.
     /// </summary>
     public interface IOpenAiClientFactory
     {
         /// <summary>
-        /// Provide a instance of <see cref="OpenAIClient"/> with conection started.
+        /// Provide a instance of <see cref="ChatClient"/> with conection started.
         /// </summary>
         /// <param name="clientId">OpenAI connections alias.</param>
-        OpenAIClient GetOpenAIClient(string clientId);
+        ChatClient GetOpenAIClient(string clientId);
     }
 }
diff --git a/src/Liquid.ChatCompletions.OpenAi/Liquid.ChatCompletions.OpenAi.csproj b/src/Liquid.ChatCompletions.OpenAi/Liquid.ChatCompletions.OpenAi.csproj
@@ -13,7 +13,7 @@
 	  <Copyright>Avanade 2019</Copyright>
 	  <PackageProjectUrl>https://github.com/Avanade/Liquid-Application-Framework</PackageProjectUrl>
 	  <PackageIcon>logo.png</PackageIcon>
-	  <Version>8.0.0-beta-03</Version>
+	  <Version>8.0.0-beta-04</Version>
 	  <GenerateDocumentationFile>true</GenerateDocumentationFile>
 	  <IsPackable>true</IsPackable>
 	  <DebugType>Full</DebugType>
@@ -31,9 +31,9 @@
 	</ItemGroup>
 	
   <ItemGroup>
-    <PackageReference Include="Azure.AI.OpenAI" Version="1.0.0-beta.17" />
-    <PackageReference Include="Liquid.Core" Version="8.0.0-beta-06" />
-    <PackageReference Include="Microsoft.Extensions.Configuration.Binder" Version="8.0.1" />
+    <PackageReference Include="Azure.AI.OpenAI" Version="2.1.0" />
+    <PackageReference Include="Liquid.Core" Version="8.0.0-beta-09" />
+    <PackageReference Include="Microsoft.Extensions.Configuration.Binder" Version="8.0.2" />
   </ItemGroup>
 
 </Project>
diff --git a/src/Liquid.ChatCompletions.OpenAi/OpenAiChatCompletions.cs b/src/Liquid.ChatCompletions.OpenAi/OpenAiChatCompletions.cs
@@ -1,7 +1,7 @@
 ﻿using Liquid.Core.Entities;
 using Liquid.Core.Interfaces;
 using Liquid.Core.Settings;
-using Azure.AI.OpenAI;
+using OpenAI.Chat;
 using System.Diagnostics.CodeAnalysis;
 
 namespace Liquid.ChatCompletions.OpenAi
@@ -27,26 +27,24 @@ public async Task<ChatCompletionResult> FunctionCalling(ChatMessages messages, L
         {
             var client = _factory.GetOpenAIClient(settings.ClientId);
 
-            var requestMessages = new List<ChatRequestMessage>();
+            var requestMessages = new List<OpenAI.Chat.ChatMessage>();
 
             messages.Messages.ForEach(m => requestMessages.Add(MapChatRequestMessage(m)));
 
             var option = MapChatCompletionOptions(requestMessages, settings);
 
-            functions.ForEach(f => option.Functions.Add(GetDefinition(f)));
+            functions.ForEach(f => option.Tools.Add(ChatTool.CreateFunctionTool(f.Name, f.Description, f.Parameters)));
 
-            var responseWithoutStream = await client.GetChatCompletionsAsync(option, new CancellationToken());
-
-            var response = responseWithoutStream.Value.Choices[0].Message.FunctionCall == null ?
-               null : responseWithoutStream.Value.Choices[0].Message.FunctionCall.Arguments;
+            var responseWithoutStream = await client.CompleteChatAsync(requestMessages, option);
+            var response = responseWithoutStream.Value.Content[0].Text;
 
             var result = new ChatCompletionResult()
             {
-                FinishReason = responseWithoutStream.Value.Choices[0]?.FinishReason?.ToString(),
+                FinishReason = responseWithoutStream.Value.FinishReason.ToString(),
                 Content = response,
-                Usage = responseWithoutStream.Value.Usage.TotalTokens,
-                PromptUsage = responseWithoutStream.Value.Usage.PromptTokens,
-                CompletionUsage = responseWithoutStream.Value.Usage.CompletionTokens,
+                Usage = responseWithoutStream.Value.Usage.TotalTokenCount,
+                PromptUsage = responseWithoutStream.Value.Usage.InputTokenCount,
+                CompletionUsage = responseWithoutStream.Value.Usage.OutputTokenCount,
             };
 
             return result;
@@ -61,15 +59,16 @@ public async Task<ChatCompletionResult> ChatCompletions(string content, string p
 
             var option = MapChatCompletionOptions(messages, settings);
 
-            var responseWithoutStream = await client.GetChatCompletionsAsync(option, new CancellationToken());
+            var responseWithoutStream = await client.CompleteChatAsync(messages, option);
+            var response = responseWithoutStream.Value.Content[0].Text;
 
             var result = new ChatCompletionResult()
             {
-                FinishReason = responseWithoutStream.Value.Choices[0]?.FinishReason?.ToString(),
-                Content = responseWithoutStream.Value.Choices[0]?.Message?.Content,
-                Usage = responseWithoutStream.Value.Usage.TotalTokens,
-                PromptUsage = responseWithoutStream.Value.Usage.PromptTokens,
-                CompletionUsage = responseWithoutStream.Value.Usage.CompletionTokens,
+                FinishReason = responseWithoutStream.Value.FinishReason.ToString(),
+                Content = response,
+                Usage = responseWithoutStream.Value.Usage.TotalTokenCount,
+                PromptUsage = responseWithoutStream.Value.Usage.InputTokenCount,
+                CompletionUsage = responseWithoutStream.Value.Usage.OutputTokenCount,
             };
 
             return result;
@@ -78,36 +77,29 @@ public async Task<ChatCompletionResult> ChatCompletions(string content, string p
         ///<inheritdoc/>
         public async Task<ReadOnlyMemory<float>> GetEmbeddings(string description, string modelName, string clientId)
         {
-            var client = _factory.GetOpenAIClient(clientId);
+            //var client = _factory.GetOpenAIClient(clientId);
 
-            EmbeddingsOptions embeddingsOptions = new(modelName, new string[] { description });
+            //EmbeddingGenerationOptions embeddingsOptions = new(modelName, new string[] { description });
 
-            var embeddings = await client.GetEmbeddingsAsync(embeddingsOptions);
+            //var embeddings = await client.(embeddingsOptions);
 
-            return embeddings.Value.Data[0].Embedding;
-        }
+            //return embeddings.Value.Data[0].Embedding;
 
-        private FunctionDefinition GetDefinition(FunctionBody function)
-        {
-            return new FunctionDefinition()
-            {
-                Name = function.Name,
-                Description = function.Description,
-                Parameters = function.Parameters,
-            };
+            throw new NotImplementedException();
         }
 
+
         /// <summary>
         /// get chat messages for a chat completions request.
         /// </summary>
         /// <param name="content">content of the user message</param>
         /// <param name="prompt">prompt message</param>
         /// <param name="chatHistory">chat context messages</param>
-        private List<ChatRequestMessage> GetChatMessagesAsync(string content, string prompt, ChatMessages? chatHistory = null)
+        private List<OpenAI.Chat.ChatMessage> GetChatMessagesAsync(string content, string prompt, ChatMessages? chatHistory = null)
         {
-            var messages = new List<ChatRequestMessage>
+            var messages = new List<OpenAI.Chat.ChatMessage>
             {
-                new ChatRequestSystemMessage(prompt)
+                new SystemChatMessage(prompt)
             };
 
             if (chatHistory?.Messages != null && chatHistory.Messages.Count > 0)
@@ -118,7 +110,7 @@ private List<ChatRequestMessage> GetChatMessagesAsync(string content, string pro
                 }
             }
 
-            messages.Add(new ChatRequestUserMessage(content));
+            messages.Add(new UserChatMessage(content));
 
             return messages;
         }
@@ -128,19 +120,19 @@ private List<ChatRequestMessage> GetChatMessagesAsync(string content, string pro
         /// </summary>
         /// <param name="message">chat message</param>
         /// <exception cref="ArgumentNullException"></exception>
-        private ChatRequestMessage MapChatRequestMessage(ChatMessage message)
+        private OpenAI.Chat.ChatMessage MapChatRequestMessage(Core.Entities.ChatMessage message)
         {
-            ChatRequestMessage chatRequestMessage = null;
+            OpenAI.Chat.ChatMessage chatRequestMessage = null;
             switch (message.Role.ToLower())
             {
                 case "system":
-                    chatRequestMessage = new ChatRequestSystemMessage(message.Content);
+                    chatRequestMessage = new SystemChatMessage(message.Content);
                     break;
                 case "assistant":
-                    chatRequestMessage = new ChatRequestAssistantMessage(message.Content);
+                    chatRequestMessage = new AssistantChatMessage(message.Content);
                     break;
                 case "user":
-                    chatRequestMessage = new ChatRequestUserMessage(message.Content);
+                    chatRequestMessage = new UserChatMessage(message.Content);
                     break;
                 default:
                     break;
@@ -160,15 +152,16 @@ private ChatRequestMessage MapChatRequestMessage(ChatMessage message)
         /// <param name="messages">Chat messages </param>
         /// <param name="settings">Chat completions settings</param>
         /// <returns></returns>
-        private ChatCompletionsOptions MapChatCompletionOptions(List<ChatRequestMessage> messages, CompletionsSettings settings)
+        private ChatCompletionOptions MapChatCompletionOptions(List<OpenAI.Chat.ChatMessage> messages, CompletionsSettings settings)
         {
-            return new ChatCompletionsOptions(settings.DeploymentName, messages)
+            return new ChatCompletionOptions()
             {
                 Temperature = settings.Temperature,
-                MaxTokens = settings.MaxTokens,
-                NucleusSamplingFactor = settings.NucleusSamplingFactor,
+                MaxOutputTokenCount = settings.MaxTokens,
+                TopP = settings.NucleusSamplingFactor,
                 FrequencyPenalty = settings.FrequencyPenalty,
-                PresencePenalty = settings.PresencePenalty,
+                PresencePenalty = settings.PresencePenalty
+
             };
         }
     }
diff --git a/src/Liquid.ChatCompletions.OpenAi/OpenAiClientFactory.cs b/src/Liquid.ChatCompletions.OpenAi/OpenAiClientFactory.cs
@@ -4,7 +4,10 @@
 using Liquid.Core.Entities;
 using Liquid.Core.Settings;
 using Microsoft.Extensions.Options;
+using OpenAI.Chat;
 using System.Diagnostics.CodeAnalysis;
+using System.Net;
+using System.Reflection;
 
 namespace Liquid.ChatCompletions.OpenAi
 {
@@ -13,7 +16,7 @@ namespace Liquid.ChatCompletions.OpenAi
     public class OpenAiClientFactory : IOpenAiClientFactory
     {
         private readonly IOptions<GenAiOptions> _settings;
-        private readonly List<ClientDictionary<OpenAIClient>> _openAiClients;
+        private readonly List<ClientDictionary<ChatClient>> _openAiClients;
 
         /// <summary>
         /// Initialize a new instance of <see cref="OpenAiClientFactory"/>
@@ -23,11 +26,11 @@ public class OpenAiClientFactory : IOpenAiClientFactory
         public OpenAiClientFactory(IOptions<GenAiOptions> settings)
         {
             _settings = settings ?? throw new ArgumentNullException(nameof(settings));
-            _openAiClients = new List<ClientDictionary<OpenAIClient>>();
+            _openAiClients = new List<ClientDictionary<ChatClient>>();
         }
 
         ///<inheritdoc/>
-        public OpenAIClient GetOpenAIClient(string clientId)
+        public ChatClient GetOpenAIClient(string clientId)
         {
             var settings = _settings.Value.Settings.Where(x => x.ClientId == clientId).ToList();
 
@@ -49,30 +52,31 @@ public OpenAIClient GetOpenAIClient(string clientId)
             }
         }
 
-        private OpenAIClient CreateClient(List<GenAiSettings> settings)
+        private ChatClient CreateClient(List<GenAiSettings> settings)
         {
             if (settings == null || settings.Count == 0)
             {
                 throw new ArgumentNullException(nameof(settings));
             }
 
-            OpenAIClient? client = null;
+            ChatClient? client = null;        
 
             foreach (var setting in settings)
-            {
+            {               
+
+                var options = new AzureOpenAIClientOptions();
 
-                var options = new OpenAIClientOptions();
+                //options.Retry.MaxRetries = setting.MaxRetries;
+                //options.Retry.Delay = TimeSpan.FromSeconds(setting.RetryMinDelay);
+                //options.Retry.Mode = setting.ExponentialBackoff ? RetryMode.Exponential : RetryMode.Fixed;
+                //options.Retry.MaxDelay = TimeSpan.FromSeconds(setting.RetryMaxDelay);
 
-                options.Retry.MaxRetries = setting.MaxRetries;
-                options.Retry.Delay = TimeSpan.FromSeconds(setting.RetryMinDelay);
-                options.Retry.Mode = setting.ExponentialBackoff ? RetryMode.Exponential : RetryMode.Fixed;
-                options.Retry.MaxDelay = TimeSpan.FromSeconds(setting.RetryMaxDelay);
 
+                AzureOpenAIClient azureClient = new(new Uri(setting.Url), new AzureKeyCredential(setting.Key), options);
 
-                client = new OpenAIClient(new Uri(setting.Url),
-                new AzureKeyCredential(setting.Key), options);
+                client = azureClient.GetChatClient("");
 
-                _openAiClients.Add(new ClientDictionary<OpenAIClient>(setting.ClientId, client));
+                _openAiClients.Add(new ClientDictionary<ChatClient>(setting.ClientId, client));
             }
 
             return client;

Original file line number	Diff line number	Diff line change
`@@ -1,16 +1,17 @@`
`1`	`1`	`using Azure.AI.OpenAI;`
	`2`	`+using OpenAI.Chat;`
`2`	`3`
`3`	`4`	`namespace Liquid.ChatCompletions.OpenAi`
`4`	`5`	`{`
`5`	`6`	`/// <summary>`
`6`		`- /// Provide <see cref="OpenAIClient"/> generator methods.`
	`7`	`+ /// Provide <see cref="ChatClient"/> generator methods.`
`7`	`8`	`/// </summary>`
`8`	`9`	`public interface IOpenAiClientFactory`
`9`	`10`	`{`
`10`	`11`	`/// <summary>`
`11`		`- /// Provide a instance of <see cref="OpenAIClient"/> with conection started.`
	`12`	`+ /// Provide a instance of <see cref="ChatClient"/> with conection started.`
`12`	`13`	`/// </summary>`
`13`	`14`	`/// <param name="clientId">OpenAI connections alias.</param>`
`14`		`- OpenAIClient GetOpenAIClient(string clientId);`
	`15`	`+ ChatClient GetOpenAIClient(string clientId);`
`15`	`16`	`}`
`16`	`17`	`}`