feat: support logprobs

ikesnowy · ikesnowy · commit 5661b20ebbb4 · 2025-07-07T23:48:09.000+08:00
diff --git a/Cnblogs.DashScope.Sdk.sln b/Cnblogs.DashScope.Sdk.sln
@@ -16,8 +16,6 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Cnblogs.DashScope.AspNetCor
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Cnblogs.DashScope.Core", "src\Cnblogs.DashScope.Core\Cnblogs.DashScope.Core.csproj", "{CC389455-A3EA-4F09-B524-4DC351A1E1AA}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Cnblogs.DashScope.Sdk.SnapshotGenerator", "test\Cnblogs.DashScope.Sdk.SnapshotGenerator\Cnblogs.DashScope.Sdk.SnapshotGenerator.csproj", "{5088DE77-1CE3-46FB-B9D0-27A6C9A5EED1}"
-EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Cnblogs.DashScope.AI", "src\Cnblogs.DashScope.AI\Cnblogs.DashScope.AI.csproj", "{5D5AD75A-8084-4738-AC56-B8A23E649452}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Cnblogs.DashScope.AI.UnitTests", "test\Cnblogs.DashScope.AI.UnitTests\Cnblogs.DashScope.AI.UnitTests.csproj", "{25EE79E1-147B-42FD-AFEA-E1550EDD1D36}"
@@ -35,7 +33,6 @@ Global
 		{8885149A-78F0-4C8E-B9AA-87A46EA69219} = {2E15D1EC-4A07-416E-8BE6-D907F509FD35}
 		{C910495B-87AB-4AC1-989C-B6720695A139} = {008988ED-0A3B-4272-BCC3-7B4110699345}
 		{CC389455-A3EA-4F09-B524-4DC351A1E1AA} = {008988ED-0A3B-4272-BCC3-7B4110699345}
-		{5088DE77-1CE3-46FB-B9D0-27A6C9A5EED1} = {CFC8ECB3-5248-46CD-A56C-EC088F2A3804}
 		{5D5AD75A-8084-4738-AC56-B8A23E649452} = {008988ED-0A3B-4272-BCC3-7B4110699345}
 		{25EE79E1-147B-42FD-AFEA-E1550EDD1D36} = {CFC8ECB3-5248-46CD-A56C-EC088F2A3804}
 		{06F0AF23-445B-4C6F-9E19-570DA9B7435D} = {CFC8ECB3-5248-46CD-A56C-EC088F2A3804}
@@ -61,10 +58,6 @@ Global
 		{CC389455-A3EA-4F09-B524-4DC351A1E1AA}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{CC389455-A3EA-4F09-B524-4DC351A1E1AA}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{CC389455-A3EA-4F09-B524-4DC351A1E1AA}.Release|Any CPU.Build.0 = Release|Any CPU
-		{5088DE77-1CE3-46FB-B9D0-27A6C9A5EED1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{5088DE77-1CE3-46FB-B9D0-27A6C9A5EED1}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{5088DE77-1CE3-46FB-B9D0-27A6C9A5EED1}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{5088DE77-1CE3-46FB-B9D0-27A6C9A5EED1}.Release|Any CPU.Build.0 = Release|Any CPU
 		{5D5AD75A-8084-4738-AC56-B8A23E649452}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{5D5AD75A-8084-4738-AC56-B8A23E649452}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{5D5AD75A-8084-4738-AC56-B8A23E649452}.Release|Any CPU.ActiveCfg = Release|Any CPU
diff --git a/src/Cnblogs.DashScope.Core/Internals/ByteArrayLiteralConvertor.cs b/src/Cnblogs.DashScope.Core/Internals/ByteArrayLiteralConvertor.cs
@@ -0,0 +1,43 @@
+﻿using System.Text.Json;
+using System.Text.Json.Serialization;
+
+namespace Cnblogs.DashScope.Core.Internals;
+
+internal class ByteArrayLiteralConvertor : JsonConverter<byte[]>
+{
+    /// <inheritdoc />
+    public override byte[]? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
+    {
+        if (reader.TokenType == JsonTokenType.StartArray)
+        {
+            reader.Read(); // read out start of array
+            var list = new List<byte>(8); // should fit most tokens
+            while (reader.TokenType != JsonTokenType.EndArray)
+            {
+                list.Add(reader.GetByte());
+                reader.Read();
+            }
+
+            return list.ToArray();
+        }
+
+        if (reader.TokenType == JsonTokenType.Null)
+        {
+            return null;
+        }
+
+        return reader.GetBytesFromBase64();
+    }
+
+    /// <inheritdoc />
+    public override void Write(Utf8JsonWriter writer, byte[] value, JsonSerializerOptions options)
+    {
+        writer.WriteStartArray();
+        foreach (var b in value)
+        {
+            writer.WriteNumberValue(b);
+        }
+
+        writer.WriteEndArray();
+    }
+}
diff --git a/src/Cnblogs.DashScope.Core/TextGenerationChoice.cs b/src/Cnblogs.DashScope.Core/TextGenerationChoice.cs
@@ -18,5 +18,5 @@ public class TextGenerationChoice
     /// <summary>
     /// Token array with log possibility info.
     /// </summary>
-    public TextGenerationLogProbs? Logprobs { get; set; }
+    public TextGenerationLogprobs? Logprobs { get; set; }
 }
