chore: add tool call sample

ikesnowy · ikesnowy · commit 9bb313b6eb03 · 2024-11-27T14:55:28.000+08:00
diff --git a/sample/Cnblogs.DashScope.Sample/Cnblogs.DashScope.Sample.csproj b/sample/Cnblogs.DashScope.Sample/Cnblogs.DashScope.Sample.csproj
@@ -19,4 +19,8 @@
       </None>
     </ItemGroup>
 
+    <ItemGroup>
+      <PackageReference Include="Microsoft.Extensions.AI" Version="9.0.1-preview.1.24570.5" />
+    </ItemGroup>
+
 </Project>
diff --git a/sample/Cnblogs.DashScope.Sample/Program.cs b/sample/Cnblogs.DashScope.Sample/Program.cs
@@ -8,8 +8,15 @@
 using Json.Schema.Generation;
 using Microsoft.Extensions.AI;
 
-const string apiKey = "sk-***";
-var dashScopeClient = new DashScopeClient(apiKey);
+Console.WriteLine("Reading key from environment variable DASHSCOPE_KEY");
+var apiKey = Environment.GetEnvironmentVariable("DASHSCOPE_API_KEY");
+if (string.IsNullOrEmpty(apiKey))
+{
+    Console.Write("ApiKey > ");
+    apiKey = Console.ReadLine();
+}
+
+var dashScopeClient = new DashScopeClient(apiKey!);
 
 Console.WriteLine("Choose the sample you want to run:");
 foreach (var sampleType in Enum.GetValues<SampleType>())
@@ -46,6 +53,9 @@
     case SampleType.MicrosoftExtensionsAi:
         await ChatWithMicrosoftExtensions();
         break;
+    case SampleType.MicrosoftExtensionsAiToolCall:
+        await dashScopeClient.ToolCallWithExtensionAsync();
+        break;
 }
 
 return;
diff --git a/sample/Cnblogs.DashScope.Sample/SampleType.cs b/sample/Cnblogs.DashScope.Sample/SampleType.cs
@@ -1,24 +1,18 @@
-﻿using System.ComponentModel;
-
-namespace Cnblogs.DashScope.Sample;
+﻿namespace Cnblogs.DashScope.Sample;
 
 public enum SampleType
 {
-    [Description("Simple prompt completion")]
     TextCompletion,
 
-    [Description("Simple prompt completion with incremental output")]
     TextCompletionSse,
 
-    [Description("Conversation between user and assistant")]
     ChatCompletion,
 
-    [Description("Conversation with tools")]
     ChatCompletionWithTool,
 
-    [Description("Conversation with files")]
     ChatCompletionWithFiles,
 
-    [Description("Completion with Microsoft.Extensions.AI")]
-    MicrosoftExtensionsAi
+    MicrosoftExtensionsAi,
+
+    MicrosoftExtensionsAiToolCall
 }
diff --git a/sample/Cnblogs.DashScope.Sample/SampleTypeDescriptor.cs b/sample/Cnblogs.DashScope.Sample/SampleTypeDescriptor.cs
@@ -12,6 +12,7 @@ public static string GetDescription(this SampleType sampleType)
             SampleType.ChatCompletionWithTool => "Function call sample",
             SampleType.ChatCompletionWithFiles => "File upload sample using qwen-long",
             SampleType.MicrosoftExtensionsAi => "Use with Microsoft.Extensions.AI",
+            SampleType.MicrosoftExtensionsAiToolCall => "Use tool call with Microsoft.Extensions.AI interfaces",
             _ => throw new ArgumentOutOfRangeException(nameof(sampleType), sampleType, "Unsupported sample option")
         };
     }
