Added an option to specify openAiApiKey and azureApiKey independently

Author: deep-learning-dynamo

src/main/java/dev/ai4j/openai4j/ApiKeyHeaderInjector.java

@@ -0,0 +1,27 @@
+package dev.ai4j.openai4j;
+
+import okhttp3.Interceptor;
+import okhttp3.Request;
+import okhttp3.Response;
+
+import java.io.IOException;
+
+class ApiKeyHeaderInjector implements Interceptor {
+
+ private final String apiKey;
+
+ ApiKeyHeaderInjector(String apiKey) {
+ this.apiKey = apiKey;
+ }
+
+ @Override
+ public Response intercept(Chain chain) throws IOException {
+
+ Request request = chain.request()
+ .newBuilder()
+ .addHeader("api-key", apiKey)
+ .build();
+
+ return chain.proceed(request);
+ }
+}

src/main/java/dev/ai4j/openai4j/ApiKeyInsertingInterceptor.java renamed to src/main/java/dev/ai4j/openai4j/AuthorizationHeaderInjector.java

@@ -6,11 +6,11 @@
 
 import java.io.IOException;
 
-class ApiKeyInsertingInterceptor implements Interceptor {
+class AuthorizationHeaderInjector implements Interceptor {
 
  private final String apiKey;
 
- ApiKeyInsertingInterceptor(String apiKey) {
+ AuthorizationHeaderInjector(String apiKey) {
  this.apiKey = apiKey;
  }
 

src/main/java/dev/ai4j/openai4j/OpenAiClient.java

@@ -35,7 +35,7 @@ public class OpenAiClient {
  private final boolean logStreamingResponses;
 
  public OpenAiClient(String apiKey) {
- this(builder().apiKey(apiKey));
+ this(builder().openAiApiKey(apiKey));
  }
 
  private OpenAiClient(Builder serviceBuilder) {
@@ -44,21 +44,32 @@ private OpenAiClient(Builder serviceBuilder) {
  this.apiVersion = serviceBuilder.apiVersion;
 
  OkHttpClient.Builder okHttpClientBuilder = new OkHttpClient.Builder()
- .addInterceptor(new ApiKeyInsertingInterceptor(serviceBuilder.apiKey))
  .callTimeout(serviceBuilder.callTimeout)
  .connectTimeout(serviceBuilder.connectTimeout)
  .readTimeout(serviceBuilder.readTimeout)
  .writeTimeout(serviceBuilder.writeTimeout);
 
+ if (serviceBuilder.openAiApiKey == null && serviceBuilder.azureApiKey == null) {
+ throw new IllegalArgumentException("openAiApiKey OR azureApiKey must be defined");
+ }
+ if (serviceBuilder.openAiApiKey != null && serviceBuilder.azureApiKey != null) {
+ throw new IllegalArgumentException("openAiApiKey AND azureApiKey cannot both be defined at the same time");
+ }
+ if (serviceBuilder.openAiApiKey != null) {
+ okHttpClientBuilder.addInterceptor(new AuthorizationHeaderInjector(serviceBuilder.openAiApiKey));
+ } else {
+ okHttpClientBuilder.addInterceptor(new ApiKeyHeaderInjector(serviceBuilder.azureApiKey));
+ }
+
  if (serviceBuilder.proxy != null) {
- okHttpClientBuilder = okHttpClientBuilder.proxy(serviceBuilder.proxy);
+ okHttpClientBuilder.proxy(serviceBuilder.proxy);
  }
 
  if (serviceBuilder.logRequests) {
- okHttpClientBuilder = okHttpClientBuilder.addInterceptor(new RequestLoggingInterceptor());
+ okHttpClientBuilder.addInterceptor(new RequestLoggingInterceptor());
  }
  if (serviceBuilder.logResponses) {
- okHttpClientBuilder = okHttpClientBuilder.addInterceptor(new ResponseLoggingInterceptor());
+ okHttpClientBuilder.addInterceptor(new ResponseLoggingInterceptor());
  }
  this.logStreamingResponses = serviceBuilder.logStreamingResponses;
 
@@ -97,7 +108,8 @@ public static class Builder {
 
  private String baseUrl = "https://api.openai.com/v1/";
  private String apiVersion;
- private String apiKey;
+ private String openAiApiKey;
+ private String azureApiKey;
  private Duration callTimeout = Duration.ofSeconds(60);
  private Duration connectTimeout = Duration.ofSeconds(60);
  private Duration readTimeout = Duration.ofSeconds(60);
@@ -133,11 +145,29 @@ public Builder apiVersion(String apiVersion) {
  return this;
  }
 
- public Builder apiKey(String apiKey) {
- if (apiKey == null || apiKey.trim().isEmpty()) {
- throw new IllegalArgumentException("API key cannot be null or empty. API keys can be generated here: https://platform.openai.com/account/api-keys");
+ /**
+ * @param openAiApiKey OpenAI API key.
+ * Will be injected in HTTP headers like this: "Authorization: Bearer ${openAiApiKey}"
+ * @return builder
+ */
+ public Builder openAiApiKey(String openAiApiKey) {
+ if (openAiApiKey == null || openAiApiKey.trim().isEmpty()) {
+ throw new IllegalArgumentException("openAiApiKey cannot be null or empty. API keys can be generated here: https://platform.openai.com/account/api-keys");
+ }
+ this.openAiApiKey = openAiApiKey;
+ return this;
+ }
+
+ /**
+ * @param azureApiKey Azure API key.
+ * Will be injected in HTTP headers like this: "api-key: ${azureApiKey}"
+ * @return builder
+ */
+ public Builder azureApiKey(String azureApiKey) {
+ if (azureApiKey == null || azureApiKey.trim().isEmpty()) {
+ throw new IllegalArgumentException("azureApiKey cannot be null or empty");
  }
- this.apiKey = apiKey;
+ this.azureApiKey = azureApiKey;
  return this;
  }
 

src/main/java/dev/ai4j/openai4j/RequestLoggingInterceptor.java

@@ -50,18 +50,20 @@ static String inOneLine(Headers headers) {
  .map(header -> {
  String headerKey = header.component1();
  String headerValue = header.component2();
- if (headerKey.contains("Authorization")) {
- headerValue = maskApiToken(headerValue);
+ if (headerKey.equals("Authorization")) {
+ headerValue = maskAuthorizationHeaderValue(headerValue);
+ } else if (headerKey.equals("api-key")) {
+ headerValue = maskApiKeyHeaderValue(headerValue);
  }
  return String.format("[%s: %s]", headerKey, headerValue);
  })
  .collect(joining(", "));
  }
 
- private static String maskApiToken(String request) {
+ private static String maskAuthorizationHeaderValue(String authorizationHeaderValue) {
  try {
 
- Matcher matcher = BEARER_PATTERN.matcher(request);
+ Matcher matcher = BEARER_PATTERN.matcher(authorizationHeaderValue);
 
  StringBuffer sb = new StringBuffer();
  while (matcher.find()) {
@@ -71,7 +73,20 @@ private static String maskApiToken(String request) {
 
  return sb.toString();
  } catch (Exception e) {
- return "Failed to mask the API key. Therefore, avoid logging the entire request.";
+ return "Failed to mask the API key.";
+ }
+ }
+
+ private static String maskApiKeyHeaderValue(String apiKeyHeaderValue) {
+ try {
+ if (apiKeyHeaderValue.length() <= 4) {
+ return apiKeyHeaderValue;
+ }
+ return apiKeyHeaderValue.substring(0, 2)
+ + "..."
+ + apiKeyHeaderValue.substring(apiKeyHeaderValue.length() - 2);
+ } catch (Exception e) {
+ return "Failed to mask the API key.";
  }
  }
 

src/test/java/dev/ai4j/openai4j/Test.java

@@ -1,8 +1,7 @@
 package dev.ai4j.openai4j;
 
-import dev.ai4j.openai4j.completion.CompletionRequest;
+import dev.ai4j.openai4j.chat.ChatCompletionRequest;
 
-import static java.net.Proxy.Type.HTTP;
 import static java.time.Duration.ofSeconds;
 
 public class Test {
@@ -12,23 +11,24 @@ public static void main(String[] args) {
  String apiKey = System.getenv("OPENAI_API_KEY");
 
  OpenAiClient client = OpenAiClient.builder()
- .baseUrl("https://my-resource.openai.azure.com/openai/deployments/my-deployment/")
- .apiVersion("2023-06-13")
- .apiKey(apiKey)
+ .openAiApiKey(apiKey)
+// .baseUrl("https://resource-name.openai.azure.com/openai/deployments/deployment-id/")
+// .apiVersion("2023-05-15")
+// .azureApiKey("...")
  .callTimeout(ofSeconds(60))
  .connectTimeout(ofSeconds(60))
  .readTimeout(ofSeconds(60))
  .writeTimeout(ofSeconds(60))
- .proxy(HTTP, "103.154.230.129", 8080)
+// .proxy(HTTP, "103.154.230.129", 8080)
  .logRequests()
  .logResponses()
  .logStreamingResponses()
  .build();
 
- CompletionRequest request = CompletionRequest.builder()
- .prompt("hello")
+ ChatCompletionRequest request = ChatCompletionRequest.builder()
+ .addUserMessage("hello")
  .build();
 
- System.out.println(client.completion(request).execute().text());
+ System.out.println(client.chatCompletion(request).execute().content());
  }
 }

src/test/java/dev/ai4j/openai4j/chat/ChatCompletionAsyncTest.java

@@ -23,7 +23,7 @@ class ChatCompletionAsyncTest extends RateLimitAwareTest {
  private static final String USER_MESSAGE = "write exactly the following 2 words: 'hello world'";
 
  private final OpenAiClient client = OpenAiClient.builder()
- .apiKey(System.getenv("OPENAI_API_KEY"))
+ .openAiApiKey(System.getenv("OPENAI_API_KEY"))
  .logRequests()
  .logResponses()
  .build();

src/test/java/dev/ai4j/openai4j/chat/ChatCompletionStreamingTest.java

@@ -21,7 +21,7 @@ class ChatCompletionStreamingTest extends RateLimitAwareTest {
  private static final String USER_MESSAGE = "write exactly the following 2 words: 'hello world'";
 
  private final OpenAiClient client = OpenAiClient.builder()
- .apiKey(System.getenv("OPENAI_API_KEY"))
+ .openAiApiKey(System.getenv("OPENAI_API_KEY"))
  .logRequests()
  .logResponses()
  .logStreamingResponses()

src/test/java/dev/ai4j/openai4j/chat/ChatCompletionTest.java

@@ -22,7 +22,7 @@ class ChatCompletionTest extends RateLimitAwareTest {
  private static final String USER_MESSAGE = "Write exactly the following 2 words: 'hello world'";
 
  private final OpenAiClient client = OpenAiClient.builder()
- .apiKey(System.getenv("OPENAI_API_KEY"))
+ .openAiApiKey(System.getenv("OPENAI_API_KEY"))
  .logRequests()
  .logResponses()
  .build();

src/test/java/dev/ai4j/openai4j/completion/CompletionAsyncTest.java

@@ -14,7 +14,7 @@ class CompletionAsyncTest extends RateLimitAwareTest {
  private static final String PROMPT = "write exactly the following 2 words: 'hello world'";
 
  private final OpenAiClient client = OpenAiClient.builder()
- .apiKey(System.getenv("OPENAI_API_KEY"))
+ .openAiApiKey(System.getenv("OPENAI_API_KEY"))
  .logRequests()
  .logResponses()
  .build();

src/test/java/dev/ai4j/openai4j/completion/CompletionStreamingTest.java

@@ -14,7 +14,7 @@ class CompletionStreamingTest extends RateLimitAwareTest {
  private static final String PROMPT = "write exactly the following 2 words: 'hello world'";
 
  private final OpenAiClient client = OpenAiClient.builder()
- .apiKey(System.getenv("OPENAI_API_KEY"))
+ .openAiApiKey(System.getenv("OPENAI_API_KEY"))
  .logRequests()
  .logResponses()
  .logStreamingResponses()