Merge branch 'feat/ark/fix_example' into 'integration_2024-12-05_629870411266'

BitsAdmin · BitsAdmin · commit 5e464703be3b · 2024-12-05T11:56:23.000Z
feat: [development task] ark-runtime-manual-Java (896944)

See merge request iaasng/volcengine-java-sdk!312
diff --git a/volcengine-java-sdk-ark-runtime/src/main/java/com/volcengine/ark/runtime/interceptor/RequestIdInterceptor.java b/volcengine-java-sdk-ark-runtime/src/main/java/com/volcengine/ark/runtime/interceptor/RequestIdInterceptor.java
@@ -1,6 +1,7 @@
 package com.volcengine.ark.runtime.interceptor;
 
 import com.volcengine.ark.runtime.Const;
+import com.volcengine.version.Version;
 import okhttp3.Interceptor;
 import okhttp3.Request;
 import okhttp3.Response;
@@ -22,6 +23,7 @@ public Response intercept(Chain chain) throws IOException {
         if (chain.request().header(Const.CLIENT_REQUEST_HEADER) == null || chain.request().header(Const.CLIENT_REQUEST_HEADER).length() == 0) {
             requestBuilder = requestBuilder.header(Const.CLIENT_REQUEST_HEADER, genRequestId());
         }
+        requestBuilder.header("User-Agent", getUserAgent());
 
         Request request = requestBuilder.build();
         return chain.proceed(request);
@@ -32,4 +34,14 @@ private String genRequestId() {
         SimpleDateFormat dateFormat= new SimpleDateFormat("yyyyMMddhhmmss");
         return dateFormat.format(date) + RandomStringUtils.randomAlphanumeric(20);
     }
+
+    private static String getUserAgent() {
+        String format = "%s/%s/(%s;%s;%s)";
+
+        String osInfo = System.getProperty("os.name") + "-" + System.getProperty("os.version");
+        String jdkInfo = "java-" + System.getProperty("java.version");
+        String arch = System.getProperty("os.arch");
+
+        return String.format(format, Version.SDK_NAME, Version.SDK_VERSION, jdkInfo, osInfo, arch);
+    }
 }
diff --git a/volcengine-java-sdk-ark-runtime/src/main/java/com/volcengine/ark/runtime/service/ArkBaseService.java b/volcengine-java-sdk-ark-runtime/src/main/java/com/volcengine/ark/runtime/service/ArkBaseService.java
@@ -1,20 +1,20 @@
 package com.volcengine.ark.runtime.service;
 
 
+import okhttp3.ConnectionPool;
+import okhttp3.Dispatcher;
+
 import java.time.Duration;
+import java.util.concurrent.TimeUnit;
 
 
 /**
  * The interface ark service.
  */
 public abstract class ArkBaseService {
 
-    static final String BASE_URL = "https://ark.cn-beijing.volces.com";
-    static final String BASE_REGION = "cn-beijing";
-    static final Duration DEFAULT_TIMEOUT = Duration.ofMinutes(10);
-    static final Duration DEFAULT_CONNECT_TIMEOUT = Duration.ofMinutes(1);
-    String apiKey = "";
-    String ak = "";
-    String sk = "";
-
+    public static final String BASE_URL = "https://ark.cn-beijing.volces.com";
+    public static final String BASE_REGION = "cn-beijing";
+    public static final Duration DEFAULT_TIMEOUT = Duration.ofMinutes(10);
+    public static final Duration DEFAULT_CONNECT_TIMEOUT = Duration.ofMinutes(1);
 }
diff --git a/volcengine-java-sdk-ark-runtime/test/java/com/volcengine/ark/runtime/BotChatCompletionsExample.java b/volcengine-java-sdk-ark-runtime/test/java/com/volcengine/ark/runtime/BotChatCompletionsExample.java
@@ -3,13 +3,15 @@
 
 import com.volcengine.ark.runtime.model.bot.completion.chat.BotChatCompletionRequest;
 import com.volcengine.ark.runtime.model.bot.completion.chat.BotChatCompletionResult;
-import com.volcengine.ark.runtime.model.completion.chat.ChatCompletionRequest;
 import com.volcengine.ark.runtime.model.completion.chat.ChatMessage;
 import com.volcengine.ark.runtime.model.completion.chat.ChatMessageRole;
 import com.volcengine.ark.runtime.service.ArkService;