diff --git a/sample/Cnblogs.DashScope.Sample/ToolCallWithExtensions.cs b/sample/Cnblogs.DashScope.Sample/ToolCallWithExtensions.cs
@@ -0,0 +1,25 @@
+﻿using System.ComponentModel;
+using System.Text.Json;
+using Cnblogs.DashScope.Core;
+using Microsoft.Extensions.AI;
+
+namespace Cnblogs.DashScope.Sample;
+
+public static class ToolCallWithExtensions
+{
+    public static async Task ToolCallWithExtensionAsync(this IDashScopeClient dashScopeClient)
+    {
+        [Description("Gets the weather")]
+        string GetWeather() => Random.Shared.NextDouble() > 0.5 ? "It's sunny" : "It's raining";
+
+        var chatOptions = new ChatOptions { Tools = [AIFunctionFactory.Create(GetWeather)] };
+
+        var client = dashScopeClient.AsChatClient("qwen-max").AsBuilder().UseFunctionInvocation().Build();
+        await foreach (var message in client.CompleteStreamingAsync("What is weather today?", chatOptions))
+        {
+            Console.WriteLine(JsonSerializer.Serialize(message));
+        }
+
+        Console.WriteLine();
+    }
+}
diff --git a/src/Cnblogs.Extensions.AI.DashScope/DashScopeChatClient.cs b/src/Cnblogs.Extensions.AI.DashScope/DashScopeChatClient.cs
@@ -113,7 +113,7 @@ public async Task<ChatCompletion> CompleteAsync(
                 CompletionId = response.RequestId,
                 CreatedAt = DateTimeOffset.Now,
                 ModelId = modelId,
-                FinishReason = ToFinishReason(response.Output.FinishReason),
+                FinishReason = ToFinishReason(response.Output.Choices[0].FinishReason),
             };
 
             if (response.Usage != null)
@@ -214,59 +214,61 @@ public async IAsyncEnumerable<StreamingChatCompletionUpdate> CompleteStreamingAs
                     ModelId = completion.ModelId,
                 };
             }
-
-            var parameters = ToTextGenerationParameters(options) ?? DefaultTextGenerationParameter;
-            parameters.IncrementalOutput = true;
-            var stream = _dashScopeClient.GetTextCompletionStreamAsync(
-                new ModelRequest<TextGenerationInput, ITextGenerationParameters>()
-                {
-                    Input = new TextGenerationInput
+            else
+            {
+                var parameters = ToTextGenerationParameters(options) ?? DefaultTextGenerationParameter;
+                parameters.IncrementalOutput = true;
+                var stream = _dashScopeClient.GetTextCompletionStreamAsync(
+                    new ModelRequest<TextGenerationInput, ITextGenerationParameters>()
                     {
-                        Messages = chatMessages.SelectMany(
-                            c => ToTextChatMessages(c, parameters.Tools?.ToList())),
-                        Tools = ToToolDefinitions(options?.Tools)
+                        Input = new TextGenerationInput
+                        {
+                            Messages = chatMessages.SelectMany(
+                                c => ToTextChatMessages(c, parameters.Tools?.ToList())),
+                            Tools = ToToolDefinitions(options?.Tools)
+                        },
+                        Model = modelId,
+                        Parameters = parameters
                     },
-                    Model = modelId,
-                    Parameters = parameters
-                },
-                cancellationToken);
-            await foreach (var response in stream)
-            {
-                streamedRole ??= string.IsNullOrEmpty(response.Output.Choices?.FirstOrDefault()?.Message.Role)
-                    ? null
-                    : ToChatRole(response.Output.Choices[0].Message.Role);
-                finishReason ??= string.IsNullOrEmpty(response.Output.Choices?.FirstOrDefault()?.FinishReason)
-                    ? null
-                    : ToFinishReason(response.Output.Choices[0].FinishReason);
-                completionId ??= response.RequestId;
-
-                var update = new StreamingChatCompletionUpdate()
+                    cancellationToken);
+                await foreach (var response in stream)
                 {
-                    CompletionId = completionId,
-                    CreatedAt = DateTimeOffset.Now,
-                    FinishReason = finishReason,
-                    ModelId = modelId,
-                    RawRepresentation = response,
-                    Role = streamedRole
-                };
+                    streamedRole ??= string.IsNullOrEmpty(response.Output.Choices?.FirstOrDefault()?.Message.Role)
+                        ? null
+                        : ToChatRole(response.Output.Choices[0].Message.Role);
+                    finishReason ??= string.IsNullOrEmpty(response.Output.Choices?.FirstOrDefault()?.FinishReason)
+                        ? null
+                        : ToFinishReason(response.Output.Choices[0].FinishReason);
+                    completionId ??= response.RequestId;
 
-                if (response.Output.Choices?.FirstOrDefault()?.Message.Content is { Length: > 0 })
-                {
-                    update.Contents.Add(new TextContent(response.Output.Choices[0].Message.Content));
-                }
+                    var update = new StreamingChatCompletionUpdate()
+                    {
+                        CompletionId = completionId,
+                        CreatedAt = DateTimeOffset.Now,
+                        FinishReason = finishReason,
+                        ModelId = modelId,
+                        RawRepresentation = response,
+                        Role = streamedRole
+                    };
+
+                    if (response.Output.Choices?.FirstOrDefault()?.Message.Content is { Length: > 0 })
+                    {
+                        update.Contents.Add(new TextContent(response.Output.Choices[0].Message.Content));
+                    }
 
-                if (response.Usage != null)
-                {
-                    update.Contents.Add(
-                        new UsageContent(
-                            new UsageDetails()
-                            {
-                                InputTokenCount = response.Usage.InputTokens,
-                                OutputTokenCount = response.Usage.OutputTokens,
-                            }));
-                }
+                    if (response.Usage != null)
+                    {
+                        update.Contents.Add(
+                            new UsageContent(
+                                new UsageDetails()
+                                {
+                                    InputTokenCount = response.Usage.InputTokens,
+                                    OutputTokenCount = response.Usage.OutputTokens,
+                                }));
+                    }
 
-                yield return update;
+                    yield return update;
+                }
             }
         }
     }
