refactor!: rename ChatMessage to TextChatMessage

Author: ikesnowy

sample/Cnblogs.DashScope.Sample/Program.cs

@@ -7,7 +7,6 @@
 using Json.Schema;
 using Json.Schema.Generation;
 using Microsoft.Extensions.AI;
-using ChatMessage = Cnblogs.DashScope.Core.ChatMessage;
 
 const string apiKey = "sk-***";
 var dashScopeClient = new DashScopeClient(apiKey);
@@ -73,12 +72,12 @@ async Task TextCompletionStreamAsync(string prompt)
 
 async Task ChatStreamAsync()
 {
-    var history = new List<ChatMessage>();
+    var history = new List<TextChatMessage>();
     while (true)
     {
         Console.Write("user > ");
         var input = Console.ReadLine()!;
-        history.Add(ChatMessage.User(input));
+        history.Add(TextChatMessage.User(input));
         var stream = dashScopeClient
             .GetQWenChatStreamAsync(
                 QWenLlm.QWenMax,
@@ -100,25 +99,25 @@ async Task ChatStreamAsync()
         }
 
         Console.WriteLine();
-        history.Add(new ChatMessage(role, message.ToString()));
+        history.Add(new TextChatMessage(role, message.ToString()));
     }
 
     // ReSharper disable once FunctionNeverReturns
 }
 
 async Task ChatWithFilesAsync()
 {
-    var history = new List<ChatMessage>();
+    var history = new List<TextChatMessage>();
     Console.WriteLine("uploading file \"test.txt\" ");
     var file = new FileInfo("test.txt");
     var uploadedFile = await dashScopeClient.UploadFileAsync(file.OpenRead(), file.Name);
     Console.WriteLine("file uploaded, id: " + uploadedFile.Id);
     Console.WriteLine();
 
-    var fileMessage = ChatMessage.File(uploadedFile.Id);
+    var fileMessage = TextChatMessage.File(uploadedFile.Id);
     history.Add(fileMessage);
     Console.WriteLine("system > " + fileMessage.Content);
-    var userPrompt = ChatMessage.User("该文件的内容是什么");
+    var userPrompt = TextChatMessage.User("该文件的内容是什么");
     history.Add(userPrompt);
     Console.WriteLine("user > " + userPrompt.Content);
     var stream = dashScopeClient.GetQWenChatStreamAsync(
@@ -141,7 +140,7 @@ async Task ChatWithFilesAsync()
     }
 
     Console.WriteLine();
-    history.Add(new ChatMessage(role, message.ToString()));
+    history.Add(new TextChatMessage(role, message.ToString()));
 
     Console.WriteLine();
     Console.WriteLine("Deleting file by id: " + uploadedFile.Id);
@@ -151,7 +150,7 @@ async Task ChatWithFilesAsync()
 
 async Task ChatWithToolsAsync()
 {
-    var history = new List<ChatMessage>();
+    var history = new List<TextChatMessage>();
     var tools = new List<ToolDefinition>
     {
         new(
@@ -162,7 +161,7 @@ async Task ChatWithToolsAsync()
                 new JsonSchemaBuilder().FromType<WeatherReportParameters>().Build()))
     };
     var chatParameters = new TextGenerationParameters() { ResultFormat = ResultFormats.Message, Tools = tools };
-    var question = ChatMessage.User("请问现在杭州的天气如何？");
+    var question = TextChatMessage.User("请问现在杭州的天气如何？");
     history.Add(question);
     Console.WriteLine($"{question.Role} > {question.Content}");
 
@@ -174,7 +173,7 @@ async Task ChatWithToolsAsync()
 
     var toolResponse = GetWeather(
         JsonSerializer.Deserialize<WeatherReportParameters>(toolCallMessage.ToolCalls[0].Function.Arguments!)!);
-    var toolMessage = ChatMessage.Tool(toolResponse, nameof(GetWeather));
+    var toolMessage = TextChatMessage.Tool(toolResponse, nameof(GetWeather));
     history.Add(toolMessage);
     Console.WriteLine($"{toolMessage.Role} > {toolMessage.Content}");
 

src/Cnblogs.DashScope.Core/ChatMessage.cs renamed to src/Cnblogs.DashScope.Core/TextChatMessage.cs

@@ -12,7 +12,7 @@ namespace Cnblogs.DashScope.Core;
 /// <param name="Partial">Notify model that next message should use this message as prefix.</param>
 /// <param name="ToolCalls">Calls to the function.</param>
 [method: JsonConstructor]
-public record ChatMessage(
+public record TextChatMessage(
     string Role,
     string Content,
     string? Name = null,
@@ -23,7 +23,7 @@ public record ChatMessage(
     /// Create chat message from an uploaded DashScope file.
     /// </summary>
     /// <param name="fileId">The id of the file.</param>
-    public ChatMessage(DashScopeFileId fileId)
+    public TextChatMessage(DashScopeFileId fileId)
         : this("system", fileId.ToUrl())
     {
     }
@@ -32,7 +32,7 @@ public ChatMessage(DashScopeFileId fileId)
     /// Create chat message from multiple DashScope file.
     /// </summary>
     /// <param name="fileIds">Ids of the files.</param>
-    public ChatMessage(IEnumerable<DashScopeFileId> fileIds)
+    public TextChatMessage(IEnumerable<DashScopeFileId> fileIds)
         : this("system", string.Join(',', fileIds.Select(f => f.ToUrl())))
     {
     }
@@ -42,19 +42,19 @@ public ChatMessage(IEnumerable<DashScopeFileId> fileIds)
     /// </summary>
     /// <param name="fileId">The id of the file.</param>
     /// <returns></returns>
-    public static ChatMessage File(DashScopeFileId fileId)
+    public static TextChatMessage File(DashScopeFileId fileId)
     {
-        return new ChatMessage(fileId);
+        return new TextChatMessage(fileId);
     }
 
     /// <summary>
     /// Creates a file message.
     /// </summary>
     /// <param name="fileIds">The file id list.</param>
     /// <returns></returns>
-    public static ChatMessage File(IEnumerable<DashScopeFileId> fileIds)
+    public static TextChatMessage File(IEnumerable<DashScopeFileId> fileIds)
     {
-        return new ChatMessage(fileIds);
+        return new TextChatMessage(fileIds);
     }
 
     /// <summary>
@@ -63,19 +63,19 @@ public static ChatMessage File(IEnumerable<DashScopeFileId> fileIds)
     /// <param name="content">Content of the message.</param>
     /// <param name="name">Author name.</param>
     /// <returns></returns>
-    public static ChatMessage User(string content, string? name = null)
+    public static TextChatMessage User(string content, string? name = null)
     {
-        return new ChatMessage(DashScopeRoleNames.User, content, name);
+        return new TextChatMessage(DashScopeRoleNames.User, content, name);
     }
 
     /// <summary>
     /// Create a system message.
     /// </summary>
     /// <param name="content">The content of the message.</param>
     /// <returns></returns>
-    public static ChatMessage System(string content)
+    public static TextChatMessage System(string content)
     {
-        return new ChatMessage(DashScopeRoleNames.System, content);
+        return new TextChatMessage(DashScopeRoleNames.System, content);
     }
 
     /// <summary>
@@ -86,9 +86,9 @@ public static ChatMessage System(string content)
     /// <param name="name">Author name.</param>
     /// <param name="toolCalls">Tool calls by model.</param>
     /// <returns></returns>
-    public static ChatMessage Assistant(string content, bool? partial = null, string? name = null, List<ToolCall>? toolCalls = null)
+    public static TextChatMessage Assistant(string content, bool? partial = null, string? name = null, List<ToolCall>? toolCalls = null)
     {
-        return new ChatMessage(DashScopeRoleNames.Assistant, content, name, partial, toolCalls);
+        return new TextChatMessage(DashScopeRoleNames.Assistant, content, name, partial, toolCalls);
     }
 
     /// <summary>
@@ -97,8 +97,8 @@ public static ChatMessage Assistant(string content, bool? partial = null, string
     /// <param name="content">The output from tool.</param>
     /// <param name="name">The name of the tool.</param>
     /// <returns></returns>
-    public static ChatMessage Tool(string content, string? name = null)
+    public static TextChatMessage Tool(string content, string? name = null)
     {
-        return new ChatMessage(DashScopeRoleNames.Tool, content, name);
+        return new TextChatMessage(DashScopeRoleNames.Tool, content, name);
     }
 }

src/Cnblogs.DashScope.Core/TextGenerationChoice.cs

@@ -13,5 +13,5 @@ public class TextGenerationChoice
     /// <summary>
     /// The generated message.
     /// </summary>
-    public required ChatMessage Message { get; set; }
+    public required TextChatMessage Message { get; set; }
 }

src/Cnblogs.DashScope.Core/TextGenerationInput.cs

@@ -13,7 +13,7 @@ public class TextGenerationInput
     /// <summary>
     /// The collection of context messages associated with this chat completions request.
     /// </summary>
-    public IEnumerable<ChatMessage>? Messages { get; set; }
+    public IEnumerable<TextChatMessage>? Messages { get; set; }
 
     /// <summary>
     /// Available tools for model to use.

src/Cnblogs.DashScope.Sdk/BaiChuan/BaiChuanTextGenerationApi.cs

@@ -54,7 +54,7 @@ public static Task<ModelResponse<TextGenerationOutput, TextGenerationTokenUsage>
     public static Task<ModelResponse<TextGenerationOutput, TextGenerationTokenUsage>> GetBaiChuanTextCompletionAsync(
         this IDashScopeClient client,
         BaiChuan2Llm llm,
-        IEnumerable<ChatMessage> messages,
+        IEnumerable<TextChatMessage> messages,
         string? resultFormat = null)
     {
         return client.GetBaiChuanTextCompletionAsync(llm.GetModelName(), messages, resultFormat);
@@ -71,7 +71,7 @@ public static Task<ModelResponse<TextGenerationOutput, TextGenerationTokenUsage>
     public static Task<ModelResponse<TextGenerationOutput, TextGenerationTokenUsage>> GetBaiChuanTextCompletionAsync(
         this IDashScopeClient client,
         string llm,
-        IEnumerable<ChatMessage> messages,
+        IEnumerable<TextChatMessage> messages,
         string? resultFormat = null)
     {
         return client.GetTextCompletionAsync(

src/Cnblogs.DashScope.Sdk/Llama2/Llama2TextGenerationApi.cs

@@ -19,7 +19,7 @@ public static async Task<ModelResponse<TextGenerationOutput, TextGenerationToken
         GetLlama2TextCompletionAsync(
             this IDashScopeClient client,
             Llama2Model model,
-            IEnumerable<ChatMessage> messages,
+            IEnumerable<TextChatMessage> messages,
             string? resultFormat = null)
     {
         return await client.GetLlama2TextCompletionAsync(model.GetModelName(), messages, resultFormat);
@@ -37,7 +37,7 @@ public static async Task<ModelResponse<TextGenerationOutput, TextGenerationToken
         GetLlama2TextCompletionAsync(
             this IDashScopeClient client,
             string model,
-            IEnumerable<ChatMessage> messages,
+            IEnumerable<TextChatMessage> messages,
             string? resultFormat = null)
     {
         return await client.GetTextCompletionAsync(

src/Cnblogs.DashScope.Sdk/QWen/QWenTextGenerationApi.cs

@@ -20,7 +20,7 @@ public static class QWenTextGenerationApi
     public static IAsyncEnumerable<ModelResponse<TextGenerationOutput, TextGenerationTokenUsage>> GetQWenChatStreamAsync(
         this IDashScopeClient dashScopeClient,
         QWenLlm model,
-        IEnumerable<ChatMessage> messages,
+        IEnumerable<TextChatMessage> messages,
         TextGenerationParameters? parameters = null,
         CancellationToken cancellationToken = default)
     {
@@ -48,7 +48,7 @@ public static IAsyncEnumerable<ModelResponse<TextGenerationOutput, TextGeneratio
     public static IAsyncEnumerable<ModelResponse<TextGenerationOutput, TextGenerationTokenUsage>> GetQWenChatStreamAsync(
         this IDashScopeClient dashScopeClient,
         string model,
-        IEnumerable<ChatMessage> messages,
+        IEnumerable<TextChatMessage> messages,
         TextGenerationParameters? parameters = null,
         CancellationToken cancellationToken = default)
     {
@@ -75,7 +75,7 @@ public static IAsyncEnumerable<ModelResponse<TextGenerationOutput, TextGeneratio
     public static Task<ModelResponse<TextGenerationOutput, TextGenerationTokenUsage>> GetQWenChatCompletionAsync(
         this IDashScopeClient dashScopeClient,
         QWenLlm model,
-        IEnumerable<ChatMessage> messages,
+        IEnumerable<TextChatMessage> messages,
         TextGenerationParameters? parameters = null,
         CancellationToken cancellationToken = default)
     {
@@ -99,7 +99,7 @@ public static Task<ModelResponse<TextGenerationOutput, TextGenerationTokenUsage>
     public static Task<ModelResponse<TextGenerationOutput, TextGenerationTokenUsage>> GetQWenChatCompletionAsync(
         this IDashScopeClient dashScopeClient,
         string model,
-        IEnumerable<ChatMessage> messages,
+        IEnumerable<TextChatMessage> messages,
         TextGenerationParameters? parameters = null,
         CancellationToken cancellationToken = default)
     {

src/Cnblogs.Extensions.AI.DashScope/DashScopeChatClient.cs

@@ -300,7 +300,7 @@ public void Dispose()
                 _ => new ChatFinishReason(finishReason),
             };
 
-    private static ChatMessage ToChatMessage(Cnblogs.DashScope.Core.ChatMessage message)
+    private static ChatMessage ToChatMessage(TextChatMessage message)
     {
         var returnMessage = new ChatMessage()
         {
@@ -415,13 +415,13 @@ private List<MultimodalMessageContent> ToMultimodalMessageContents(IList<AIConte
         return mapped;
     }
 
-    private IEnumerable<Cnblogs.DashScope.Core.ChatMessage> ToTextChatMessages(
+    private IEnumerable<TextChatMessage> ToTextChatMessages(
         ChatMessage from,
         List<ToolDefinition>? tools)
     {
         if (from.Role == ChatRole.System || from.Role == ChatRole.User)
         {
-            yield return new Cnblogs.DashScope.Core.ChatMessage(
+            yield return new TextChatMessage(
                 from.Role.Value,
                 from.Text ?? string.Empty,
                 from.AuthorName);
@@ -445,7 +445,7 @@ private List<MultimodalMessageContent> ToMultimodalMessageContents(IList<AIConte
                         }
                     }
 
-                    yield return new Cnblogs.DashScope.Core.ChatMessage(from.Role.Value, result ?? string.Empty);
+                    yield return new TextChatMessage(from.Role.Value, result ?? string.Empty);
                 }
             }
         }
@@ -460,7 +460,7 @@ private List<MultimodalMessageContent> ToMultimodalMessageContents(IList<AIConte
                         tools?.FindIndex(f => f.Function?.Name == c.Name) ?? -1,
                         new FunctionCall(c.Name, JsonSerializer.Serialize(c.Arguments, ToolCallJsonSerializerOptions))))
                 .ToList();
-            yield return new Cnblogs.DashScope.Core.ChatMessage(
+            yield return new TextChatMessage(
                 from.Role.Value,
                 from.Text ?? string.Empty,
                 from.AuthorName,

test/Cnblogs.DashScope.Sdk.UnitTests/ChatClientTests.cs

@@ -0,0 +1,75 @@
+using System.Text;
+using Cnblogs.DashScope.Sdk.UnitTests.Utils;
+using FluentAssertions;
+using Microsoft.Extensions.AI;
+using NSubstitute;
+
+namespace Cnblogs.DashScope.Sdk.UnitTests;
+
+public class ChatClientTests
+{
+    [Fact]
+    public async Task ChatClient_TextCompletion_SuccessAsync()
+    {
+        // Arrange
+        const bool sse = false;
+        var testCase = Snapshots.TextGeneration.MessageFormat.SingleMessage;
+        var (dashScopeClient, handler) = await Sut.GetTestClientAsync(sse, testCase);
+        var client = dashScopeClient.AsChatClient(testCase.RequestModel.Model);
+        var content = testCase.RequestModel.Input.Messages!.First().Content;
+        var parameter = testCase.RequestModel.Parameters;
+
+        // Act
+        var response = await client.CompleteAsync(
+            content,
+            new ChatOptions()
+            {
+                FrequencyPenalty = parameter?.RepetitionPenalty,
+                ModelId = testCase.RequestModel.Model,
+                MaxOutputTokens = parameter?.MaxTokens,
+                Seed = (long?)parameter?.Seed,
+                Temperature = parameter?.Temperature,
+            });
+
+        // Assert
+        handler.Received().MockSend(
+            Arg.Any<HttpRequestMessage>(),
+            Arg.Any<CancellationToken>());
+        response.Message.Text.Should().Be(testCase.ResponseModel.Output.Choices?.First().Message.Content);
+    }
+
+    [Fact]
+    public async Task ChatClient_TextCompletionStream_SuccessAsync()
+    {
+        // Arrange
+        const bool sse = true;
+        var testCase = Snapshots.TextGeneration.MessageFormat.SingleMessageIncremental;
+        var (dashScopeClient, handler) = await Sut.GetTestClientAsync(sse, testCase);
+        var client = dashScopeClient.AsChatClient(testCase.RequestModel.Model);
+        var content = testCase.RequestModel.Input.Messages!.First().Content;
+        var parameter = testCase.RequestModel.Parameters;
+
+        // Act
+        var response = client.CompleteStreamingAsync(
+            content,
+            new ChatOptions()
+            {
+                FrequencyPenalty = parameter?.RepetitionPenalty,
+                ModelId = testCase.RequestModel.Model,
+                MaxOutputTokens = parameter?.MaxTokens,
+                Seed = (long?)parameter?.Seed,
+                Temperature = parameter?.Temperature,
+            });
+        var text = new StringBuilder();
+        await foreach (var update in response)
+        {
+            text.Append(update.Text);
+        }
+
+        // Assert
+        handler.Received().MockSend(
+            Arg.Any<HttpRequestMessage>(),
+            Arg.Any<CancellationToken>());
+        text.ToString().Should().Be(testCase.ResponseModel.Output.Choices?.First().Message.Content);
+    }
+}