Enable CI, fix LogLevel NPE (#12)

Author: LangChain4j

.github/workflows/main.yaml

@@ -0,0 +1,29 @@
+name: Java CI
+
+on:
+ push:
+ branches:
+ - main
+ pull_request:
+ branches:
+ - main
+
+jobs:
+ java_build:
+ strategy:
+ matrix:
+ java_version: [ 8, 11, 17, 21 ]
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ - name: Set up JDK ${{ matrix.java_version }}
+ uses: actions/setup-java@v4
+ with:
+ java-version: ${{ matrix.java_version }}
+ distribution: 'temurin'
+ cache: 'maven'
+ - name: Build with JDK ${{ matrix.java_version }}
+ run: mvn -B clean test ${{ matrix.included_modules }}
+ env:
+ OPENAI_BASE_URL: 'http://langchain4j.dev:8082/v1'
+ OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}

.github/workflows/release.yml

@@ -24,7 +24,7 @@ jobs:
  gpg-passphrase: GPG_PASSPHRASE
 
  - name: release
- run: mvn -B clean deploy -Psign -DskipTests
+ run: mvn -B clean deploy -Psign
  env:
  OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
  GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}

README.md

@@ -64,6 +64,7 @@ Customizable way:
 String apiKey = System.getenv("OPENAI_API_KEY");
 
 OpenAiClient client = OpenAiClient.builder()
+.baseUrl(baseUrl)
 .openAiApiKey(apiKey)
 .organizationId(orgId)
 .callTimeout(ofSeconds(60))
@@ -91,7 +92,7 @@ Customizable way:
 
 ```
 CompletionRequest request = CompletionRequest.builder()
-.model(TEXT_DAVINCI_003)
+.model(GPT_3_5_TURBO_INSTRUCT)
 .prompt("Write a poem about ChatGPT")
 .temperature(0.9)
 ...
@@ -115,7 +116,7 @@ Customizable way:
 
 ```
 CompletionRequest request = CompletionRequest.builder()
-.model(TEXT_DAVINCI_003)
+.model(GPT_3_5_TURBO_INSTRUCT)
 .prompt("Write a poem about ChatGPT")
 .temperature(0.9)
 ...