diff --git a/src/Cnblogs.Extensions.AI.DashScope/DashScopeClientExtensions.cs b/src/Cnblogs.Extensions.AI.DashScope/DashScopeClientExtensions.cs
@@ -23,6 +23,6 @@ public static IChatClient AsChatClient(this IDashScopeClient dashScopeClient, st
     public static IEmbeddingGenerator<string, Embedding<float>> AsEmbeddingGenerator(
         this IDashScopeClient dashScopeClient,
         string modelId,
-        int? dimensions)
+        int? dimensions = null)
         => new DashScopeTextEmbeddingGenerator(dashScopeClient, modelId, dimensions);
 }
diff --git a/test/Cnblogs.DashScope.Sdk.UnitTests/ChatClientTests.cs b/test/Cnblogs.DashScope.Sdk.UnitTests/ChatClientTests.cs
@@ -44,7 +44,7 @@ public async Task ChatClient_TextCompletion_SuccessAsync()
         // Assert
         _ = dashScopeClient.Received().GetTextCompletionAsync(
             Arg.Is<ModelRequest<TextGenerationInput, ITextGenerationParameters>>(
-                m => IsEquivalent(m, testCase.RequestModel)),
+                m => m.IsEquivalent(testCase.RequestModel)),
             Arg.Any<CancellationToken>());
         response.Message.Text.Should().Be(testCase.ResponseModel.Output.Choices?.First().Message.Content);
     }
@@ -53,7 +53,6 @@ public async Task ChatClient_TextCompletion_SuccessAsync()
     public async Task ChatClient_TextCompletionStream_SuccessAsync()
     {
         // Arrange
-        const bool sse = true;
         var testCase = Snapshots.TextGeneration.MessageFormat.SingleMessageChatClientIncremental;
         var dashScopeClient = Substitute.For<IDashScopeClient>();
         var returnThis = new[] { testCase.ResponseModel }.ToAsyncEnumerable();
@@ -92,7 +91,7 @@ public async Task ChatClient_TextCompletionStream_SuccessAsync()
         // Assert
         _ = dashScopeClient.Received().GetTextCompletionStreamAsync(
             Arg.Is<ModelRequest<TextGenerationInput, ITextGenerationParameters>>(
-                m => IsEquivalent(m, testCase.RequestModel)),
+                m => m.IsEquivalent(testCase.RequestModel)),
             Arg.Any<CancellationToken>());
         text.ToString().Should().Be(testCase.ResponseModel.Output.Choices?.First().Message.Content);
     }
