Improve sample code

Author: rpanackal

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

@@ -18,6 +18,7 @@
 import com.sap.ai.sdk.foundationmodels.openai.model.OpenAiChatCompletionParameters;
 import com.sap.ai.sdk.foundationmodels.openai.model.OpenAiChatCompletionTool;
 import com.sap.ai.sdk.foundationmodels.openai.model.OpenAiChatMessage;
+import com.sap.ai.sdk.foundationmodels.openai.model.OpenAiChatToolCall;
 import com.sap.ai.sdk.foundationmodels.openai.model.OpenAiEmbeddingOutput;
 import com.sap.ai.sdk.foundationmodels.openai.model.OpenAiEmbeddingParameters;
 import java.util.ArrayList;
@@ -103,7 +104,8 @@ public OpenAiChatCompletionOutput chatCompletionImage(@Nonnull final String link
   public OpenAiChatCompletionOutput chatCompletionToolExecution(
       @Nonnull final String location, @Nonnull final String unit) {
 
-    final var schemaMap = generateSchema(WeatherMethod.Request.class);
+    // 1. Define the function
+    final Map<String, Object> schemaMap = generateSchema(WeatherMethod.Request.class);
     final var function =
         new OpenAiChatCompletionFunction()
             .setName("weather")
@@ -116,19 +118,24 @@ public OpenAiChatCompletionOutput chatCompletionToolExecution(
         new OpenAiChatMessage.OpenAiChatUserMessage()
             .addText("What's the weather in %s in %s?".formatted(location, unit)));
 
+    // Assistant will call the function
     final var request =
         new OpenAiChatCompletionParameters()
             .addMessages(messages.toArray(OpenAiChatMessage[]::new))
             .setTools(List.of(tool));
 
-    final var response = OpenAiClient.forModel(GPT_4O_MINI).chatCompletion(request);
+    final OpenAiChatCompletionOutput response =
+        OpenAiClient.forModel(GPT_4O_MINI).chatCompletion(request);
 
-    final var toolCall = response.getChoices().get(0).getMessage().getToolCalls().get(0);
-    final var arguments =
+    // 2. Optionally, execute the function.
+    final OpenAiChatToolCall toolCall =
+        response.getChoices().get(0).getMessage().getToolCalls().get(0);
+    final WeatherMethod.Request arguments =
         parseJson(toolCall.getFunction().getArguments(), WeatherMethod.Request.class);
-    final var currentWeather = new WeatherMethod().getCurrentWeather(arguments);
+    final WeatherMethod.Response currentWeather = WeatherMethod.getCurrentWeather(arguments);
 
-    final var assistantMessage = response.getChoices().get(0).getMessage();
+    final OpenAiChatMessage.OpenAiChatAssistantMessage assistantMessage =
+        response.getChoices().get(0).getMessage();
     messages.add(assistantMessage);
 
     final var toolMessage =

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

@@ -35,7 +35,7 @@ record Response(double temp, Unit unit) {}
   @Nonnull
   @SuppressWarnings("unused")
   @Tool(description = "Get the weather in location")
-  Response getCurrentWeather(@ToolParam @Nonnull final Request request) {
+  static Response getCurrentWeather(@ToolParam @Nonnull final Request request) {
     final int temperature = request.location.hashCode() % 30;
     return new Response(temperature, request.unit);
   }

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

@@ -11,6 +11,7 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.module.jsonSchema.JsonSchemaGenerator;
 import com.sap.ai.sdk.core.AiCoreService;
+import com.sap.ai.sdk.foundationmodels.openai.OpenAiAssistantMessage;
 import com.sap.ai.sdk.foundationmodels.openai.OpenAiChatCompletionDelta;
 import com.sap.ai.sdk.foundationmodels.openai.OpenAiChatCompletionRequest;
 import com.sap.ai.sdk.foundationmodels.openai.OpenAiChatCompletionResponse;
@@ -20,6 +21,7 @@
 import com.sap.ai.sdk.foundationmodels.openai.OpenAiFunctionCall;
 import com.sap.ai.sdk.foundationmodels.openai.OpenAiImageItem;
 import com.sap.ai.sdk.foundationmodels.openai.OpenAiMessage;
+import com.sap.ai.sdk.foundationmodels.openai.OpenAiToolCall;
 import com.sap.ai.sdk.foundationmodels.openai.generated.model.ChatCompletionTool;
 import com.sap.ai.sdk.foundationmodels.openai.generated.model.FunctionObject;
 import java.util.ArrayList;
@@ -100,7 +102,8 @@ public OpenAiChatCompletionResponse chatCompletionImage(@Nonnull final String li
   public OpenAiChatCompletionResponse chatCompletionToolExecution(
       @Nonnull final String location, @Nonnull final String unit) {
 
-    var schemaMap = generateSchema(WeatherMethod.Request.class);
+    // 1. Define the function
+    Map<String, Object> schemaMap = generateSchema(WeatherMethod.Request.class);
     final var function =
         new FunctionObject()
             .name("weather")
@@ -111,23 +114,28 @@ public OpenAiChatCompletionResponse chatCompletionToolExecution(
     final var messages = new ArrayList<OpenAiMessage>();
     messages.add(OpenAiMessage.user("What's the weather in %s in %s?".formatted(location, unit)));
 
+    // Assistant will call the function
     final var request = new OpenAiChatCompletionRequest(messages).withTools(List.of(tool));
-    final var response = OpenAiClient.forModel(GPT_4O_MINI).chatCompletion(request);
+    final OpenAiChatCompletionResponse response =
+        OpenAiClient.forModel(GPT_4O_MINI).chatCompletion(request);
 
-    final var assistantMessage = response.getMessage();
+    // 2. Optionally, execute the function.
+    final OpenAiAssistantMessage assistantMessage = response.getMessage();
     messages.add(assistantMessage);
 
-    var toolCall = assistantMessage.toolCalls().get(0);
+    final OpenAiToolCall toolCall = assistantMessage.toolCalls().get(0);
     if (!(toolCall instanceof OpenAiFunctionCall functionCall)) {
       throw new IllegalArgumentException(
           "Expected a function call, but got: %s".formatted(assistantMessage));
     }
 
-    var arguments = parseJson(functionCall.getArguments(), WeatherMethod.Request.class);
-    var weatherMethod = new WeatherMethod().getCurrentWeather(arguments);
+    WeatherMethod.Request arguments =
+        parseJson(functionCall.getArguments(), WeatherMethod.Request.class);
+    WeatherMethod.Response weatherMethod = WeatherMethod.getCurrentWeather(arguments);
 
     messages.add(OpenAiMessage.tool(weatherMethod.toString(), functionCall.getId()));
 
+    // Send back the results, and the model will incorporate them into its final response.
     return OpenAiClient.forModel(GPT_4O_MINI).chatCompletion(request.withMessages(messages));
   }