@@ -143,7 +144,7 @@ Customizable way:
 
 ```
 CompletionRequest request = CompletionRequest.builder()
-.model(TEXT_DAVINCI_003)
+.model(GPT_3_5_TURBO_INSTRUCT)
 .prompt("Write a poem about ChatGPT")
 .temperature(0.9)
 ...

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

@@ -21,6 +21,8 @@
 import dev.ai4j.openai4j.spi.OpenAiClientBuilderFactory;
 import dev.ai4j.openai4j.spi.ServiceHelper;
 
+import static dev.ai4j.openai4j.LogLevel.DEBUG;
+
 public abstract class OpenAiClient {
 
  public abstract SyncOrAsyncOrStreaming<CompletionResponse> completion(CompletionRequest request);
@@ -67,7 +69,7 @@ public abstract static class Builder<T extends OpenAiClient, B extends Builder<T
  public Proxy proxy;
  public boolean logRequests;
  public boolean logResponses;
- public LogLevel logLevel;
+ public LogLevel logLevel = DEBUG;
  public boolean logStreamingResponses;
  public Path persistTo;
 
@@ -190,7 +192,7 @@ public B logRequests(Boolean logRequests) {
 
  public B logLevel(LogLevel logLevel) {
  if (logLevel == null) {
- logLevel = LogLevel.DEBUG;
+ logLevel = DEBUG;
  }
  this.logLevel = logLevel;
  return (B) this;

src/main/java/dev/ai4j/openai4j/completion/CompletionModel.java

@@ -2,7 +2,7 @@
 
 public enum CompletionModel {
 
- TEXT_DAVINCI_003("text-davinci-003");
+ GPT_3_5_TURBO_INSTRUCT("gpt-3.5-turbo-instruct");
 
  private final String value;
 

src/main/java/dev/ai4j/openai4j/completion/CompletionRequest.java

@@ -4,7 +4,7 @@
 import java.util.Map;
 import java.util.Objects;
 
-import static dev.ai4j.openai4j.completion.CompletionModel.TEXT_DAVINCI_003;
+import static dev.ai4j.openai4j.completion.CompletionModel.GPT_3_5_TURBO_INSTRUCT;
 import static java.util.Collections.unmodifiableList;
 import static java.util.Collections.unmodifiableMap;
 
@@ -186,7 +186,7 @@ public static Builder builder() {
 
  public static final class Builder {
 
- private String model = TEXT_DAVINCI_003.toString();
+ private String model = GPT_3_5_TURBO_INSTRUCT.toString();
  private String prompt;
  private String suffix;
  private Integer maxTokens;

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

@@ -25,6 +25,7 @@
 class ChatCompletionAsyncTest extends RateLimitAwareTest {
 
  private final OpenAiClient client = OpenAiClient.builder()
+ .baseUrl(System.getenv("OPENAI_BASE_URL"))
  .openAiApiKey(System.getenv("OPENAI_API_KEY"))
  .logRequests()
  .logResponses()

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

@@ -28,6 +28,7 @@
 class ChatCompletionStreamingTest extends RateLimitAwareTest {
 
  private final OpenAiClient client = OpenAiClient.builder()
+ .baseUrl(System.getenv("OPENAI_BASE_URL"))
  .openAiApiKey(System.getenv("OPENAI_API_KEY"))
  .logRequests()
  .logResponses()
@@ -754,34 +755,51 @@ void testGpt4Vision() throws Exception {
  @Test
  void testCancelStreamingAfterStreamingStarted() throws Exception {
 
+ OpenAiClient client = OpenAiClient.builder()
+ // without caching
+ .openAiApiKey(System.getenv("OPENAI_API_KEY"))
+ .logRequests()
+ .logResponses()
+ .logStreamingResponses()
+ .build();
+
  AtomicBoolean streamingStarted = new AtomicBoolean(false);
  AtomicBoolean streamingCancelled = new AtomicBoolean(false);
  AtomicBoolean cancellationSucceeded = new AtomicBoolean(true);
 
  ResponseHandle responseHandle = client.chatCompletion("Write a poem about AI in 10 words")
  .onPartialResponse(partialResponse -> {
  streamingStarted.set(true);
+ System.out.println("[[streaming started]]");
  if (streamingCancelled.get()) {
  cancellationSucceeded.set(false);
+ System.out.println("[[cancellation failed]]");
  }
  })
- .onComplete(() -> cancellationSucceeded.set(false))
- .onError(e -> cancellationSucceeded.set(false))
+ .onComplete(() -> {
+ cancellationSucceeded.set(false);
+ System.out.println("[[cancellation failed]]");
+ })
+ .onError(e -> {
+ cancellationSucceeded.set(false);
+ System.out.println("[[cancellation failed]]");
+ })
  .execute();
 
  while (!streamingStarted.get()) {
- Thread.sleep(200);
+ Thread.sleep(10);
  }
 
  newSingleThreadExecutor().execute(() -> {
  responseHandle.cancel();
  streamingCancelled.set(true);
+ System.out.println("[[streaming cancelled]]");
  });
 
  while (!streamingCancelled.get()) {
- Thread.sleep(200);
+ Thread.sleep(10);
  }
- Thread.sleep(5000);
+ Thread.sleep(2000);
 
  assertThat(cancellationSucceeded).isTrue();
  }
@@ -792,22 +810,32 @@ void testCancelStreamingBeforeStreamingStarted() throws Exception {
  AtomicBoolean cancellationSucceeded = new AtomicBoolean(true);
 
  ResponseHandle responseHandle = client.chatCompletion("Write a poem about AI in 10 words")
- .onPartialResponse(partialResponse -> cancellationSucceeded.set(false))
- .onComplete(() -> cancellationSucceeded.set(false))
- .onError(e -> cancellationSucceeded.set(false))
+ .onPartialResponse(partialResponse -> {
+ cancellationSucceeded.set(false);
+ System.out.println("[[cancellation failed]]");
+ })
+ .onComplete(() -> {
+ cancellationSucceeded.set(false);
+ System.out.println("[[cancellation failed]]");
+ })
+ .onError(e -> {
+ cancellationSucceeded.set(false);
+ System.out.println("[[cancellation failed]]");
+ })
  .execute();
 
  AtomicBoolean streamingCancelled = new AtomicBoolean(false);
 
  newSingleThreadExecutor().execute(() -> {
  responseHandle.cancel();
  streamingCancelled.set(true);
+ System.out.println("[[streaming cancelled]]");
  });
 
  while (!streamingCancelled.get()) {
- Thread.sleep(200);
+ Thread.sleep(10);
  }
- Thread.sleep(5000);
+ Thread.sleep(2000);
 
  assertThat(cancellationSucceeded).isTrue();
  }

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

@@ -35,6 +35,7 @@ class ChatCompletionTest extends RateLimitAwareTest {
  static final Tool WEATHER_TOOL = Tool.from(WEATHER_FUNCTION);
 
  private final OpenAiClient client = OpenAiClient.builder()
+ .baseUrl(System.getenv("OPENAI_BASE_URL"))
  .openAiApiKey(System.getenv("OPENAI_API_KEY"))
  .logRequests()
  .logResponses()

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

@@ -14,6 +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()
+ .baseUrl(System.getenv("OPENAI_BASE_URL"))
  .openAiApiKey(System.getenv("OPENAI_API_KEY"))
  .logRequests()
  .logResponses()