Add convenience method OpenAiChatCompletionResponse#executeTools

Author: a-d

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

@@ -9,6 +9,7 @@
 import com.sap.ai.sdk.foundationmodels.openai.generated.model.CreateChatCompletionRequestAllOfResponseFormat;
 import com.sap.ai.sdk.foundationmodels.openai.generated.model.CreateChatCompletionRequestAllOfStop;
 import java.math.BigDecimal;
+import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
@@ -125,6 +126,15 @@ public class OpenAiChatCompletionRequest {
   /** List of tools that the model may invoke during the completion. */
   @Nullable List<ChatCompletionTool> tools;
 
+  /**
+   * List of tools that are executable at runtime of the application.
+   *
+   * @since 1.7.0
+   */
+  @Getter(value = AccessLevel.PACKAGE)
+  @Nullable
+  List<OpenAiTool> toolsExecutable;
+
   /** Option to control which tool is invoked by the model. */
   @With(AccessLevel.PRIVATE)
   @Nullable
@@ -179,6 +189,7 @@ public OpenAiChatCompletionRequest(@Nonnull final List<OpenAiMessage> messages)
         null,
         null,
         null,
+        null,
         null);
   }
 
@@ -226,6 +237,7 @@ public OpenAiChatCompletionRequest withParallelToolCalls(
             this.streamOptions,
             this.responseFormat,
             this.tools,
+            this.toolsExecutable,
             this.toolChoice);
   }
 
@@ -258,6 +270,7 @@ public OpenAiChatCompletionRequest withLogprobs(@Nonnull final Boolean logprobs)
             this.streamOptions,
             this.responseFormat,
             this.tools,
+            this.toolsExecutable,
             this.toolChoice);
   }
 
@@ -282,36 +295,35 @@ public OpenAiChatCompletionRequest withToolChoice(@Nonnull final OpenAiToolChoic
     return this.withToolChoice(choice.toolChoice);
   }
 
-  /**
-   * Sets the tools to be used in the request with convenience class {@code OpenAiTool}.
-   *
-   * @param tools the list of tools to be used
-   * @return a new OpenAiChatCompletionRequest instance with the specified tools
-   * @throws IllegalArgumentException if the tool type is not supported
-   * @since 1.7.0
-   */
-  @Nonnull
-  @Beta
-  public OpenAiChatCompletionRequest withToolsExecutable(@Nonnull final List<OpenAiTool> tools) {
-    return this.withTools(tools.stream().map(OpenAiTool::createChatCompletionTool).toList());
-  }
-
   /**
    * Converts the request to a generated model class CreateChatCompletionRequest.
    *
    * @return the CreateChatCompletionRequest
    */
   CreateChatCompletionRequest createCreateChatCompletionRequest() {
-    final var request = new CreateChatCompletionRequest();
-    this.messages.forEach(
-        message ->
-            request.addMessagesItem(OpenAiUtils.createChatCompletionRequestMessage(message)));
+    final var toolsCombined = new ArrayList<ChatCompletionTool>();
+    if (this.tools != null) {
+      toolsCombined.addAll(this.tools);
+    }
+    if (this.toolsExecutable != null) {
+      for (OpenAiTool tool : this.toolsExecutable) {
+        toolsCombined.add(tool.createChatCompletionTool());
+      }
+    }
 
-    request.stop(this.stop != null ? CreateChatCompletionRequestAllOfStop.create(this.stop) : null);
+    final var request = new CreateChatCompletionRequest();
+    for (OpenAiMessage message : this.messages) {
+      request.addMessagesItem(OpenAiUtils.createChatCompletionRequestMessage(message));
+    }
+    if (this.stop != null) {
+      request.stop(CreateChatCompletionRequestAllOfStop.create(this.stop));
+    }
+    if (!toolsCombined.isEmpty()) {
+      request.tools(toolsCombined);
+    }
 
     request.temperature(this.temperature);
     request.topP(this.topP);
-
     request.stream(null);
     request.maxTokens(this.maxTokens);
     request.maxCompletionTokens(this.maxCompletionTokens);
@@ -326,7 +338,6 @@ CreateChatCompletionRequest createCreateChatCompletionRequest() {
     request.seed(this.seed);
     request.streamOptions(this.streamOptions);
     request.responseFormat(this.responseFormat);
-    request.tools(this.tools);
     request.toolChoice(this.toolChoice);
     request.functionCall(null);
     request.functions(null);

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

@@ -28,6 +28,9 @@ public class OpenAiChatCompletionResponse {
   /** The original response from the OpenAI API. */
   @Nonnull CreateChatCompletionResponse originalResponse;
 
+  /** The original request that was sent to the OpenAI API. */
+  @Nonnull OpenAiChatCompletionRequest originalRequest;
+
   /**
    * Gets the token usage from the original response.
    *
@@ -96,4 +99,14 @@ public OpenAiAssistantMessage getMessage() {
 
     return new OpenAiAssistantMessage(new OpenAiMessageContent(contentItems), openAiToolCalls);
   }
+
+  /**
+   * Execute tool calls that were suggested by the assistant response.
+   *
+   * @return the list of tool messages that were serialized for the computed results. Empty list if
+   *     no tools were called.
+   */
+  public List<OpenAiToolMessage> executeTools() {
+    return OpenAiTool.execute(getOriginalRequest().getToolsExecutable(), getMessage());
+  }
 }

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

@@ -158,8 +158,8 @@ public OpenAiChatCompletionOutput chatCompletion(@Nonnull final String prompt)
   public OpenAiChatCompletionResponse chatCompletion(
       @Nonnull final OpenAiChatCompletionRequest request) throws OpenAiClientException {
     warnIfUnsupportedUsage();
-    return new OpenAiChatCompletionResponse(
-        chatCompletion(request.createCreateChatCompletionRequest()));
+    final var response = chatCompletion(request.createCreateChatCompletionRequest());
+    return new OpenAiChatCompletionResponse(response, request);
   }
 
   /**

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

@@ -111,14 +111,11 @@ public OpenAiChatCompletionResponse chatCompletionToolExecution(
     final var request = new OpenAiChatCompletionRequest(messages).withToolsExecutable(tools);
     final OpenAiChatCompletionResponse response = client.chatCompletion(request);
 
-    // 3. Execute the tool call for given tools
-    final OpenAiAssistantMessage assistantMessage = response.getMessage();
-    final List<OpenAiToolMessage> toolMessages = OpenAiTool.execute(tools, assistantMessage);
-
-    // 4. Return the results so that the model can incorporate them into the final response.
-    messages.add(assistantMessage);
-    messages.addAll(toolMessages);
+    // 3. Execute the tool calls
+    messages.add(response.getMessage());
+    messages.addAll(response.executeTools());
 
+    // 4. Have model run the final request with incorporated tool results
     return client.chatCompletion(request.withMessages(messages));
   }