diff --git a/src/Cnblogs.DashScope.Core/TextGenerationLogprobContent.cs b/src/Cnblogs.DashScope.Core/TextGenerationLogprobContent.cs
@@ -1,4 +1,7 @@
-﻿namespace Cnblogs.DashScope.Core;
+﻿using System.Text.Json.Serialization;
+using Cnblogs.DashScope.Core.Internals;
+
+namespace Cnblogs.DashScope.Core;
 
 /// <summary>
 /// Represents a possible choice of token.
@@ -7,8 +10,9 @@
 /// <param name="Bytes">Token content in UTF-8 byte array.</param>
 /// <param name="Logprob">Possibility, <c>null</c> when it's too low.</param>
 /// <param name="TopLogprobs">The most possible alternatives.</param>
-public record TextGenerationLogProbContent(
+public record TextGenerationLogprobContent(
     string Token,
+    [property: JsonConverter(typeof(ByteArrayLiteralConvertor))]
     byte[] Bytes,
     float? Logprob,
-    List<TextGenerationTopLogProbContent> TopLogprobs);
+    List<TextGenerationTopLogprobContent> TopLogprobs);
diff --git a/src/Cnblogs.DashScope.Core/TextGenerationLogprobs.cs b/src/Cnblogs.DashScope.Core/TextGenerationLogprobs.cs
@@ -4,4 +4,4 @@
 /// Possibilities of token choices.
 /// </summary>
 /// <param name="Content">The choices with their possibility.</param>
-public record TextGenerationLogProbs(List<TextGenerationLogProbContent> Content);
+public record TextGenerationLogprobs(List<TextGenerationLogprobContent> Content);
diff --git a/src/Cnblogs.DashScope.Core/TextGenerationTopLogprobContent.cs b/src/Cnblogs.DashScope.Core/TextGenerationTopLogprobContent.cs
@@ -1,9 +1,16 @@
-﻿namespace Cnblogs.DashScope.Core;
+﻿using System.Text.Json.Serialization;
+using Cnblogs.DashScope.Core.Internals;
+
+namespace Cnblogs.DashScope.Core;
 
 /// <summary>
 /// Represents one choice of most possibility alternative tokens.
 /// </summary>
 /// <param name="Token">The token content.</param>
 /// <param name="Bytes">The token content in UTF-8 byte array.</param>
 /// <param name="Logprob">Possibility, <c>null</c> when possibility is too low.</param>
