feat(protocol): add user agent (#153)

Author: kevinlin09

samples/GenerationStreamCall.java

@@ -35,8 +35,9 @@ public static void streamCall()
         GenerationParam param =
                 GenerationParam.builder()
                         .model("qwen-turbo")
-                        .prompt("如何做土豆炖猪脚?")
+                        .prompt("你好")
                         .temperature((float) 1.0)
+                        .incrementalOutput(false)
                         .repetitionPenalty((float) 1.0)
                         .topK(50)
                         .build();

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

@@ -162,6 +162,11 @@ public Flowable<GenerationResult> streamCall(HalfDuplexServiceParam param)
     // Intercept and modify incrementalOutput parameter if needed
     boolean toMergeResponse = modifyIncrementalOutput(param);
 
+    // Build custom user agent suffix with incremental_to_full flag
+    int flagValue = toMergeResponse ? 1 : 0;
+    String userAgentSuffix = String.format("incremental_to_full/%d", flagValue);
+    param.putHeader("user-agent", userAgentSuffix);
+
     serviceOption.setIsSSE(true);
     serviceOption.setStreamingMode(StreamingMode.OUT);
     return syncApi.streamCall(param)
@@ -193,6 +198,11 @@ public void streamCall(HalfDuplexServiceParam param, ResultCallback<GenerationRe
     // Intercept and modify incrementalOutput parameter if needed
     boolean toMergeResponse = modifyIncrementalOutput(param);
 
+    // Build custom user agent suffix with incremental_to_full flag
+    int flagValue = toMergeResponse ? 1 : 0;
+    String userAgentSuffix = String.format("incremental_to_full/%d", flagValue);
+    param.putHeader("user-agent", userAgentSuffix);
+
     serviceOption.setIsSSE(true);
     serviceOption.setStreamingMode(StreamingMode.OUT);
     syncApi.streamCall(

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

@@ -144,6 +144,11 @@ public Flowable<MultiModalConversationResult> streamCall(MultiModalConversationP
     // Intercept and modify incrementalOutput parameter if needed
     boolean toMergeResponse = modifyIncrementalOutput(param);
 
+    // Build custom user agent suffix with incremental_to_full flag
+    int flagValue = toMergeResponse ? 1 : 0;
+    String userAgentSuffix = String.format("incremental_to_full/%d", flagValue);
+    param.putHeader("user-agent", userAgentSuffix);
+
     serviceOption.setIsSSE(true);
     serviceOption.setStreamingMode(StreamingMode.OUT);
     preprocessInput(param);
@@ -181,6 +186,11 @@ public void streamCall(
     // Intercept and modify incrementalOutput parameter if needed
     boolean toMergeResponse = modifyIncrementalOutput(param);
 
+    // Build custom user agent suffix with incremental_to_full flag
+    int flagValue = toMergeResponse ? 1 : 0;
+    String userAgentSuffix = String.format("incremental_to_full/%d", flagValue);
+    param.putHeader("user-agent", userAgentSuffix);
+
     serviceOption.setIsSSE(true);
     serviceOption.setStreamingMode(StreamingMode.OUT);
     preprocessInput(param);

src/main/java/com/alibaba/dashscope/protocol/DashScopeHeaders.java

@@ -10,22 +10,42 @@
 
 public final class DashScopeHeaders {
   public static String userAgent() {
+    return userAgent(null);
+  }
+
+  // Generate user agent with optional custom suffix
+  public static String userAgent(String customUserAgent) {
     String userAgent =
         String.format(
             "dashscope/%s; java/%s; platform/%s; processor/%s",
             Version.version,
             System.getProperty("java.version"),
             System.getProperty("os.name"),
             System.getProperty("os.arch"));
+    if (customUserAgent != null && !customUserAgent.isEmpty()) {
+      userAgent += "; " + customUserAgent;
+    }
     return userAgent;
   }
 
   public static Map<String, String> buildWebSocketHeaders(
       String apiKey, boolean isSecurityCheck, String workspace, Map<String, String> customHeaders)
       throws NoApiKeyException {
+    return buildWebSocketHeaders(apiKey, isSecurityCheck, workspace,
+        customHeaders, null);
+  }
+
+  // Build WebSocket headers with optional custom user agent suffix
+  public static Map<String, String> buildWebSocketHeaders(
+      String apiKey,
+      boolean isSecurityCheck,
+      String workspace,
+      Map<String, String> customHeaders,
+      String customUserAgent)
+      throws NoApiKeyException {
     Map<String, String> headers = new HashMap<>();
     headers.put("Authorization", "Bearer " + ApiKey.getApiKey(apiKey));
-    headers.put("user-agent", userAgent());
+    headers.put("user-agent", userAgent(customUserAgent));
     if (workspace != null && !workspace.isEmpty()) {
       headers.put("X-DashScope-WorkSpace", workspace);
     }
@@ -47,9 +67,24 @@ public static Map<String, String> buildHttpHeaders(
       String workspace,
       Map<String, String> customHeaders)
       throws NoApiKeyException {
+    return buildHttpHeaders(apiKey, isSecurityCheck, protocol, isSSE,
+        isAsyncTask, workspace, customHeaders, null);
+  }
+
+  // Build HTTP headers with optional custom user agent suffix
+  public static Map<String, String> buildHttpHeaders(
+      String apiKey,
+      Boolean isSecurityCheck,
+      Protocol protocol,
+      Boolean isSSE,
+      Boolean isAsyncTask,
+      String workspace,
+      Map<String, String> customHeaders,
+      String customUserAgent)
+      throws NoApiKeyException {
     Map<String, String> headers = new HashMap<>();
     headers.put("Authorization", "Bearer " + ApiKey.getApiKey(apiKey));
-    headers.put("user-agent", userAgent());
+    headers.put("user-agent", userAgent(customUserAgent));
     if (isSecurityCheck) {
       headers.put("X-DashScope-DataInspection", "enable");
     }

src/main/java/com/alibaba/dashscope/protocol/HalfDuplexRequest.java

@@ -88,6 +88,13 @@ private String getEncryptionKeyHeader(EncryptionConfig encryptionConfig) throws
   }
 
   public HttpRequest getHttpRequest() throws NoApiKeyException, ApiException {
+    // Extract and filter custom user agent from param headers
+    Map<String, String> paramHeaders = param.getHeaders();
+    String customUserAgent = paramHeaders != null ? paramHeaders.get("user-agent") : null;
+    Map<String, String> filteredHeaders = paramHeaders != null ?
+            new java.util.HashMap<>(paramHeaders) : new java.util.HashMap<>();
+    filteredHeaders.remove("user-agent");
+
     Map<String, String> requestHeaders =
         DashScopeHeaders.buildHttpHeaders(
             param.getApiKey(),
@@ -96,7 +103,8 @@ public HttpRequest getHttpRequest() throws NoApiKeyException, ApiException {
             serviceOption.getIsSSE(),
             serviceOption.getIsAsyncTask(),
             param.getWorkspace(),
-            param.getHeaders());
+            filteredHeaders,
+            customUserAgent);
 
     if (getHttpMethod() == HttpMethod.GET) {
       return HttpRequest.builder()

src/main/java/com/alibaba/dashscope/protocol/okhttp/OkHttpWebSocketClient.java

@@ -62,12 +62,19 @@ private Request buildConnectionRequest(
       Map<String, String> customHeaders,
       String baseWebSocketUrl)
       throws NoApiKeyException {
+    // Extract and filter custom user agent from param headers
+    String customUserAgent = customHeaders != null ?
+        customHeaders.get("user-agent") : null;
+    Map<String, String> filteredHeaders = customHeaders != null ?
+        new java.util.HashMap<>(customHeaders) : new java.util.HashMap<>();
+    filteredHeaders.remove("user-agent");
+
     // build the request builder.
     Builder bd = new Request.Builder();
     bd.headers(
         Headers.of(
             DashScopeHeaders.buildWebSocketHeaders(
-                apiKey, isSecurityCheck, workspace, customHeaders)));
+                apiKey, isSecurityCheck, workspace, filteredHeaders, customUserAgent)));
     String url = Constants.baseWebsocketApiUrl;
     if (baseWebSocketUrl != null) {
       url = baseWebSocketUrl;