Add a header to all Result classes. (#215)

* Add a header to all Result classes.

* Add a header to all Result classes.

* Fixes the issue where isFlattenResult=true by adding a header.

* change ut

* change ut

---------

Co-authored-by: mose-x.zm <zm02074348@alibaba-inc.com>

Author: mose-zm

src/main/java/com/alibaba/dashscope/aigc/codegeneration/CodeGenerationResult.java

@@ -5,6 +5,7 @@
 import com.alibaba.dashscope.utils.JsonUtils;
 import com.alibaba.dashscope.utils.StringUtils;
 import com.google.gson.JsonObject;
+import java.util.Map;
 import lombok.Data;
 import lombok.extern.slf4j.Slf4j;
 
@@ -14,12 +15,14 @@ public final class CodeGenerationResult {
   private String requestId;
   private CodeGenerationUsage usage;
   private CodeGenerationOutput output;
+  private Map<String, Object> headers;
 
   private CodeGenerationResult() {}
 
   public static CodeGenerationResult fromDashScopeResult(DashScopeResult dashScopeResult) {
     CodeGenerationResult result = new CodeGenerationResult();
     result.setRequestId(dashScopeResult.getRequestId());
+    result.setHeaders(dashScopeResult.getHeaders());
     if (dashScopeResult.getUsage() != null) {
       result.setUsage(
           JsonUtils.fromJsonObject(

src/main/java/com/alibaba/dashscope/aigc/conversation/ConversationResult.java

@@ -6,19 +6,22 @@
 import com.alibaba.dashscope.common.DashScopeResult;
 import com.alibaba.dashscope.utils.JsonUtils;
 import com.google.gson.JsonObject;
+import java.util.Map;
 import lombok.Data;
 
 @Data
 public final class ConversationResult {
   private String requestId;
   private GenerationUsage usage;
   private GenerationOutput output;
+  private Map<String, Object> headers;
 
   private ConversationResult() {}
 
   public static ConversationResult fromDashScopeResult(DashScopeResult dashScopeResult) {
     ConversationResult result = new ConversationResult();
     result.setRequestId(dashScopeResult.getRequestId());
+    result.setHeaders(dashScopeResult.getHeaders());
     result.setUsage(
         JsonUtils.fromJsonObject(
             dashScopeResult.getUsage().getAsJsonObject(), GenerationUsage.class));

src/main/java/com/alibaba/dashscope/aigc/generation/GenerationResult.java

@@ -6,6 +6,7 @@
 import com.alibaba.dashscope.utils.StringUtils;
 import com.google.gson.JsonObject;
 import com.google.gson.annotations.SerializedName;
+import java.util.Map;
 import lombok.Data;
 import lombok.extern.slf4j.Slf4j;
 
@@ -15,6 +16,7 @@ public final class GenerationResult {
   private String requestId;
   private GenerationUsage usage;
   private GenerationOutput output;
+  private Map<String, Object> headers;
 
   @SerializedName("status_code")
   private Integer statusCode;
@@ -30,6 +32,7 @@ public static GenerationResult fromDashScopeResult(DashScopeResult dashScopeResu
     result.setStatusCode(dashScopeResult.getStatusCode());
     result.setCode(dashScopeResult.getCode());
     result.setMessage(dashScopeResult.getMessage());
+    result.setHeaders(dashScopeResult.getHeaders());
     if (dashScopeResult.getUsage() != null) {
       result.setUsage(
           JsonUtils.fromJsonObject(

src/main/java/com/alibaba/dashscope/aigc/imagegeneration/ImageGenerationResult.java

@@ -4,6 +4,7 @@
 import com.alibaba.dashscope.utils.JsonUtils;
 import com.google.gson.JsonObject;
 import com.google.gson.annotations.SerializedName;
+import java.util.Map;
 import lombok.Data;
 import lombok.extern.slf4j.Slf4j;
 
@@ -13,6 +14,7 @@ public class ImageGenerationResult {
   private String requestId;
   private ImageGenerationUsage usage;
   private ImageGenerationOutput output;
+  private Map<String, Object> headers;
 
   @SerializedName("status_code")
   private Integer statusCode;
@@ -28,6 +30,7 @@ public static ImageGenerationResult fromDashScopeResult(DashScopeResult dashScop
     result.setStatusCode(dashScopeResult.getStatusCode());
     result.setCode(dashScopeResult.getCode());
     result.setMessage(dashScopeResult.getMessage());
+    result.setHeaders(dashScopeResult.getHeaders());
     if (dashScopeResult.getUsage() != null) {
       result.setUsage(
           JsonUtils.fromJsonObject(

src/main/java/com/alibaba/dashscope/aigc/imagesynthesis/ImageSynthesisResult.java

@@ -6,6 +6,7 @@
 import com.alibaba.dashscope.utils.StringUtils;
 import com.google.gson.JsonObject;
 import com.google.gson.annotations.SerializedName;
+import java.util.Map;
 import lombok.Data;
 import lombok.extern.slf4j.Slf4j;
 
@@ -17,6 +18,7 @@ public class ImageSynthesisResult {
 
   private ImageSynthesisOutput output;
   private ImageSynthesisUsage usage;
+  private Map<String, Object> headers;
 
   @SerializedName("status_code")
   private Integer statusCode;
@@ -33,6 +35,7 @@ public static ImageSynthesisResult fromDashScopeResult(DashScopeResult dashScope
     result.statusCode = dashScopeResult.getStatusCode();
     result.code = dashScopeResult.getCode();
     result.message = dashScopeResult.getMessage();
+    result.headers = dashScopeResult.getHeaders();
     if (dashScopeResult.getUsage() != null) {
       result.setUsage(
           JsonUtils.fromJsonObject(

src/main/java/com/alibaba/dashscope/aigc/multimodalconversation/MultiModalConversationResult.java

@@ -4,6 +4,7 @@
 import com.alibaba.dashscope.utils.JsonUtils;
 import com.google.gson.JsonObject;
 import com.google.gson.annotations.SerializedName;
+import java.util.Map;
 import lombok.Data;
 import lombok.extern.slf4j.Slf4j;
 
@@ -13,6 +14,7 @@ public class MultiModalConversationResult {
   private String requestId;
   private MultiModalConversationUsage usage;
   private MultiModalConversationOutput output;
+  private Map<String, Object> headers;
 
   @SerializedName("status_code")
   private Integer statusCode;
@@ -28,6 +30,7 @@ public static MultiModalConversationResult fromDashScopeResult(DashScopeResult d
     result.setStatusCode(dashScopeResult.getStatusCode());
     result.setCode(dashScopeResult.getCode());
     result.setMessage(dashScopeResult.getMessage());
+    result.setHeaders(dashScopeResult.getHeaders());
     if (dashScopeResult.getUsage() != null) {
       result.setUsage(
           JsonUtils.fromJsonObject(

src/main/java/com/alibaba/dashscope/aigc/videosynthesis/VideoSynthesisResult.java

@@ -5,6 +5,7 @@
 import com.alibaba.dashscope.utils.JsonUtils;
 import com.google.gson.JsonObject;
 import com.google.gson.annotations.SerializedName;
+import java.util.Map;
 import lombok.Data;
 import lombok.extern.slf4j.Slf4j;
 
@@ -16,6 +17,7 @@ public class VideoSynthesisResult {
 
   private VideoSynthesisOutput output;
   private VideoSynthesisUsage usage;
+  private Map<String, Object> headers;
 
   @SerializedName("status_code")
   private Integer statusCode;
@@ -32,6 +34,7 @@ public static VideoSynthesisResult fromDashScopeResult(DashScopeResult dashScope
     result.statusCode = dashScopeResult.getStatusCode();
     result.code = dashScopeResult.getCode();
     result.message = dashScopeResult.getMessage();
+    result.headers = dashScopeResult.getHeaders();
     if (dashScopeResult.getUsage() != null) {
       result.setUsage(
           JsonUtils.fromJsonObject(

src/main/java/com/alibaba/dashscope/common/DashScopeResult.java

@@ -11,6 +11,9 @@
 import com.alibaba.dashscope.utils.JsonUtils;
 import com.google.gson.JsonObject;
 import java.nio.ByteBuffer;
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 
@@ -28,6 +31,7 @@ public Boolean isBinaryOutput() {
   @SuppressWarnings("unchecked")
   protected <T extends Result> T fromResponse(Protocol protocol, NetworkResponse response)
       throws ApiException {
+    this.setHeaders(changeHeaders(response.getHeaders()));
     if (protocol == Protocol.WEBSOCKET) {
       if (response.getBinary() == null) {
         JsonObject jsonObject = JsonUtils.parse(response.getMessage());
@@ -145,6 +149,7 @@ public <T extends Result> T fromResponse(
     if (!isFlattenResult) {
       return fromResponse(protocol, response);
     } else {
+      this.setHeaders(changeHeaders(response.getHeaders()));
       // flatten not support websocket.
       if (protocol == Protocol.WEBSOCKET) {
         if (response.getBinary() == null) {
@@ -168,6 +173,7 @@ public <T extends Result> T fromResponse(
   public <T extends Result> T fromResponse(
       Protocol protocol, NetworkResponse response, boolean isFlattenResult, HalfDuplexRequest req)
       throws ApiException {
+    this.setHeaders(changeHeaders(response.getHeaders()));
     // check it's encrypted output
     if ((response.getHeaders().containsKey("X-DashScope-OutputEncrypted".toLowerCase())
             || req.isEncryptRequest())
@@ -233,4 +239,21 @@ public <T extends Result> T fromResponse(
     }
     return fromResponse(protocol, response, isFlattenResult);
   }
+
+  private Map<String, Object> changeHeaders(Map<String, List<String>> headers) {
+    if (headers == null || headers.isEmpty()) {
+      return null;
+    }
+    return headers.entrySet().stream()
+        .filter(entry -> entry.getKey() != null)
+        .collect(
+            Collectors.toMap(
+                Map.Entry::getKey,
+                entry -> {
+                  List<String> values = entry.getValue();
+                  return (values == null || values.isEmpty()) ? "" : String.join(",", values);
+                },
+                (v1, v2) -> v1,
+                java.util.LinkedHashMap::new));
+  }
 }

src/main/java/com/alibaba/dashscope/common/Result.java

@@ -24,7 +24,7 @@ public abstract class Result {
   private JsonElement usage;
 
   /** The headers of response */
-  private Map<String, String> headers;
+  private Map<String, Object> headers;
 
   /** The HTTP status code from server response */
   private Integer statusCode;

src/test/java/com/alibaba/dashscope/TestHalfDuplexHttpApi.java

@@ -78,7 +78,9 @@ public void testHttpSendEmptyResponse() throws ApiException, NoApiKeyException,
         HalfDuplexTestParam.builder().model("qwen-turbo").parameter("k1", "v1").build();
     Constants.baseHttpApiUrl = String.format("http://127.0.0.1:%s", port);
     DashScopeResult result = syncApi.call(param);
-    assertEquals(JsonUtils.toJson(result), "{\"statusCode\":200,\"code\":\"\",\"message\":\"\"}");
+    assertEquals(
+        JsonUtils.toJson(result),
+        "{\"headers\":{\"content-length\":\"2\",\"content-type\":\"application/json; charset=utf-8\"},\"statusCode\":200,\"code\":\"\",\"message\":\"\"}");
     server.close();
   }