Merge pull request #9 from cnblogs/supports-tools-in-text-completion

feat: support tools in text generation

Author: ikesnowy

src/Cnblogs.DashScope.Sdk/ChatMessage.cs

@@ -5,4 +5,7 @@ namespace Cnblogs.DashScope.Sdk;
 /// <summary>
 /// Represents a chat message between the user and the model.
 /// </summary>
-public record ChatMessage(string Role, string Content) : IMessage<string>;
+/// <param name="Role">The role of this message.</param>
+/// <param name="Content">The content of this message.</param>
+/// <param name="ToolCalls">Calls to the function.</param>
+public record ChatMessage(string Role, string Content, List<ToolCall>? ToolCalls = null) : IMessage<string>;

src/Cnblogs.DashScope.Sdk/Cnblogs.DashScope.Sdk.csproj

@@ -4,4 +4,7 @@
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <PackageTags>Cnblogs;Dashscope;AI;Sdk;Embedding;</PackageTags>
   </PropertyGroup>
+  <ItemGroup>
+    <PackageReference Include="JsonSchema.Net.Generation" Version="4.1.1" />
+  </ItemGroup>
 </Project>

src/Cnblogs.DashScope.Sdk/FunctionCall.cs

@@ -0,0 +1,8 @@
+namespace Cnblogs.DashScope.Sdk;
+
+/// <summary>
+/// Represents a call to function.
+/// </summary>
+/// <param name="Name">Name of the function to call.</param>
+/// <param name="Arguments">Arguments of this call, usually a json string.</param>
+public record FunctionCall(string Name, string? Arguments);

src/Cnblogs.DashScope.Sdk/FunctionDefinition.cs

@@ -0,0 +1,11 @@
+using Json.Schema;
+
+namespace Cnblogs.DashScope.Sdk;
+
+/// <summary>
+/// Definition of function that can be called by model.
+/// </summary>
+/// <param name="Name">The name of the function.</param>
+/// <param name="Description">Descriptions about this function that help model to decide when to call this function.</param>
+/// <param name="Parameters">The parameters JSON schema.</param>
+public record FunctionDefinition(string Name, string Description, JsonSchema? Parameters);

src/Cnblogs.DashScope.Sdk/ITextGenerationParameters.cs

@@ -42,4 +42,9 @@ public interface ITextGenerationParameters : IIncrementalOutputParameter, ISeedP
     /// Enable internet search when generation. Defaults to false.
     /// </summary>
     public bool? EnableSearch { get; }
+
+    /// <summary>
+    /// Available tools for model to call.
+    /// </summary>
+    public List<ToolDefinition>? Tools { get; }
 }

src/Cnblogs.DashScope.Sdk/TextGenerationInput.cs

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

src/Cnblogs.DashScope.Sdk/TextGenerationParameters.cs

@@ -32,6 +32,9 @@ public class TextGenerationParameters : ITextGenerationParameters
     /// <inheritdoc />
     public bool? EnableSearch { get; set; }
 
+    /// <inheritdoc />
+    public List<ToolDefinition>? Tools { get; set; }
+
     /// <inheritdoc />
     public bool? IncrementalOutput { get; set; }
 }

src/Cnblogs.DashScope.Sdk/ToolCall.cs

@@ -0,0 +1,9 @@
+namespace Cnblogs.DashScope.Sdk;
+
+/// <summary>
+/// Represents a call to tool.
+/// </summary>
+/// <param name="Id">Id of this tool call.</param>
+/// <param name="Type">Type of the tool.</param>
+/// <param name="Function">Not null if type is function.</param>
+public record ToolCall(string? Id, string Type, FunctionCall? Function);

src/Cnblogs.DashScope.Sdk/ToolDefinition.cs

@@ -0,0 +1,8 @@
+namespace Cnblogs.DashScope.Sdk;
+
+/// <summary>
+/// Definition of a tool that model can call during generation.
+/// </summary>
+/// <param name="Type">The type of this tool. Use <see cref="ToolTypes"/> to get all available options.</param>
+/// <param name="Function">Not null when <paramref name="Type"/> is tool.</param>
+public record ToolDefinition(string Type, FunctionDefinition? Function);

src/Cnblogs.DashScope.Sdk/ToolTypes.cs

@@ -0,0 +1,12 @@
+namespace Cnblogs.DashScope.Sdk;
+
+/// <summary>
+/// Available tool types for <see cref="ToolDefinition"/>.
+/// </summary>
+public static class ToolTypes
+{
+    /// <summary>
+    /// Function type.
+    /// </summary>
+    public const string Function = "function";
+}