Move from static factory to constructor based initialization in OpenAiPrompt

Author: rpanackal

foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/OpenAiChatCompletionPrompt.java

@@ -15,19 +15,15 @@ public class OpenAiChatCompletionPrompt {
 
   @Nonnull private final List<String> stop = new ArrayList<>();
 
-  private OpenAiChatCompletionPrompt(@Nonnull final List<OpenAiMessage> messages) {
-    this.messages.addAll(messages);
-  }
-
   /**
    * Creates an OpenAiChatCompletionPrompt with a single message.
    *
    * @param message the message to be added to the prompt
    * @return a new OpenAiChatCompletionPrompt instance
    */
   @Nonnull
-  public static OpenAiChatCompletionPrompt create(@Nonnull final String message) {
-    return create(OpenAiMessage.user(message));
+  public OpenAiChatCompletionPrompt(@Nonnull final String message) {
+    messages.add(OpenAiMessage.user(message));
   }
 
   /**
@@ -38,25 +34,10 @@ public static OpenAiChatCompletionPrompt create(@Nonnull final String message) {
    * @return a new OpenAiChatCompletionPrompt instance
    */
   @Nonnull
-  public static OpenAiChatCompletionPrompt create(
+  public OpenAiChatCompletionPrompt(
       @Nonnull final OpenAiMessage message, @Nonnull final OpenAiMessage... messages) {
-    final var messagesList = new ArrayList<OpenAiMessage>();
-
-    messagesList.add(message);
-    messagesList.addAll(Arrays.asList(messages));
-
-    return create(messagesList);
-  }
-
-  /**
-   * Creates an OpenAiChatCompletionPrompt with a list of messages.
-   *
-   * @param messages the list of messages to be added to the prompt
-   * @return a new OpenAiChatCompletionPrompt instance
-   */
-  @Nonnull
-  public static OpenAiChatCompletionPrompt create(@Nonnull final List<OpenAiMessage> messages) {
-    return new OpenAiChatCompletionPrompt(messages);
+    this.messages.add(message);
+    this.messages.addAll(Arrays.asList(messages));
   }
 
   /**

foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/OpenAiClient.java

@@ -178,8 +178,8 @@ public OpenAiChatCompletionOutput chatCompletion(@Nonnull final String prompt)
 
     final var openAiPrompt =
         (systemPrompt != null)
-            ? OpenAiChatCompletionPrompt.create(systemPrompt, userPrompt)
-            : OpenAiChatCompletionPrompt.create(userPrompt);
+            ? new OpenAiChatCompletionPrompt(systemPrompt, userPrompt)
+            : new OpenAiChatCompletionPrompt(userPrompt);
 
     return chatCompletion(
         toCreateChatCompletionRequest(openAiPrompt, new OpenAiChatCompletionConfig()));
@@ -261,8 +261,8 @@ public Stream<String> streamChatCompletion(@Nonnull final String prompt)
 
     final var openAiPrompt =
         systemPrompt != null
-            ? OpenAiChatCompletionPrompt.create(systemPrompt, userPrompt)
-            : OpenAiChatCompletionPrompt.create(userPrompt);
+            ? new OpenAiChatCompletionPrompt(systemPrompt, userPrompt)
+            : new OpenAiChatCompletionPrompt(userPrompt);
 
     return streamChatCompletionDeltas(
             toCreateChatCompletionRequest(openAiPrompt, new OpenAiChatCompletionConfig()))

foundation-models/openai/src/test/java/com/sap/ai/sdk/foundationmodels/openai/OpenAiClientTest.java

@@ -80,10 +80,10 @@ void reset() {
 
   private static Runnable[] errorHandlingCalls() {
     return new Runnable[] {
-      () -> client.chatCompletion(OpenAiChatCompletionPrompt.create("")),
+      () -> client.chatCompletion(new OpenAiChatCompletionPrompt("")),
       () ->
           client
-              .streamChatCompletionDeltas(OpenAiChatCompletionPrompt.create(""))
+              .streamChatCompletionDeltas(new OpenAiChatCompletionPrompt(""))
               // the stream needs to be consumed to parse the response
               .forEach(System.out::println)
     };
@@ -94,7 +94,7 @@ private static Callable<?>[] chatCompletionCalls() {
       () -> {
         final var systemMessage = OpenAiMessage.system("You are a helpful AI");
         final var userMessage = OpenAiMessage.user("Hello World! Why is this phrase so famous?");
-        final var prompt = OpenAiChatCompletionPrompt.create(systemMessage, userMessage);
+        final var prompt = new OpenAiChatCompletionPrompt(systemMessage, userMessage);
         return client.chatCompletion(prompt);
       },
       () ->
@@ -181,22 +181,22 @@ void chatCompletionErrorHandling(@Nonnull final Runnable request) {
   @Test
   void apiVersion() {
     stubFor(post(anyUrl()).willReturn(okJson("{}")));
-    Try.of(() -> client.chatCompletion(OpenAiChatCompletionPrompt.create("")));
+    Try.of(() -> client.chatCompletion(new OpenAiChatCompletionPrompt("")));
 
     verify(
         exactly(1),
         postRequestedFor(anyUrl()).withQueryParam("api-version", equalTo("2024-02-01")));
 
     Try.of(
         () ->
-            client.withApiVersion("fooBar").chatCompletion(OpenAiChatCompletionPrompt.create("")));
+            client.withApiVersion("fooBar").chatCompletion(new OpenAiChatCompletionPrompt("")));
     verify(exactly(1), postRequestedFor(anyUrl()).withQueryParam("api-version", equalTo("fooBar")));
 
     assertThat(client)
         .describedAs(
             "withApiVersion should return a new object, the sut object should remain unchanged")
         .isNotSameAs(client.withApiVersion("fooBar"));
-    Try.of(() -> client.chatCompletion(OpenAiChatCompletionPrompt.create("")));
+    Try.of(() -> client.chatCompletion(new OpenAiChatCompletionPrompt("")));
     verify(
         exactly(2),
         postRequestedFor(anyUrl()).withQueryParam("api-version", equalTo("2024-02-01")));
@@ -453,7 +453,7 @@ void streamChatCompletionDeltasErrorHandling() throws IOException {
       doReturn(mockResponse).when(httpClient).executeOpen(any(), any(), any());
 
       final var prompt =
-          OpenAiChatCompletionPrompt.create(
+          new OpenAiChatCompletionPrompt(
               "Can you give me the first 100 numbers of the Fibonacci sequence?");
 
       try (Stream<OpenAiChatCompletionDelta> stream = client.streamChatCompletionDeltas(prompt)) {
@@ -483,7 +483,7 @@ void streamChatCompletionDeltas() throws IOException {
       doReturn(mockResponse).when(httpClient).executeOpen(any(), any(), any());
 
       final var prompt =
-          OpenAiChatCompletionPrompt.create(
+          new OpenAiChatCompletionPrompt(
               "Can you give me the first 100 numbers of the Fibonacci sequence?");
 
       try (Stream<OpenAiChatCompletionDelta> stream = client.streamChatCompletionDeltas(prompt)) {

sample-code/spring-app/src/main/java/com/sap/ai/sdk/app/services/OpenAiService.java

@@ -149,7 +149,7 @@ public OpenAiChatCompletionOutput chatCompletionTools(@Nonnull final String desc
     var config = new OpenAiChatCompletionConfig().tools(List.of(tool)).toolChoice(toolChoice);
 
     var prompt =
-        OpenAiChatCompletionPrompt.create(
+        new OpenAiChatCompletionPrompt(
             "A pair of rabbits is placed in a field. Each month, every pair produces one new pair, starting from the second month. How many rabbits will there be after 12 months?");
 
     return OpenAiClient.forModel(GPT_35_TURBO).chatCompletion(prompt, config);

sample-code/spring-app/src/test/java/com/sap/ai/sdk/app/controllers/OpenAiTest.java

@@ -47,7 +47,7 @@ void chatCompletionImage() {
   @Test
   void streamChatCompletion() {
     final var userMessage = OpenAiMessage.user("Who is the prettiest?");
-    final var prompt = OpenAiChatCompletionPrompt.create(userMessage);
+    final var prompt = new OpenAiChatCompletionPrompt(userMessage);
 
     final var totalOutput = new AtomicReference<CompletionUsage>();
     final var filledDeltaCount = new AtomicInteger(0);