feat: add upload temp file api

ikesnowy · ikesnowy · commit aa503c72a8e4 · 2025-07-12T22:12:56.000+08:00
diff --git a/src/Cnblogs.DashScope.Core/DashScopeClientCore.cs b/src/Cnblogs.DashScope.Core/DashScopeClientCore.cs
@@ -287,6 +287,67 @@ public async Task<SpeechSynthesizerSocketSession> CreateSpeechSynthesizerSocketS
         return new SpeechSynthesizerSocketSession(socket, modelId);
     }
 
+    /// <inheritdoc />
+    public Task<DashScopeTemporaryUploadPolicy?> GetTemporaryUploadPolicyAsync(
+        string modelId,
+        CancellationToken cancellationToken = default)
+    {
+        var request = BuildRequest(HttpMethod.Get, ApiLinks.Uploads + $"?action=getPolicy&model={modelId}");
+        return SendAsync<DashScopeTemporaryUploadPolicy>(request, cancellationToken);
+    }
+
+    /// <inheritdoc />
+    public async Task<string> UploadTemporaryFileAsync(
+        string modelId,
+        Stream fileStream,
+        string filename,
+        CancellationToken cancellationToken = default)
+    {
+        var policy = await GetTemporaryUploadPolicyAsync(modelId, cancellationToken);
+        if (policy is null)
+        {
+            throw new DashScopeException(
+                "/api/v1/upload",
+                200,
+                null,
+                "GET /api/v1/upload returns empty response, check your connection");
+        }
+
+        return await UploadTemporaryFileAsync(fileStream, filename, policy);
+    }
+
+    /// <inheritdoc />
+    public async Task<string> UploadTemporaryFileAsync(
+        Stream fileStream,
+        string filename,
+        DashScopeTemporaryUploadPolicy policy)
+    {
+        var filenameStartsWithSlash = filename.StartsWith('/');
+        var key = filenameStartsWithSlash
+            ? $"{policy.Data.UploadDir}{filename}"
+            : $"{policy.Data.UploadDir}/{filename}";
+
+        var form = new MultipartFormDataContent();
+        form.Add(new StringContent(policy.Data.OssAccessKeyId), "OSSAccessKeyId");
+        form.Add(new StringContent(policy.Data.Policy), "policy");
+        form.Add(new StringContent(policy.Data.Signature), "Signature");
+        form.Add(new StringContent(key), "key");
+        form.Add(new StringContent(policy.Data.XOssObjectAcl), "x-oss-object-acl");
+        form.Add(new StringContent(policy.Data.XOssForbidOverwrite), "x-oss-forbid-overwrite");
+        form.Add(new StreamContent(fileStream), "file");
+        var response = await _httpClient.PostAsync(policy.Data.UploadHost, form);
+        if (response.IsSuccessStatusCode)
+        {
+            return $"oss://{key}";
+        }
+
+        throw new DashScopeException(
+            policy.Data.UploadHost,
+            (int)response.StatusCode,
+            null,
+            await response.Content.ReadAsStringAsync());
+    }
+
     private static HttpRequestMessage BuildSseRequest<TPayload>(HttpMethod method, string url, TPayload payload)
         where TPayload : class
     {
diff --git a/src/Cnblogs.DashScope.Core/DashScopeTemporaryUploadPolicy.cs b/src/Cnblogs.DashScope.Core/DashScopeTemporaryUploadPolicy.cs
@@ -0,0 +1,8 @@
+﻿namespace Cnblogs.DashScope.Core;
+
+/// <summary>
+/// Represents one response of get upload policy api call.
+/// </summary>
+/// <param name="RequestId">Unique id for current request.</param>
+/// <param name="Data">The grant data.</param>
+public record DashScopeTemporaryUploadPolicy(string RequestId, DashScopeTemporaryUploadPolicyData Data);
diff --git a/src/Cnblogs.DashScope.Core/DashScopeTemporaryUploadPolicyData.cs b/src/Cnblogs.DashScope.Core/DashScopeTemporaryUploadPolicyData.cs
@@ -0,0 +1,26 @@
+﻿namespace Cnblogs.DashScope.Core;
+
+/// <summary>
+/// Represent data of oss temp file upload grant.
+/// </summary>
+/// <param name="Policy">Upload policy.</param>
+/// <param name="Signature">Upload signature.</param>
+/// <param name="UploadDir">Directory that granted to upload.</param>
+/// <param name="UploadHost">Hostname that upload to.</param>
+/// <param name="ExpireInSeconds">Grant's expiration.</param>
+/// <param name="MaxFileSizeMb">Maximum size of file.</param>
+/// <param name="CapacityLimitMb">Total upload limit of account.</param>
+/// <param name="OssAccessKeyId">Key used to upload.</param>
+/// <param name="XOssObjectAcl">Access of the uploaded file.</param>
+/// <param name="XOssForbidOverwrite">Can file be overwritten by another file with same name.</param>
+public record DashScopeTemporaryUploadPolicyData(
+    string Policy,
+    string Signature,
+    string UploadDir,
+    string UploadHost,
+    int ExpireInSeconds,
+    int MaxFileSizeMb,
+    int CapacityLimitMb,
+    string OssAccessKeyId,
+    string XOssObjectAcl,
+    string XOssForbidOverwrite);
diff --git a/src/Cnblogs.DashScope.Core/IDashScopeClient.cs b/src/Cnblogs.DashScope.Core/IDashScopeClient.cs
@@ -257,4 +257,42 @@ public Task<DashScopeDeleteFileResult> DeleteFileAsync(
     public Task<SpeechSynthesizerSocketSession> CreateSpeechSynthesizerSocketSessionAsync(
         string modelId,
         CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// Get a temporary upload grant for <see cref="modelId"/> to access.
+    /// </summary>
+    /// <param name="modelId">The name of the model.</param>
+    /// <param name="cancellationToken"></param>
+    /// <returns></returns>
+    public Task<DashScopeTemporaryUploadPolicy?> GetTemporaryUploadPolicyAsync(
+        string modelId,
+        CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// Upload file that granted.
+    /// </summary>
+    /// <param name="modelId">The model's id that can access the file.</param>
+    /// <param name="fileStream">The file data.</param>
+    /// <param name="filename">The name of the file.</param>
+    /// <param name="cancellationToken"></param>
+    /// <returns>Oss url of the file.</returns>
+    /// <exception cref="DashScopeException">Throws if response code is not 200.</exception>
+    public Task<string> UploadTemporaryFileAsync(
+        string modelId,
+        Stream fileStream,
+        string filename,
+        CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// Upload file that granted.
+    /// </summary>
+    /// <param name="fileStream">The file data.</param>
+    /// <param name="filename"></param>
+    /// <param name="policy">The grant info.</param>
+    /// <returns></returns>
+    /// <exception cref="DashScopeException">Throws if response code is not 200.</exception>
+    public Task<string> UploadTemporaryFileAsync(
+        Stream fileStream,
+        string filename,
+        DashScopeTemporaryUploadPolicy policy);
 }
diff --git a/src/Cnblogs.DashScope.Core/Internals/ApiLinks.cs b/src/Cnblogs.DashScope.Core/Internals/ApiLinks.cs
@@ -9,6 +9,7 @@ internal static class ApiLinks
     public const string ImageGeneration = "services/aigc/image-generation/generation";
     public const string BackgroundGeneration = "services/aigc/background-generation/generation/";
     public const string Tasks = "tasks/";
+    public const string Uploads = "uploads/";
     public const string Tokenizer = "tokenizer";
     public const string Files = "/compatible-mode/v1/files";
     public static string Application(string applicationId) => $"apps/{applicationId}/completion";
diff --git a/test/Cnblogs.DashScope.Sdk.UnitTests/UploadSerializationTests.cs b/test/Cnblogs.DashScope.Sdk.UnitTests/UploadSerializationTests.cs
@@ -0,0 +1,90 @@
+﻿using System.Net;
+using Cnblogs.DashScope.Core;
+using Cnblogs.DashScope.Tests.Shared.Utils;
+using NSubstitute;
+
+namespace Cnblogs.DashScope.Sdk.UnitTests;
+
+public class UploadSerializationTests
+{
+    [Fact]
+    public async Task Upload_GetPolicy_SuccessAsync()
+    {
+        // Arrange
+        const bool sse = false;
+        var testCase = Snapshots.Upload.GetPolicyNoSse;
+        var (client, handler) = await Sut.GetTestClientAsync(sse, testCase);
+
+        // Act
+        var task = await client.GetTemporaryUploadPolicyAsync("qwen-vl-plus");
+
+        // Assert
+        handler.Received().MockSend(
+            Arg.Is<HttpRequestMessage>(r => r.RequestUri!.PathAndQuery.Contains("model=qwen-vl-plus")),
+            Arg.Any<CancellationToken>());
+        Assert.Equivalent(testCase.ResponseModel, task);
+    }
+
+    [Fact]
+    public async Task Upload_SubmitFileForm_SuccessAsync()
+    {
+        // Arrange
+        var file = Snapshots.File.TestImage;
+        var policy = Snapshots.Upload.GetPolicyNoSse.ResponseModel;
+        var testCase = Snapshots.Upload.UploadTemporaryFileNoSse;
+        var (client, handler) = await Sut.GetTestClientAsync(new HttpResponseMessage(HttpStatusCode.NoContent));
+
+        // Act
+        var uri = await client.UploadTemporaryFileAsync(file.OpenRead(), file.Name, policy);
+        var expectedRequestForm = await testCase.GetRequestFormAsync(false);
+
+        // Assert
+        handler.Received().MockSend(
+            Arg.Is<HttpRequestMessage>(r
+                => r.RequestUri == new Uri(policy.Data.UploadHost)
+                   && Checkers.CheckFormContent(r, expectedRequestForm)),
+            Arg.Any<CancellationToken>());
+        Assert.Equal($"oss://{policy.Data.UploadDir}/{file.Name}", uri);
+    }
+
+    [Fact]
+    public async Task Upload_GetOssLinkDirectly_SuccessAsync()
+    {
+        // Arrange
+        const bool sse = false;
+        var file = Snapshots.File.TestImage;
+        var policyCase = Snapshots.Upload.GetPolicyNoSse;
+        var testCase = Snapshots.Upload.UploadTemporaryFileNoSse;
+        var (client, handler) = await Sut.GetTestClientAsync(sse, policyCase);
+
+        // Act
+        var uri = await client.UploadTemporaryFileAsync("qwen-vl-plus", file.OpenRead(), file.Name);
+        var expectedRequestForm = await testCase.GetRequestFormAsync(false);
+
+        // Assert
+        handler.Received().MockSend(
+            Arg.Is<HttpRequestMessage>(r
+                => r.RequestUri == new Uri(policyCase.ResponseModel.Data.UploadHost)
+                   && Checkers.CheckFormContent(r, expectedRequestForm)),
+            Arg.Any<CancellationToken>());
+        Assert.Equal($"oss://{policyCase.ResponseModel.Data.UploadDir}/{file.Name}", uri);
+    }
+
+    [Fact]
+    public async Task Upload_GetPolicyFailed_ThrowsAsync()
+    {
+        // Arrange
+        const bool sse = false;
+        var file = Snapshots.File.TestImage;
+        var policyCase = Snapshots.Upload.GetPolicyNoSse;
+        var testCase = Snapshots.Upload.UploadTemporaryFileNoSse;
+        var (client, handler) = await Sut.GetTestClientAsync(
+            new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent("null") });
+
+        // Act
+        var act = async () => await client.UploadTemporaryFileAsync("qwen-vl-plus", file.OpenRead(), file.Name);
+
+        // Assert
+        await Assert.ThrowsAsync<DashScopeException>(act);
+    }
+}
diff --git a/test/Cnblogs.DashScope.Tests.Shared/Cnblogs.DashScope.Tests.Shared.csproj b/test/Cnblogs.DashScope.Tests.Shared/Cnblogs.DashScope.Tests.Shared.csproj
@@ -8,6 +8,7 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <PackageReference Include="Microsoft.AspNet.WebApi.Client" Version="6.0.0" />
     <PackageReference Include="NSubstitute" Version="5.3.0"/>
     <PackageReference Include="System.Linq.Async" Version="6.0.3" />
     <PackageReference Include="JsonSchema.Net.Generation" Version="4.6.0" />
@@ -22,6 +23,9 @@
     <None Update="RawHttpData\*.*">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
+    <None Update="RawHttpData\Lenna.jpg">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
   </ItemGroup>
 
 </Project>
diff --git a/test/Cnblogs.DashScope.Tests.Shared/RawHttpData/Lenna.jpg b/test/Cnblogs.DashScope.Tests.Shared/RawHttpData/Lenna.jpg
diff --git a/test/Cnblogs.DashScope.Tests.Shared/RawHttpData/get-task-unknown-nosse.request.header.txt b/test/Cnblogs.DashScope.Tests.Shared/RawHttpData/get-task-unknown-nosse.request.header.txt
@@ -4,3 +4,4 @@ Cache-Control: no-cache
 Host: dashscope.aliyuncs.com
 Accept-Encoding: gzip, deflate, br
 Connection: keep-alive
+\
diff --git a/test/Cnblogs.DashScope.Tests.Shared/RawHttpData/get-upload-policy-nosse.header.txt b/test/Cnblogs.DashScope.Tests.Shared/RawHttpData/get-upload-policy-nosse.header.txt
@@ -0,0 +1,6 @@
+﻿GET /api/v1/uploads?action=getPolicy&model=qwen-vl-plus HTTP/1.1
+Accept: */*
+Cache-Control: no-cache
+Host: dashscope.aliyuncs.com
+Accept-Encoding: gzip, deflate, br
+Connection: keep-alive
diff --git a/test/Cnblogs.DashScope.Tests.Shared/RawHttpData/get-upload-policy-nosse.response.body.txt b/test/Cnblogs.DashScope.Tests.Shared/RawHttpData/get-upload-policy-nosse.response.body.txt
@@ -0,0 +1 @@
+﻿{"data":{"policy":"eyJleHBpcmF0aW9uIjoiMjAyNS0wNy0xMlQxMjoxMDoyNC40ODhaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA3Mzc0MTgyNF0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCJkYXNoc2NvcGUtaW5zdGFudFwvNTJhZmUwNzdmYjQ4MjVjNmQ3NDQxMTc1OGNiMWFiOThcLzIwMjUtMDctMTJcL2I3NDRmNGY4LTFhOWMtOWM2Yi05NTBkLTBkMzI3ZTMzMWYyZiJdLHsiYnVja2V0IjoiZGFzaHNjb3BlLWZpbGUtbWdyIn0seyJ4LW9zcy1vYmplY3QtYWNsIjoicHJpdmF0ZSJ9LHsieC1vc3MtZm9yYmlkLW92ZXJ3cml0ZSI6InRydWUifV19","signature":"n3dNX/aD3+WAly0QgzsURfiIk00=","upload_dir":"dashscope-instant/52afe077fb4825c6d74411758cb1ab98/2025-07-12/b744f4f8-1a9c-9c6b-950d-0d327e331f2f","upload_host":"https://dashscope-file-mgr.oss-cn-beijing.aliyuncs.com","expire_in_seconds":300,"max_file_size_mb":1024,"capacity_limit_mb":999999999,"oss_access_key_id":"LTAI5tG7vL6zZFFbuNrkCjdo","x_oss_object_acl":"private","x_oss_forbid_overwrite":"true"},"request_id":"b744f4f8-1a9c-9c6b-950d-0d327e331f2f"}
diff --git a/test/Cnblogs.DashScope.Tests.Shared/RawHttpData/get-upload-policy-nosse.response.header.txt b/test/Cnblogs.DashScope.Tests.Shared/RawHttpData/get-upload-policy-nosse.response.header.txt
@@ -0,0 +1,11 @@
+﻿HTTP/1.1 200 OK
+content-type: application/json
+req-cost-time: 16
+req-arrive-time: 1752320835878
+resp-start-time: 1752320835894
+x-envoy-upstream-service-time: 7
+content-encoding: gzip
+vary: Accept-Encoding
+date: Sat, 12 Jul 2025 11:47:15 GMT
+server: istio-envoy
+transfer-encoding: chunked
diff --git a/test/Cnblogs.DashScope.Tests.Shared/RawHttpData/upload-temporary-file-nosse.request.body.txt b/test/Cnblogs.DashScope.Tests.Shared/RawHttpData/upload-temporary-file-nosse.request.body.txt
@@ -0,0 +1,35 @@
+﻿--5aa22a67-eae4-4c54-8f62-c486fefd11a5
+Content-Type: text/plain; charset=utf-8
+Content-Disposition: form-data; name=OSSAccessKeyId
+
+LTAI5tG7vL6zZFFbuNrkCjdo
+--5aa22a67-eae4-4c54-8f62-c486fefd11a5
+Content-Type: text/plain; charset=utf-8
+Content-Disposition: form-data; name=policy
+
+eyJleHBpcmF0aW9uIjoiMjAyNS0wNy0xMlQxMjoxMDoyNC40ODhaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA3Mzc0MTgyNF0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCJkYXNoc2NvcGUtaW5zdGFudFwvNTJhZmUwNzdmYjQ4MjVjNmQ3NDQxMTc1OGNiMWFiOThcLzIwMjUtMDctMTJcL2I3NDRmNGY4LTFhOWMtOWM2Yi05NTBkLTBkMzI3ZTMzMWYyZiJdLHsiYnVja2V0IjoiZGFzaHNjb3BlLWZpbGUtbWdyIn0seyJ4LW9zcy1vYmplY3QtYWNsIjoicHJpdmF0ZSJ9LHsieC1vc3MtZm9yYmlkLW92ZXJ3cml0ZSI6InRydWUifV19
+--5aa22a67-eae4-4c54-8f62-c486fefd11a5
+Content-Type: text/plain; charset=utf-8
+Content-Disposition: form-data; name=Signature
+
+n3dNX/aD3+WAly0QgzsURfiIk00=
+--5aa22a67-eae4-4c54-8f62-c486fefd11a5
+Content-Type: text/plain; charset=utf-8
+Content-Disposition: form-data; name=key
+
+dashscope-instant/52afe077fb4825c6d74411758cb1ab98/2025-07-12/b744f4f8-1a9c-9c6b-950d-0d327e331f2f/Lenna.jpg
+--5aa22a67-eae4-4c54-8f62-c486fefd11a5
+Content-Type: text/plain; charset=utf-8
+Content-Disposition: form-data; name=x-oss-object-acl
+
+private
+--5aa22a67-eae4-4c54-8f62-c486fefd11a5
+Content-Type: text/plain; charset=utf-8
+Content-Disposition: form-data; name=x-oss-forbid-overwrite
+
+true
+--5aa22a67-eae4-4c54-8f62-c486fefd11a5
+Content-Disposition: form-data; name=file
+
+1
+--5aa22a67-eae4-4c54-8f62-c486fefd11a5--
diff --git a/test/Cnblogs.DashScope.Tests.Shared/RawHttpData/upload-temporary-file-nosse.request.header.txt b/test/Cnblogs.DashScope.Tests.Shared/RawHttpData/upload-temporary-file-nosse.request.header.txt
@@ -0,0 +1,8 @@
+﻿POST / HTTP/1.1
+Accept: */*
+Cache-Control: no-cache
+Host: dashscope-file-mgr.oss-cn-beijing.aliyuncs.com
+Accept-Encoding: gzip, deflate, br
+Connection: keep-alive
+Content-Type: multipart/form-data; boundary=5aa22a67-eae4-4c54-8f62-c486fefd11a5
+Content-Length: 920956
diff --git a/test/Cnblogs.DashScope.Tests.Shared/Utils/Checkers.cs b/test/Cnblogs.DashScope.Tests.Shared/Utils/Checkers.cs
@@ -11,6 +11,37 @@ public static bool IsJsonEquivalent(ArraySegment<byte> socketBuffer, string requ
         return JsonNode.DeepEquals(actual, expected);
     }
 
+    public static bool CheckFormContent(HttpRequestMessage message, MultipartMemoryStreamProvider provider)
+    {
+        var formContent = message.Content as MultipartFormDataContent;
+        var expectedFields = provider.Contents!;
+        foreach (var httpContent in formContent)
+        {
+            // check field name
+            var fieldName = httpContent.Headers.ContentDisposition!.Name;
+            var expectedField = expectedFields.FirstOrDefault(f => f.Headers.ContentDisposition!.Name == fieldName);
+            if (expectedField is null)
+            {
+                return false;
+            }
+
+            if (httpContent is not StringContent)
+            {
+                continue;
+            }
+
+#pragma warning disable VSTHRD002
+            var stringEqual = expectedField.ReadAsStringAsync().Result == httpContent.ReadAsStringAsync().Result;
+#pragma warning restore VSTHRD002
+            if (stringEqual == false)
+            {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
     public static bool IsJsonEquivalent(HttpContent content, string requestSnapshot)
     {
 #pragma warning disable VSTHRD002
diff --git a/test/Cnblogs.DashScope.Tests.Shared/Utils/RequestSnapshot.cs b/test/Cnblogs.DashScope.Tests.Shared/Utils/RequestSnapshot.cs
diff --git a/test/Cnblogs.DashScope.Tests.Shared/Utils/Snapshots.cs b/test/Cnblogs.DashScope.Tests.Shared/Utils/Snapshots.cs
diff --git a/test/Cnblogs.DashScope.Tests.Shared/Utils/Sut.cs b/test/Cnblogs.DashScope.Tests.Shared/Utils/Sut.cs