-public record TextGenerationTopLogProbContent(string Token, byte[] Bytes, float? Logprob);
+public record TextGenerationTopLogprobContent(
+    string Token,
+    [property: JsonConverter(typeof(ByteArrayLiteralConvertor))]
+    byte[] Bytes,
+    float? Logprob);
diff --git a/test/Cnblogs.DashScope.Sdk.SnapshotGenerator/Cnblogs.DashScope.Sdk.SnapshotGenerator.csproj b/test/Cnblogs.DashScope.Sdk.SnapshotGenerator/Cnblogs.DashScope.Sdk.SnapshotGenerator.csproj
diff --git a/test/Cnblogs.DashScope.Sdk.SnapshotGenerator/Program.cs b/test/Cnblogs.DashScope.Sdk.SnapshotGenerator/Program.cs
diff --git a/test/Cnblogs.DashScope.Sdk.UnitTests/TextGenerationSerializationTests.cs b/test/Cnblogs.DashScope.Sdk.UnitTests/TextGenerationSerializationTests.cs
@@ -155,7 +155,8 @@ public async Task ConversationCompletion_MessageFormatSse_SuccessAsync(
         Snapshots.TextGeneration.MessageFormat.SingleMessage,
         Snapshots.TextGeneration.MessageFormat.SingleMessageReasoning,
         Snapshots.TextGeneration.MessageFormat.SingleMessageWithTools,
-        Snapshots.TextGeneration.MessageFormat.SingleMessageJson);
+        Snapshots.TextGeneration.MessageFormat.SingleMessageJson,
+        Snapshots.TextGeneration.MessageFormat.SingleMessageLogprobs);
 
     public static readonly TheoryData<RequestSnapshot<ModelRequest<TextGenerationInput, ITextGenerationParameters>,
         ModelResponse<TextGenerationOutput, TextGenerationTokenUsage>>> SingleGenerationMessageSseFormatData = new(
diff --git a/test/Cnblogs.DashScope.Tests.Shared/RawHttpData/single-generation-message-logprobs-nosse.request.body.json b/test/Cnblogs.DashScope.Tests.Shared/RawHttpData/single-generation-message-logprobs-nosse.request.body.json
@@ -0,0 +1,22 @@
+﻿{
+  "model": "qwen-max",
+  "input": {
+    "messages": [
+      {
+        "role": "user",
+        "content": "请问 1+1 是多少？请直接输出结果"
+      }
+    ]
+  },
+  "parameters": {
+    "result_format": "message",
+    "seed": 1234,
+    "max_tokens": 1500,
+    "top_p": 0.8,
+    "top_k": 100,
+    "repetition_penalty": 1.1,
+    "temperature": 0.85,
+    "logprobs": true,
+    "top_logprobs": 2
+  }
+}
diff --git a/test/Cnblogs.DashScope.Tests.Shared/RawHttpData/single-generation-message-logprobs-nosse.request.header.txt b/test/Cnblogs.DashScope.Tests.Shared/RawHttpData/single-generation-message-logprobs-nosse.request.header.txt
@@ -0,0 +1,8 @@
+﻿POST /api/v1/services/aigc/text-generation/generation HTTP/1.1
+Content-Type: application/json
+Accept: */*
+Cache-Control: no-cache
+Host: dashscope.aliyuncs.com
+Accept-Encoding: gzip, deflate, br
+Connection: keep-alive
+Content-Length: 592
diff --git a/test/Cnblogs.DashScope.Tests.Shared/RawHttpData/single-generation-message-logprobs-nosse.response.body.txt b/test/Cnblogs.DashScope.Tests.Shared/RawHttpData/single-generation-message-logprobs-nosse.response.body.txt
@@ -0,0 +1 @@
+﻿{"output":{"choices":[{"finish_reason":"stop","message":{"role":"assistant","content":"2"},"logprobs":{"content":[{"top_logprobs":[{"logprob":0.0,"bytes":[50],"token":"2"}],"logprob":0.0,"bytes":[50],"token":"2"}]}}]},"usage":{"total_tokens":21,"output_tokens":1,"input_tokens":20,"prompt_tokens_details":{"cached_tokens":0}},"request_id":"1d881da5-0028-9f20-8e7f-6bc7ae891c54"}
diff --git a/test/Cnblogs.DashScope.Tests.Shared/RawHttpData/single-generation-message-logprobs-nosse.response.header.txt b/test/Cnblogs.DashScope.Tests.Shared/RawHttpData/single-generation-message-logprobs-nosse.response.header.txt
@@ -0,0 +1,15 @@
+﻿HTTP/1.1 200 OK
+vary: Origin,Access-Control-Request-Method,Access-Control-Request-Headers, Accept-Encoding
+content-type: application/json
+x-request-id: 1d881da5-0028-9f20-8e7f-6bc7ae891c54
+x-dashscope-call-gateway: true
+x-dashscope-finished: true
+x-dashscope-timeout: 298
+req-cost-time: 261
+req-arrive-time: 1751901115333
+resp-start-time: 1751901115594
+x-envoy-upstream-service-time: 252
+content-encoding: gzip
+date: Mon, 07 Jul 2025 15:11:55 GMT
+server: istio-envoy
+transfer-encoding: chunked
diff --git a/test/Cnblogs.DashScope.Tests.Shared/Utils/Snapshots.TextGeneration.cs b/test/Cnblogs.DashScope.Tests.Shared/Utils/Snapshots.TextGeneration.cs

Original file line number	Diff line number	Diff line change
`@@ -18,5 +18,5 @@ public class TextGenerationChoice`
`18`	`18`	`/// <summary>`
`19`	`19`	`/// Token array with log possibility info.`
`20`	`20`	`/// </summary>`
`21`		`- public TextGenerationLogProbs? Logprobs { get; set; }`
	`21`	`+ public TextGenerationLogprobs? Logprobs { get; set; }`
`22`	`22`	`}`