feat: support file upload and qwen-long

Author: ikesnowy

src/Cnblogs.DashScope.Core/ChatMessage.cs

@@ -1,4 +1,5 @@
-using Cnblogs.DashScope.Core.Internals;
+using System.Text.Json.Serialization;
+using Cnblogs.DashScope.Core.Internals;
 
 namespace Cnblogs.DashScope.Core;
 
@@ -9,4 +10,28 @@ namespace Cnblogs.DashScope.Core;
 /// <param name="Content">The content of this message.</param>
 /// <param name="Name">Used when role is tool, represents the function name of this message generated by.</param>
 /// <param name="ToolCalls">Calls to the function.</param>
-public record ChatMessage(string Role, string Content, string? Name = null, List<ToolCall>? ToolCalls = null) : IMessage<string>;
+[method: JsonConstructor]
+public record ChatMessage(
+    string Role,
+    string Content,
+    string? Name = null,
+    List<ToolCall>? ToolCalls = null) : IMessage<string>
+{
+    /// <summary>
+    /// Create chat message from an uploaded DashScope file.
+    /// </summary>
+    /// <param name="fileId">The id of the file.</param>
+    public ChatMessage(DashScopeFileId fileId)
+        : this("system", fileId.ToUrl())
+    {
+    }
+
+    /// <summary>
+    /// Create chat message from multiple DashScope file.
+    /// </summary>
+    /// <param name="fileIds">Ids of the files.</param>
+    public ChatMessage(IEnumerable<DashScopeFileId> fileIds)
+        : this("system", string.Join(',', fileIds.Select(f => f.ToUrl())))
+    {
+    }
+}

src/Cnblogs.DashScope.Core/DashScopeClientCore.cs

@@ -1,4 +1,5 @@
-using System.Net.Http.Headers;
+using System.Diagnostics.CodeAnalysis;
+using System.Net.Http.Headers;
 using System.Net.Http.Json;
 using System.Runtime.CompilerServices;
 using System.Text;
@@ -130,32 +131,32 @@ public async Task<DashScopeTaskList> ListTasksAsync(
 
         if (startTime.HasValue)
         {
-            queryString.Append($"start_time={startTime:YYYYMMDDhhmmss}");
+            queryString.Append($"&start_time={startTime:YYYYMMDDhhmmss}");
         }
 
         if (endTime.HasValue)
         {
-            queryString.Append($"end_time={endTime:YYYYMMDDhhmmss}");
+            queryString.Append($"&end_time={endTime:YYYYMMDDhhmmss}");
         }
 
         if (string.IsNullOrEmpty(modelName) == false)
         {
-            queryString.Append($"model_name={modelName}");
+            queryString.Append($"&model_name={modelName}");
         }
 
         if (status.HasValue)
         {
-            queryString.Append($"status={status}");
+            queryString.Append($"&status={status}");
         }
 
         if (pageNo.HasValue)
         {
-            queryString.Append($"page_no={pageNo}");
+            queryString.Append($"&page_no={pageNo}");
         }
 
         if (pageSize.HasValue)
         {
-            queryString.Append($"page_size={pageSize}");
+            queryString.Append($"&page_size={pageSize}");
         }
 
         var request = BuildRequest(HttpMethod.Get, $"{ApiLinks.Tasks}?{queryString}");
@@ -202,6 +203,41 @@ public async Task<ModelResponse<BackgroundGenerationOutput, BackgroundGeneration
             cancellationToken))!;
     }
 