@@ -101,7 +100,6 @@ public async Task ChatClient_TextCompletionStream_SuccessAsync()
     public async Task ChatClient_ImageRecognition_SuccessAsync()
     {
         // Arrange
-        const bool sse = false;
         var testCase = Snapshots.MultimodalGeneration.VlChatClientNoSse;
         var dashScopeClient = Substitute.For<IDashScopeClient>();
         dashScopeClient.Configure()
@@ -136,7 +134,7 @@ public async Task ChatClient_ImageRecognition_SuccessAsync()
 
         // Assert
         await dashScopeClient.Received().GetMultimodalGenerationAsync(
-            Arg.Is<ModelRequest<MultimodalInput, IMultimodalParameters>>(m => IsEquivalent(m, testCase.RequestModel)),
+            Arg.Is<ModelRequest<MultimodalInput, IMultimodalParameters>>(m => m.IsEquivalent(testCase.RequestModel)),
             Arg.Any<CancellationToken>());
         response.Choices[0].Text.Should()
             .BeEquivalentTo(testCase.ResponseModel.Output.Choices[0].Message.Content[0].Text);
@@ -146,7 +144,6 @@ await dashScopeClient.Received().GetMultimodalGenerationAsync(
     public async Task ChatClient_ImageRecognitionStream_SuccessAsync()
     {
         // Arrange
-        const bool sse = true;
         var testCase = Snapshots.MultimodalGeneration.VlChatClientSse;
         var dashScopeClient = Substitute.For<IDashScopeClient>();
         dashScopeClient.Configure()
@@ -186,22 +183,8 @@ public async Task ChatClient_ImageRecognitionStream_SuccessAsync()
 
         // Assert
         _ = dashScopeClient.Received().GetMultimodalGenerationStreamAsync(
-            Arg.Is<ModelRequest<MultimodalInput, IMultimodalParameters>>(m => IsEquivalent(m, testCase.RequestModel)),
+            Arg.Is<ModelRequest<MultimodalInput, IMultimodalParameters>>(m => m.IsEquivalent(testCase.RequestModel)),
             Arg.Any<CancellationToken>());
         text.ToString().Should().Be(testCase.ResponseModel.Output.Choices.First().Message.Content[0].Text);
     }
-
-    private bool IsEquivalent<T>(T left, T right)
-    {
-        try
-        {
-            left.Should().BeEquivalentTo(right);
-        }
-        catch (Exception e)
-        {
-            return false;
-        }
-
-        return true;
-    }
 }
diff --git a/test/Cnblogs.DashScope.Sdk.UnitTests/EmbeddingClientTests.cs b/test/Cnblogs.DashScope.Sdk.UnitTests/EmbeddingClientTests.cs
@@ -0,0 +1,43 @@
+﻿using Cnblogs.DashScope.Core;
+using Cnblogs.DashScope.Sdk.UnitTests.Utils;
+using FluentAssertions;
+using Microsoft.Extensions.AI;
+using NSubstitute;
+using NSubstitute.Extensions;
+
+namespace Cnblogs.DashScope.Sdk.UnitTests;
+
+public class EmbeddingClientTests
+{
+    [Fact]
+    public async Task EmbeddingClient_Text_SuccessAsync()
+    {
+        // Arrange
+        var testCase = Snapshots.TextEmbedding.EmbeddingClientNoSse;
+        var dashScopeClient = Substitute.For<IDashScopeClient>();
+        dashScopeClient.Configure()
+            .GetEmbeddingsAsync(
+                Arg.Any<ModelRequest<TextEmbeddingInput, ITextEmbeddingParameters>>(),
+                Arg.Any<CancellationToken>())
+            .Returns(Task.FromResult(testCase.ResponseModel));
+        var client = dashScopeClient.AsEmbeddingGenerator(testCase.RequestModel.Model, 1024);
+        var content = testCase.RequestModel.Input.Texts.ToList();
+        var parameter = testCase.RequestModel.Parameters;
+
+        // Act
+        var response = await client.GenerateAsync(
+            content,
+            new EmbeddingGenerationOptions()
+            {
+                ModelId = testCase.RequestModel.Model, Dimensions = parameter?.Dimension
+            });
+
+        // Assert
+        _ = dashScopeClient.Received().GetEmbeddingsAsync(
+            Arg.Is<ModelRequest<TextEmbeddingInput, ITextEmbeddingParameters>>(
+                m => m.IsEquivalent(testCase.RequestModel)),
+            Arg.Any<CancellationToken>());
+        response.Select(x => x.Vector.ToArray()).Should()
+            .BeEquivalentTo(testCase.ResponseModel.Output.Embeddings.Select(x => x.Embedding));
+    }
+}
diff --git a/test/Cnblogs.DashScope.Sdk.UnitTests/Utils/EquivalentUtils.cs b/test/Cnblogs.DashScope.Sdk.UnitTests/Utils/EquivalentUtils.cs
@@ -0,0 +1,20 @@
+﻿using FluentAssertions;
+
+namespace Cnblogs.DashScope.Sdk.UnitTests.Utils;
+
+public static class EquivalentUtils
+{
+    internal static bool IsEquivalent<T>(this T left, T right)
+    {
+        try
+        {
+            left.Should().BeEquivalentTo(right);
+        }
+        catch (Exception)
+        {
+            return false;
+        }
+
+        return true;
+    }
+}
diff --git a/test/Cnblogs.DashScope.Sdk.UnitTests/Utils/Snapshots.cs b/test/Cnblogs.DashScope.Sdk.UnitTests/Utils/Snapshots.cs
@@ -1240,6 +1240,22 @@ public static class TextEmbedding
                 Usage = new TextEmbeddingTokenUsage(3)
             });
 
