feat: optimize example

hexiaochun · hexiaochun · commit 5df625a6ec56 · 2024-12-01T21:44:07.000+08:00
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,22 @@
 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);
+    public static final ConnectionPool DEFAULT_CONNECTION_POOL = new ConnectionPool(5, 1, TimeUnit.SECONDS);
+    public static final Dispatcher DEFAULT_DISPATCHER = new Dispatcher();
 }
diff --git a/volcengine-java-sdk-ark-runtime/src/main/java/com/volcengine/ark/runtime/service/ArkService.java b/volcengine-java-sdk-ark-runtime/src/main/java/com/volcengine/ark/runtime/service/ArkService.java
@@ -314,11 +314,13 @@ public ArkService build() {
             if (connectionPool != null) {
                 clientBuilder.connectionPool(connectionPool);
             } else {
-                clientBuilder.connectionPool(new ConnectionPool(5, 1, TimeUnit.SECONDS));
+                clientBuilder.connectionPool(DEFAULT_CONNECTION_POOL);
             }
 
             if (dispatcher != null) {
                 clientBuilder.dispatcher(dispatcher);
+            } else {
+                clientBuilder.dispatcher(DEFAULT_DISPATCHER);
             }
 
             OkHttpClient client = clientBuilder
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,14 +3,16 @@
 
 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 java.util.ArrayList;
 import java.util.List;
 
+import static com.volcengine.ark.runtime.service.ArkBaseService.DEFAULT_CONNECTION_POOL;
+import static com.volcengine.ark.runtime.service.ArkBaseService.DEFAULT_DISPATCHER;
+
 /*
 # pom.xml
 <dependency>
@@ -37,11 +39,11 @@ 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 ArkService service = ArkService.builder().dispatcher(DEFAULT_DISPATCHER).connectionPool(DEFAULT_CONNECTION_POOL).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();
@@ -84,7 +86,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
@@ -9,6 +9,9 @@
 import java.util.ArrayList;
 import java.util.List;
 
+import static com.volcengine.ark.runtime.service.ArkBaseService.DEFAULT_CONNECTION_POOL;
+import static com.volcengine.ark.runtime.service.ArkBaseService.DEFAULT_DISPATCHER;
+
 /*
 # pom.xml
 <dependency>
@@ -35,11 +38,11 @@ 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 ArkService service = ArkService.builder().dispatcher(DEFAULT_DISPATCHER).connectionPool(DEFAULT_CONNECTION_POOL).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 +79,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
@@ -6,6 +6,9 @@
 
 import java.util.*;
 
+import static com.volcengine.ark.runtime.service.ArkBaseService.DEFAULT_CONNECTION_POOL;
+import static com.volcengine.ark.runtime.service.ArkBaseService.DEFAULT_DISPATCHER;
+
 public class ChatCompletionsFunctionCallExample {
 
     /**
@@ -23,12 +26,12 @@ 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 ArkService service = ArkService.builder().dispatcher(DEFAULT_DISPATCHER).connectionPool(DEFAULT_CONNECTION_POOL).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 +69,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
@@ -9,6 +9,9 @@
 import java.util.ArrayList;
 import java.util.List;
 
+import static com.volcengine.ark.runtime.service.ArkBaseService.DEFAULT_CONNECTION_POOL;
+import static com.volcengine.ark.runtime.service.ArkBaseService.DEFAULT_DISPATCHER;
+
 /*
 # pom.xml
 <dependency>
@@ -35,11 +38,11 @@ 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 ArkService service = ArkService.builder().dispatcher(DEFAULT_DISPATCHER).connectionPool(DEFAULT_CONNECTION_POOL).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 +65,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
@@ -8,6 +8,9 @@
 import java.util.ArrayList;
 import java.util.List;
 
+import static com.volcengine.ark.runtime.service.ArkBaseService.DEFAULT_CONNECTION_POOL;
+import static com.volcengine.ark.runtime.service.ArkBaseService.DEFAULT_DISPATCHER;
+
 public class EmbeddingsExample {
 
     /**
@@ -25,11 +28,11 @@ 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 ArkService service = ArkService.builder().dispatcher(DEFAULT_DISPATCHER).connectionPool(DEFAULT_CONNECTION_POOL).apiKey(apiKey).build();
 
+    public static void main(String[] args) {
         System.out.println("\n----- embeddings request -----");
 
         List<String> inputs = new ArrayList<>();
@@ -42,7 +45,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,15 +1,16 @@
 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 java.util.ArrayList;
 import java.util.List;
 
+import static com.volcengine.ark.runtime.service.ArkBaseService.DEFAULT_CONNECTION_POOL;
+import static com.volcengine.ark.runtime.service.ArkBaseService.DEFAULT_DISPATCHER;
+
 public class TokenizationExample {
 
     /**
@@ -27,11 +28,11 @@ 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 ArkService service = ArkService.builder().dispatcher(DEFAULT_DISPATCHER).connectionPool(DEFAULT_CONNECTION_POOL).apiKey(apiKey).build();
 
+    public static void main(String[] args) {
         System.out.println("\n----- tokenization request -----");
         List<String> texts = new ArrayList<>();
         texts.add("花椰菜又称菜花、花菜，是一种常见的蔬菜。");
@@ -43,7 +44,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();
     }
 

Original file line number	Diff line number	Diff line change
`@@ -314,11 +314,13 @@ public ArkService build() {`
`314`	`314`	`if (connectionPool != null) {`
`315`	`315`	`clientBuilder.connectionPool(connectionPool);`
`316`	`316`	`} else {`
`317`		`- clientBuilder.connectionPool(new ConnectionPool(5, 1, TimeUnit.SECONDS));`
	`317`	`+ clientBuilder.connectionPool(DEFAULT_CONNECTION_POOL);`
`318`	`318`	`}`
`319`	`319`
`320`	`320`	`if (dispatcher != null) {`
`321`	`321`	`clientBuilder.dispatcher(dispatcher);`
	`322`	`+ } else {`
	`323`	`+ clientBuilder.dispatcher(DEFAULT_DISPATCHER);`
`322`	`324`	`}`
`323`	`325`
`324`	`326`	`OkHttpClient client = clientBuilder`