Reverted the intermediate result class; OpenAiTool#execute will directly return the tool message list

Author: a-d

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

@@ -28,7 +28,6 @@
 import lombok.AccessLevel;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
-import lombok.RequiredArgsConstructor;
 import lombok.Setter;
 import lombok.Value;
 import lombok.With;
@@ -163,14 +162,34 @@ private static SchemaGenerator createSchemaGenerator() {
    *
    * @param tools the list of tools to execute
    * @param msg the assistant message containing a list of tool calls with arguments
-   * @return a result object that contains the list of tool messages with the results
+   * @return The list of tool messages with the results.
    */
   @Beta
   @Nonnull
-  public static Execution execute(
+  public static List<OpenAiToolMessage> execute(
       @Nonnull final List<OpenAiTool> tools, @Nonnull final OpenAiAssistantMessage msg) {
-    final var result = new LinkedHashMap<OpenAiFunctionCall, Object>();
+    final var toolResults = executeInternal(tools, msg);
+    final var result = new ArrayList<OpenAiToolMessage>();
+    for (final var entry : toolResults.entrySet()) {
+      final var functionCall = entry.getKey().getId();
+      final var serializedValue = serializeObject(entry.getValue());
+      result.add(OpenAiMessage.tool(serializedValue, functionCall));
+    }
+    return result;
+  }
 
+  /**
+   * Executes the given tool calls with the provided tools and returns the results as a list of
+   * {@link OpenAiToolMessage} containing execution results encoded as JSON string.
+   *
+   * @param tools the list of tools to execute
+   * @param msg the assistant message containing a list of tool calls with arguments
+   * @return a map that contains the function calls and their respective tool results.
+   */
+  @Nonnull
+  protected static Map<OpenAiFunctionCall, Object> executeInternal(
+      @Nonnull final List<OpenAiTool> tools, @Nonnull final OpenAiAssistantMessage msg) {
+    final var result = new LinkedHashMap<OpenAiFunctionCall, Object>();
     final var toolMap = tools.stream().collect(Collectors.toMap(OpenAiTool::getName, identity()));
     for (final OpenAiToolCall toolCall : msg.toolCalls()) {
       if (toolCall instanceof OpenAiFunctionCall functionCall) {
@@ -183,7 +202,7 @@ public static Execution execute(
         result.put(functionCall, toolResult);
       }
     }
-    return new Execution(result);
+    return result;
   }
 
   @Nonnull
@@ -202,31 +221,4 @@ private static String serializeObject(@Nonnull final Object obj) throws IllegalA
       throw new IllegalArgumentException("Failed to serialize object to JSON", e);
     }
   }
-
-  /**
-   * Represents the result of executing a tool call, containing the results of the function calls.
-   */
-  @RequiredArgsConstructor
-  @Beta
-  public static class Execution {
-    @Getter @Beta @Nonnull private final Map<OpenAiFunctionCall, Object> results;
-
-    /**
-     * Creates a new list of serialized OpenAI tool messages.
-     *
-     * @return the list of serialized OpenAI tool messages.
-     * @throws IllegalArgumentException if the tool results cannot be serialized to JSON
-     */
-    @Beta
-    @Nonnull
-    public List<OpenAiToolMessage> getMessages() {
-      final var result = new ArrayList<OpenAiToolMessage>();
-      for (final var entry : getResults().entrySet()) {
-        final var functionCall = entry.getKey().getId();
-        final var serializedValue = serializeObject(entry.getValue());
-        result.add(OpenAiMessage.tool(serializedValue, functionCall));
-      }
-      return result;
-    }
-  }
 }

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

@@ -5,7 +5,6 @@
 
 import java.util.Collections;
 import java.util.List;
-import java.util.Map;
 import java.util.function.Function;
 import lombok.EqualsAndHashCode;
 import org.junit.jupiter.api.Test;
@@ -64,17 +63,11 @@ void executeToolsValid() {
             .withArgument(Dummy.Request.class)
             .withName("functionA");
     final var assistMsg = new OpenAiAssistantMessage(EMPTY_MSG_CONTENT, List.of(FUNCTION_CALL_A));
-    final var execution = OpenAiTool.execute(List.of(toolA), assistMsg);
+    final var toolMsgs = OpenAiTool.execute(List.of(toolA), assistMsg);
 
-    final var results = execution.getResults();
-    assertThat(results)
-        .hasSize(1)
-        .containsExactly(Map.entry(FUNCTION_CALL_A, new Dummy.Response("value")));
-
-    final var toolMsg = execution.getMessages();
-    assertThat(toolMsg).hasSize(1);
-    assertThat(toolMsg.get(0).toolCallId()).isEqualTo("1");
-    assertThat(((OpenAiTextItem) toolMsg.get(0).content().items().get(0)).text())
+    assertThat(toolMsgs).hasSize(1);
+    assertThat(toolMsgs.get(0).toolCallId()).isEqualTo("1");
+    assertThat(((OpenAiTextItem) toolMsgs.get(0).content().items().get(0)).text())
         .isEqualTo("{\"toolMsg\":\"value\"}");
   }
 
@@ -85,9 +78,8 @@ void executeToolsNoMatchingCall() {
             .withArgument(Dummy.Request.class)
             .withName("functionA");
     final var assistMsg = new OpenAiAssistantMessage(EMPTY_MSG_CONTENT, List.of(FUNCTION_CALL_B));
-    final var executions = OpenAiTool.execute(List.of(toolA), assistMsg);
-    assertThat(executions.getResults()).isEmpty();
-    assertThat(executions.getMessages()).isEmpty();
+    final var toolMsgs = OpenAiTool.execute(List.of(toolA), assistMsg);
+    assertThat(toolMsgs).isEmpty();
   }
 
   @Test
@@ -106,12 +98,8 @@ class NonSerializableResponse {
     final var toolA =
         OpenAiTool.forFunction(badF).withArgument(Dummy.Request.class).withName("functionA");
     final var assistMsg = new OpenAiAssistantMessage(EMPTY_MSG_CONTENT, List.of(FUNCTION_CALL_A));
-    final var executions = OpenAiTool.execute(List.of(toolA), assistMsg);
-
-    assertThat(executions.getResults())
-        .containsExactly(Map.entry(FUNCTION_CALL_A, new NonSerializableResponse("value")));
 
-    assertThatThrownBy(executions::getMessages)
+    assertThatThrownBy(() -> OpenAiTool.execute(List.of(toolA), assistMsg))
         .isInstanceOf(IllegalArgumentException.class)
         .hasMessageContaining("Failed to serialize object to JSON");
   }

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

@@ -15,6 +15,7 @@
 import com.sap.ai.sdk.foundationmodels.openai.OpenAiImageItem;
 import com.sap.ai.sdk.foundationmodels.openai.OpenAiMessage;
 import com.sap.ai.sdk.foundationmodels.openai.OpenAiTool;
+import com.sap.ai.sdk.foundationmodels.openai.OpenAiToolMessage;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.stream.Stream;
@@ -112,11 +113,11 @@ public OpenAiChatCompletionResponse chatCompletionToolExecution(
 
     // 3. Execute the tool call for given tools
     final OpenAiAssistantMessage assistantMessage = response.getMessage();
-    final var toolResults = OpenAiTool.execute(tools, assistantMessage);
+    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(toolResults.getMessages());
+    messages.addAll(toolMessages);
 
     return client.chatCompletion(request.withMessages(messages));
   }