+        public static readonly RequestSnapshot<ModelRequest<TextEmbeddingInput, ITextEmbeddingParameters>,
+            ModelResponse<TextEmbeddingOutput, TextEmbeddingTokenUsage>> EmbeddingClientNoSse = new(
+            "text-embedding",
+            new ModelRequest<TextEmbeddingInput, ITextEmbeddingParameters>
+            {
+                Input = new TextEmbeddingInput { Texts = ["代码改变世界"] },
+                Model = "text-embedding-v3",
+                Parameters = new TextEmbeddingParameters { Dimension = 1024 }
+            },
+            new ModelResponse<TextEmbeddingOutput, TextEmbeddingTokenUsage>
+            {
+                Output = new TextEmbeddingOutput([new TextEmbeddingItem(0, [])]),
+                RequestId = "1773f7b2-2148-9f74-b335-b413e398a116",
+                Usage = new TextEmbeddingTokenUsage(3)
+            });
+
         public static readonly
             RequestSnapshot<ModelRequest<BatchGetEmbeddingsInput, IBatchGetEmbeddingsParameters>,
                 ModelResponse<BatchGetEmbeddingsOutput, TextEmbeddingTokenUsage>> BatchNoSse = new(

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ public static string GetDescription(this SampleType sampleType)`
`12`	`12`	`SampleType.ChatCompletionWithTool => "Function call sample",`
`13`	`13`	`SampleType.ChatCompletionWithFiles => "File upload sample using qwen-long",`
`14`	`14`	`SampleType.MicrosoftExtensionsAi => "Use with Microsoft.Extensions.AI",`
	`15`	`+ SampleType.MicrosoftExtensionsAiToolCall => "Use tool call with Microsoft.Extensions.AI interfaces",`
`15`	`16`	`_ => throw new ArgumentOutOfRangeException(nameof(sampleType), sampleType, "Unsupported sample option")`
`16`	`17`	`};`
`17`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,6 @@ public static IChatClient AsChatClient(this IDashScopeClient dashScopeClient, st`
`23`	`23`	`public static IEmbeddingGenerator<string, Embedding<float>> AsEmbeddingGenerator(`
`24`	`24`	`this IDashScopeClient dashScopeClient,`
`25`	`25`	`string modelId,`
`26`		`- int? dimensions)`
	`26`	`+ int? dimensions = null)`
`27`	`27`	`=> new DashScopeTextEmbeddingGenerator(dashScopeClient, modelId, dimensions);`
`28`	`28`	`}`