+    /// <inheritdoc />
+    public async Task<DashScopeFile> UploadFileAsync(
+        Stream file,
+        string filename,
+        string purpose = "file-extract",
+        CancellationToken cancellationToken = default)
+    {
+        var form = new MultipartFormDataContent();
+        form.Add(new StreamContent(file), "file", filename);
+        form.Add(new StringContent(purpose), nameof(purpose));
+        var request = new HttpRequestMessage(HttpMethod.Post, ApiLinks.Files) { Content = form };
+        return (await SendCompatibleAsync<DashScopeFile>(request, cancellationToken))!;
+    }
+
+    /// <inheritdoc />
+    public async Task<DashScopeFile> GetFileAsync(DashScopeFileId id, CancellationToken cancellationToken = default)
+    {
+        var request = BuildRequest(HttpMethod.Get, ApiLinks.Files + $"/{id}");
+        return (await SendCompatibleAsync<DashScopeFile>(request, cancellationToken))!;
+    }
+
+    /// <inheritdoc />
+    public async Task<DashScopeFileList> ListFilesAsync(CancellationToken cancellationToken = default)
+    {
+        var request = BuildRequest(HttpMethod.Get, ApiLinks.Files);
+        return (await SendCompatibleAsync<DashScopeFileList>(request, cancellationToken))!;
+    }
+
+    /// <inheritdoc />
+    public async Task<DashScopeDeleteFileResult> DeleteFileAsync(DashScopeFileId id, CancellationToken cancellationToken = default)
+    {
+        var request = BuildRequest(HttpMethod.Delete, ApiLinks.Files + $"/{id}");
+        return (await SendCompatibleAsync<DashScopeDeleteFileResult>(request, cancellationToken))!;
+    }
+
     private static HttpRequestMessage BuildSseRequest<TPayload>(HttpMethod method, string url, TPayload payload)
         where TPayload : class
     {
@@ -239,6 +275,24 @@ private static HttpRequestMessage BuildRequest<TPayload>(
         return message;
     }
 
+    private async Task<TResponse?> SendCompatibleAsync<TResponse>(
+        HttpRequestMessage message,
+        CancellationToken cancellationToken)
+        where TResponse : class
+    {
+        var response = await GetSuccessResponseAsync<OpenAiErrorResponse>(
+            message,
+            r => new DashScopeError()
+            {
+                Code = r.Error.Type,
+                Message = r.Error.Message,
+                RequestId = string.Empty
+            },
+            HttpCompletionOption.ResponseContentRead,
+            cancellationToken);
+        return await response.Content.ReadFromJsonAsync<TResponse>(SerializationOptions, cancellationToken);
+    }
+
     private async Task<TResponse?> SendAsync<TResponse>(HttpRequestMessage message, CancellationToken cancellationToken)
         where TResponse : class
     {
@@ -286,6 +340,15 @@ private async Task<HttpResponseMessage> GetSuccessResponseAsync(
         HttpRequestMessage message,
         HttpCompletionOption completeOption = HttpCompletionOption.ResponseContentRead,
         CancellationToken cancellationToken = default)
+    {
+        return await GetSuccessResponseAsync<DashScopeError>(message, f => f, completeOption, cancellationToken);
+    }
+
+    private async Task<HttpResponseMessage> GetSuccessResponseAsync<TError>(
+        HttpRequestMessage message,
+        Func<TError, DashScopeError> errorMapper,
+        HttpCompletionOption completeOption = HttpCompletionOption.ResponseContentRead,
+        CancellationToken cancellationToken = default)
     {
         HttpResponseMessage response;
         try
@@ -305,14 +368,31 @@ private async Task<HttpResponseMessage> GetSuccessResponseAsync(
         DashScopeError? error = null;
         try
         {
-            error = await response.Content.ReadFromJsonAsync<DashScopeError>(SerializationOptions, cancellationToken);
+            var r = await response.Content.ReadFromJsonAsync<TError>(SerializationOptions, cancellationToken);
+            error = r == null ? null : errorMapper.Invoke(r);
         }
         catch (Exception)
         {
             // ignore
         }
 
+        await ThrowDashScopeExceptionAsync(error, message, response, cancellationToken);
+        // will never reach here
+        return response;
+    }
+
+    [DoesNotReturn]
+    private static async Task ThrowDashScopeExceptionAsync(
+        DashScopeError? error,
+        HttpRequestMessage message,
+        HttpResponseMessage response,
+        CancellationToken cancellationToken)
+    {
         var errorMessage = error?.Message ?? await response.Content.ReadAsStringAsync(cancellationToken);
-        throw new DashScopeException(message.RequestUri?.ToString(), (int)response.StatusCode, error, errorMessage);
+        throw new DashScopeException(
+            message.RequestUri?.ToString(),
+            (int)response.StatusCode,
+            error,
+            errorMessage);
     }
 }

src/Cnblogs.DashScope.Core/DashScopeDeleteFileResult.cs

@@ -0,0 +1,9 @@
+namespace Cnblogs.DashScope.Core;
+
+/// <summary>
+/// Result of a delete file action.
+/// </summary>
+/// <param name="Object">Always be "file".</param>
+/// <param name="Deleted">Deletion result.</param>
+/// <param name="Id">Deleting file's id.</param>
+public record DashScopeDeleteFileResult(string Object, bool Deleted, DashScopeFileId Id);

src/Cnblogs.DashScope.Core/DashScopeFile.cs

@@ -0,0 +1,18 @@
+namespace Cnblogs.DashScope.Core;
+
+/// <summary>
+/// Represents a DashScope file.
+/// </summary>
+/// <param name="Id">Id of the file.</param>
+/// <param name="Object">Always be "file".</param>
+/// <param name="Bytes">Total bytes of the file.</param>
+/// <param name="CreatedAt">Unix timestamp(in seconds) of file create time.</param>
+/// <param name="Filename">Name of the file.</param>
+/// <param name="Purpose">Purpose of the file.</param>
+public record DashScopeFile(
+    DashScopeFileId Id,
+    string Object,
+    int Bytes,
+    int CreatedAt,
+    string Filename,
+    string? Purpose);

src/Cnblogs.DashScope.Core/DashScopeFileId.cs

@@ -0,0 +1,82 @@
+using System.Text.Json.Serialization;
+using Cnblogs.DashScope.Core.Internals;
+
+namespace Cnblogs.DashScope.Core;
+
+/// <summary>
+/// Represents file id of the DashScope file.
+/// </summary>
+[JsonConverter(typeof(DashScopeFileIdConvertor))]
+public readonly struct DashScopeFileId
+{
+    /// <summary>
+    /// Check if two DashScopeFileId equals.
+    /// </summary>
+    /// <param name="other"></param>
+    /// <returns></returns>
+    public bool Equals(DashScopeFileId other)
+    {
+        return Value == other.Value;
+    }
+
+    /// <inheritdoc />
+    public override bool Equals(object? obj)
+    {
+        return obj is DashScopeFileId other && Equals(other);
+    }
+
+    /// <inheritdoc />
+    public override int GetHashCode()
+    {
+        return Value.GetHashCode();
+    }
+
+    /// <summary>
+    /// Initialize a DashScopeFileId.
+    /// </summary>
+    /// <param name="fileId">The id of the file.</param>
+    public DashScopeFileId(string fileId)
+    {
+        Value = fileId;
+    }
+
+    /// <summary>
+    /// The value of the file id.
+    /// </summary>
+    public string Value { get; }
+
+    /// <summary>
+    /// Get url for chat messages.
+    /// </summary>
+    /// <returns>Url like <c>fileid://xxxxxxx</c></returns>
+    public string ToUrl() => "fileid://" + Value;
+
+    /// <inheritdoc />
+    public override string ToString()
+    {
+        return Value;
+    }
+
+    /// <summary>
+    /// Convert string to DashScopeFileId implicitly.
+    /// </summary>
+    /// <param name="value">The string value to convert.</param>
+    /// <returns></returns>
+    public static implicit operator DashScopeFileId(string value) => new(value);
+
+    /// <summary>
+    /// Check if two file id is same.
+    /// </summary>
+    /// <param name="left"></param>
+    /// <param name="right"></param>
+    /// <returns></returns>
+    public static bool operator ==(DashScopeFileId left, DashScopeFileId right) => left.Value == right.Value;
+
+    /// <summary>
+    /// Check if two file id is not same.
+    /// </summary>
+    /// <param name="left"></param>
+    /// <param name="right"></param>
+    /// <returns></returns>
+    public static bool operator !=(DashScopeFileId left, DashScopeFileId right) => !(left == right);
+}

src/Cnblogs.DashScope.Core/DashScopeFileList.cs

@@ -0,0 +1,9 @@
+namespace Cnblogs.DashScope.Core;
+
+/// <summary>
+/// Represents a list of DashScope files.
+/// </summary>
+/// <param name="Object">Always be "list".</param>
+/// <param name="HasMore">True if not reached last page.</param>
+/// <param name="Data">Items of current page.</param>
+public record DashScopeFileList(string Object, bool HasMore, List<DashScopeFile> Data);

src/Cnblogs.DashScope.Core/IDashScopeClient.cs

@@ -66,7 +66,7 @@ Task<ModelResponse<TextEmbeddingOutput, TextEmbeddingTokenUsage>> GetEmbeddingsA
             CancellationToken cancellationToken = default);
 
     /// <summary>
-    /// Create a image synthesis task.
+    /// Create an image synthesis task.
     /// </summary>
     /// <param name="input">The input of image synthesis task.</param>
     /// <param name="cancellationToken">The cancellation token to use.</param>
@@ -130,7 +130,7 @@ Task<ModelResponse<TokenizationOutput, TokenizationUsage>> TokenizeAsync(
         CancellationToken cancellationToken = default);
 
     /// <summary>
-    /// Create a image generation task.
+    /// Create an image generation task.
     /// </summary>
     /// <param name="input">The input of task.</param>
     /// <param name="cancellationToken">The cancellation token to use.</param>
@@ -149,4 +149,45 @@ public Task<ModelResponse<BackgroundGenerationOutput, BackgroundGenerationUsage>
         CreateBackgroundGenerationTaskAsync(
             ModelRequest<BackgroundGenerationInput, IBackgroundGenerationParameters> input,
             CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// Upload file for model to reference.
+    /// </summary>
+    /// <param name="file">File data.</param>
+    /// <param name="filename">Name of the file.</param>
+    /// <param name="purpose">Purpose of the file, use "file-extract" to allow model access the file.</param>
+    /// <param name="cancellationToken">The cancellation token to use.</param>
+    /// <returns></returns>
+    public Task<DashScopeFile> UploadFileAsync(
+        Stream file,
+        string filename,
+        string purpose = "file-extract",
+        CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// Get DashScope file by id.
+    /// </summary>
+    /// <param name="id">Id of the file.</param>
+    /// <param name="cancellationToken">The cancellation token to use.</param>
+    /// <returns></returns>
+    /// <exception cref="DashScopeException">Throws when file not exists, Status will be 404 in this case.</exception>
+    public Task<DashScopeFile> GetFileAsync(DashScopeFileId id, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// List DashScope files.
+    /// </summary>
+    /// <param name="cancellationToken">The cancellation token to use.</param>
+    /// <returns></returns>
+    public Task<DashScopeFileList> ListFilesAsync(CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// Delete DashScope file.
+    /// </summary>
+    /// <param name="id">The id of the file to delete.</param>
+    /// <param name="cancellationToken">The cancellation token to use.</param>
+    /// <returns></returns>
+    /// <exception cref="DashScopeException">Throws when file not exists, Status would be 404.</exception>
+    public Task<DashScopeDeleteFileResult> DeleteFileAsync(
+        DashScopeFileId id,
+        CancellationToken cancellationToken = default);
 }

src/Cnblogs.DashScope.Core/Internals/ApiLinks.cs

@@ -10,4 +10,5 @@ internal static class ApiLinks
     public const string BackgroundGeneration = "services/aigc/background-generation/generation/";
     public const string Tasks = "tasks/";
     public const string Tokenizer = "tokenizer";
+    public const string Files = "/compatible-mode/v1/files";
 }