+import okhttp3.ConnectionPool;
+import okhttp3.Dispatcher;
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.concurrent.TimeUnit;
 
 /*
 # pom.xml
@@ -37,11 +39,13 @@ public class BotChatCompletionsExample {
      * To get your ak&sk, please refer to this document(https://www.volcengine.com/docs/6291/65568)
      * For more information，please check this document（https://www.volcengine.com/docs/82379/1263279）
      */
-    public static void main(String[] args) {
 
-        String apiKey = System.getenv("ARK_API_KEY");
-        ArkService service = new ArkService(apiKey);
+    static String apiKey = System.getenv("ARK_API_KEY");
+    static ConnectionPool connectionPool = new ConnectionPool(5, 1, TimeUnit.SECONDS);
+    static Dispatcher dispatcher = new Dispatcher();
+    static ArkService service = ArkService.builder().dispatcher(dispatcher).connectionPool(connectionPool).apiKey(apiKey).build();
 
+    public static void main(String[] args) {
         System.out.println("\n----- standard request -----");
         final List<ChatMessage> messages = new ArrayList<>();
         final ChatMessage systemMessage = ChatMessage.builder().role(ChatMessageRole.SYSTEM).content("你是豆包，是由字节跳动开发的 AI 人工智能助手").build();
@@ -57,7 +61,9 @@ public static void main(String[] args) {
         BotChatCompletionResult chatCompletionResult =  service.createBotChatCompletion(chatCompletionRequest);
         chatCompletionResult.getChoices().forEach(choice -> System.out.println(choice.getMessage().getContent()));
         // the references example
-        chatCompletionResult.getReferences().forEach(ref -> System.out.println(ref.getUrl()));
+        if (chatCompletionResult.getReferences() != null) {
+            chatCompletionResult.getReferences().forEach(ref -> System.out.println(ref.getUrl()));
+        }
 
         System.out.println("\n----- streaming request -----");
         final List<ChatMessage> streamMessages = new ArrayList<>();
@@ -84,7 +90,7 @@ public static void main(String[] args) {
                         }
                 );
 
-        // shutdown service
+        // shutdown service after all requests is finished
         service.shutdownExecutor();
     }
 
diff --git a/volcengine-java-sdk-ark-runtime/test/java/com/volcengine/ark/runtime/ChatCompletionsExample.java b/volcengine-java-sdk-ark-runtime/test/java/com/volcengine/ark/runtime/ChatCompletionsExample.java
@@ -5,9 +5,12 @@
 import com.volcengine.ark.runtime.model.completion.chat.ChatMessage;
 import com.volcengine.ark.runtime.model.completion.chat.ChatMessageRole;
 import com.volcengine.ark.runtime.service.ArkService;
+import okhttp3.ConnectionPool;
+import okhttp3.Dispatcher;
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.concurrent.TimeUnit;
 
 /*
 # pom.xml
@@ -35,11 +38,13 @@ public class ChatCompletionsExample {
      * To get your ak&sk, please refer to this document(https://www.volcengine.com/docs/6291/65568)
      * For more information，please check this document（https://www.volcengine.com/docs/82379/1263279）
      */
-    public static void main(String[] args) {
 
-        String apiKey = System.getenv("ARK_API_KEY");
-        ArkService service = new ArkService(apiKey);
+    static String apiKey = System.getenv("ARK_API_KEY");
+    static ConnectionPool connectionPool = new ConnectionPool(5, 1, TimeUnit.SECONDS);
+    static Dispatcher dispatcher = new Dispatcher();
+    static ArkService service = ArkService.builder().dispatcher(dispatcher).connectionPool(connectionPool).apiKey(apiKey).build();
 
+    public static void main(String[] args) {
         System.out.println("\n----- standard request -----");
         final List<ChatMessage> messages = new ArrayList<>();
         final ChatMessage systemMessage = ChatMessage.builder().role(ChatMessageRole.SYSTEM).content("你是豆包，是由字节跳动开发的 AI 人工智能助手").build();
@@ -76,7 +81,7 @@ public static void main(String[] args) {
                         }
                 );
 
-        // shutdown service
+        // shutdown service after all requests is finished
         service.shutdownExecutor();
     }
 
diff --git a/volcengine-java-sdk-ark-runtime/test/java/com/volcengine/ark/runtime/ChatCompletionsFunctionCallExample.java b/volcengine-java-sdk-ark-runtime/test/java/com/volcengine/ark/runtime/ChatCompletionsFunctionCallExample.java
@@ -3,8 +3,11 @@
 
 import com.volcengine.ark.runtime.model.completion.chat.*;
 import com.volcengine.ark.runtime.service.ArkService;
+import okhttp3.ConnectionPool;
+import okhttp3.Dispatcher;
 
 import java.util.*;
+import java.util.concurrent.TimeUnit;
 
 public class ChatCompletionsFunctionCallExample {
 
@@ -23,12 +26,14 @@ public class ChatCompletionsFunctionCallExample {
      * To get your ak&sk, please refer to this document(https://www.volcengine.com/docs/6291/65568)
      * For more information，please check this document（https://www.volcengine.com/docs/82379/1263279）
      */
-    public static void main(String[] args) {
-        String ak = System.getenv("VOLC_ACCESSKEY");
-        String sk = System.getenv("VOLC_SECRETKEY");
-        ArkService service = new ArkService(ak, sk);
 
-        System.out.println("\nCreating completion...");
+    static String apiKey = System.getenv("ARK_API_KEY");
+    static ConnectionPool connectionPool = new ConnectionPool(5, 1, TimeUnit.SECONDS);
+    static Dispatcher dispatcher = new Dispatcher();
+    static ArkService service = ArkService.builder().dispatcher(dispatcher).connectionPool(connectionPool).apiKey(apiKey).build();
+
+    public static void main(String[] args) {
+        System.out.println("\n----- function call request -----");
         final List<ChatMessage> messages = new ArrayList<>();
         final ChatMessage userMessage = ChatMessage.builder().role(ChatMessageRole.USER).content("What's the weather like in Boston today?").build();
         messages.add(userMessage);
@@ -66,7 +71,7 @@ public static void main(String[] args) {
                 .doOnError(Throwable::printStackTrace)
                 .blockingForEach(System.out::println);
 
-        // shutdown service
+        // shutdown service after all requests is finished
         service.shutdownExecutor();
     }
 
diff --git a/volcengine-java-sdk-ark-runtime/test/java/com/volcengine/ark/runtime/ChatCompletionsVisionExample.java b/volcengine-java-sdk-ark-runtime/test/java/com/volcengine/ark/runtime/ChatCompletionsVisionExample.java
@@ -5,9 +5,12 @@
 import com.volcengine.ark.runtime.model.completion.chat.ChatMessage;
 import com.volcengine.ark.runtime.model.completion.chat.ChatMessageRole;
 import com.volcengine.ark.runtime.service.ArkService;
+import okhttp3.ConnectionPool;
+import okhttp3.Dispatcher;
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.concurrent.TimeUnit;
 
 /*
 # pom.xml
@@ -35,11 +38,13 @@ public class ChatCompletionsVisionExample {
      * To get your ak&sk, please refer to this document(https://www.volcengine.com/docs/6291/65568)
      * For more information，please check this document（https://www.volcengine.com/docs/82379/1263279）
      */
-    public static void main(String[] args) {
 
-        String apiKey = System.getenv("ARK_API_KEY");
-        ArkService service = new ArkService(apiKey);
+    static String apiKey = System.getenv("ARK_API_KEY");
+    static ConnectionPool connectionPool = new ConnectionPool(5, 1, TimeUnit.SECONDS);
+    static Dispatcher dispatcher = new Dispatcher();
+    static ArkService service = ArkService.builder().dispatcher(dispatcher).connectionPool(connectionPool).apiKey(apiKey).build();
 
+    public static void main(String[] args) {
         System.out.println("----- image input -----");
         final List<ChatMessage> messages = new ArrayList<>();
         final List<ChatCompletionContentPart> multiParts = new ArrayList<>();
@@ -62,7 +67,7 @@ public static void main(String[] args) {
 
         service.createChatCompletion(chatCompletionRequest).getChoices().forEach(choice -> System.out.println(choice.getMessage().getContent()));
 
-        // shutdown service
+        // shutdown service after all requests is finished
         service.shutdownExecutor();
     }
 
diff --git a/volcengine-java-sdk-ark-runtime/test/java/com/volcengine/ark/runtime/EmbeddingsExample.java b/volcengine-java-sdk-ark-runtime/test/java/com/volcengine/ark/runtime/EmbeddingsExample.java
@@ -4,9 +4,12 @@
 import com.volcengine.ark.runtime.model.embeddings.EmbeddingRequest;
 import com.volcengine.ark.runtime.model.embeddings.EmbeddingResult;
 import com.volcengine.ark.runtime.service.ArkService;
+import okhttp3.ConnectionPool;
+import okhttp3.Dispatcher;
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.concurrent.TimeUnit;
 
 public class EmbeddingsExample {
 
@@ -25,11 +28,13 @@ public class EmbeddingsExample {
      * To get your ak&sk, please refer to this document(https://www.volcengine.com/docs/6291/65568)
      * For more information，please check this document（https://www.volcengine.com/docs/82379/1263279）
      */
-    public static void main(String[] args) {
 
-        String apiKey = System.getenv("ARK_API_KEY");
-        ArkService service = new ArkService(apiKey);
+    static String apiKey = System.getenv("ARK_API_KEY");
+    static ConnectionPool connectionPool = new ConnectionPool(5, 1, TimeUnit.SECONDS);
+    static Dispatcher dispatcher = new Dispatcher();
+    static ArkService service = ArkService.builder().dispatcher(dispatcher).connectionPool(connectionPool).apiKey(apiKey).build();
 
+    public static void main(String[] args) {
         System.out.println("\n----- embeddings request -----");
 
         List<String> inputs = new ArrayList<>();
@@ -42,7 +47,7 @@ public static void main(String[] args) {
         EmbeddingResult res = service.createEmbeddings(chatCompletionRequest);
         System.out.println(res);
 
-        // shutdown service
+        // shutdown service after all requests is finished
         service.shutdownExecutor();
     }
 
diff --git a/volcengine-java-sdk-ark-runtime/test/java/com/volcengine/ark/runtime/TokenizationExample.java b/volcengine-java-sdk-ark-runtime/test/java/com/volcengine/ark/runtime/TokenizationExample.java
@@ -1,14 +1,15 @@
 package com.volcengine.ark.runtime;
 
 
-import com.volcengine.ark.runtime.model.embeddings.EmbeddingRequest;
-import com.volcengine.ark.runtime.model.embeddings.EmbeddingResult;
 import com.volcengine.ark.runtime.model.tokenization.TokenizationRequest;
 import com.volcengine.ark.runtime.model.tokenization.TokenizationResult;
 import com.volcengine.ark.runtime.service.ArkService;
+import okhttp3.ConnectionPool;
+import okhttp3.Dispatcher;
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.concurrent.TimeUnit;
 
 public class TokenizationExample {
 
@@ -27,11 +28,13 @@ public class TokenizationExample {
      * To get your ak&sk, please refer to this document(https://www.volcengine.com/docs/6291/65568)
      * For more information，please check this document（https://www.volcengine.com/docs/82379/1263279）
      */
-    public static void main(String[] args) {
 
-        String apiKey = System.getenv("ARK_API_KEY");
-        ArkService service = new ArkService(apiKey);
+    static String apiKey = System.getenv("ARK_API_KEY");
+    static ConnectionPool connectionPool = new ConnectionPool(5, 1, TimeUnit.SECONDS);
+    static Dispatcher dispatcher = new Dispatcher();
+    static ArkService service = ArkService.builder().dispatcher(dispatcher).connectionPool(connectionPool).apiKey(apiKey).build();
 
+    public static void main(String[] args) {
         System.out.println("\n----- tokenization request -----");
         List<String> texts = new ArrayList<>();
         texts.add("花椰菜又称菜花、花菜，是一种常见的蔬菜。");
@@ -43,7 +46,7 @@ public static void main(String[] args) {
         TokenizationResult res = service.createTokenization(tokenizationRequest);
         System.out.println(res);
 
-        // shutdown service
+        // shutdown service after all requests is finished
         service.shutdownExecutor();
     }
 
