Merge pull request #9 from cnblogs/add-missing-usage-metadata

fix: add missing usage metadata

Author: cnblogs-dudu

src/SemanticKernel.DashScope/DashScopeChatCompletionService.cs

@@ -30,7 +30,11 @@ public async Task<IReadOnlyList<ChatMessageContent>> GetChatMessageContentsAsync
         var chatMessages = chatHistory.ToChatMessages();
         var chatParameters = executionSettings?.ToChatParameters();
         var response = await _dashScopeClient.TextGeneration.Chat(_modelId, chatMessages, chatParameters, cancellationToken);
-        return [new ChatMessageContent(new AuthorRole(chatMessages[0].Role), response.Output.Text)];
+        var chatMessageContent = new ChatMessageContent(
+            new AuthorRole(chatMessages[0].Role),
+            response.Output.Text,
+            metadata: response.Usage.ToMetadata());
+        return [chatMessageContent];
     }
 
     public async IAsyncEnumerable<StreamingChatMessageContent> GetStreamingChatMessageContentsAsync(
@@ -44,10 +48,12 @@ public async IAsyncEnumerable<StreamingChatMessageContent> GetStreamingChatMessa
         chatParameters.IncrementalOutput = true;
 
         var responses = _dashScopeClient.TextGeneration.ChatStreamed(_modelId, chatMessages, chatParameters, cancellationToken);
-
         await foreach (var response in responses)
         {
-            yield return new StreamingChatMessageContent(new AuthorRole(chatMessages[0].Role), response.Output.Text);
+            yield return new StreamingChatMessageContent(
+                new AuthorRole(chatMessages[0].Role),
+                response.Output.Text,
+                metadata: response.Usage.ToMetadata());
         }
     }
 }

src/SemanticKernel.DashScope/Extensions/ChatTokenUsageExtensions.cs

@@ -0,0 +1,16 @@
+using Sdcb.DashScope.TextGeneration;
+
+namespace Cnblogs.SemanticKernel.Connectors.DashScope;
+
+public static class ChatTokenUsageExtensions
+{
+    public static IReadOnlyDictionary<string, object?>? ToMetadata(this ChatTokenUsage? usage)
+    {
+        return usage is null
+            ? null :
+            new Dictionary<string, object?>()
+            {
+                { "Usage",  usage }
+            };
+    }
+}

src/SemanticKernel.DashScope/SemanticKernel.DashScope.csproj

@@ -20,7 +20,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.SemanticKernel.Core" Version="1.3.0" />
+    <PackageReference Include="Microsoft.SemanticKernel.Core" Version="1.4.0" />
     <PackageReference Include="Sdcb.DashScope" Version="1.0.1" />
   </ItemGroup>
 

test/SemanticKernel.DashScope.IntegrationTest/ChatCompletionTests.cs

@@ -1,6 +1,7 @@
 using System.Diagnostics;
 using System.Text;
 using Microsoft.SemanticKernel;
+using Sdcb.DashScope.TextGeneration;
 
 namespace SemanticKernel.DashScope.IntegrationTest;
 
@@ -29,6 +30,7 @@ public async Task ChatCompletion_InvokePromptAsync_WorksCorrectly()
 
         // Assert
         Assert.Contains("博客园", result.ToString());
+        Assert.Equal(4, GetUsage(result.Metadata)?.InputTokens);
         Trace.WriteLine(result.ToString());
     }
 
@@ -46,11 +48,21 @@ public async Task ChatCompletion_InvokePromptStreamingAsync_WorksCorrectly()
 
         // Assert
         var sb = new StringBuilder();
-        await foreach (var message in result)
+        await foreach (var content in result)
         {
-            Trace.Write(message);
-            sb.Append(message);
+            Trace.Write(content);
+            sb.Append(content);
+            Assert.Equal(4, GetUsage(content.Metadata)?.InputTokens);
         }
         Assert.Contains("博客园", sb.ToString());
+
+    }
+
+    private static ChatTokenUsage? GetUsage(IReadOnlyDictionary<string, object?>? metadata)
+    {
+        return metadata?.TryGetValue("Usage", out var value) == true &&
+            value is ChatTokenUsage usage
+            ? usage
+            : null;
     }
 }