Added tests

Author: CharlesDuboisSAP

docs/guides/SPRING_AI_INTEGRATION.md

@@ -6,7 +6,7 @@
 - [Orchestration Chat Completion](#orchestration-chat-completion)
 - [Orchestration Masking](#orchestration-masking)
 - [Stream chat completion](#stream-chat-completion)
-- [Function Calling](#function-calling)
+- [Tool Calling](#tool-calling)
 
 ## Introduction
 
@@ -34,7 +34,7 @@ First, add the Spring AI dependency to your `pom.xml`:
 
 :::note Spring AI Milestone Version
 Note that currently no stable version of Spring AI exists just yet.
-The AI SDK currently uses the [M5 milestone](https://spring.io/blog/2024/12/23/spring-ai-1-0-0-m5-released).
+The AI SDK currently uses the [M6 milestone](https://spring.io/blog/2025/02/14/spring-ai-1-0-0-m6-released).
 
 Please be aware that future versions of the AI SDK may increase the Spring AI version.
 :::
@@ -102,7 +102,7 @@ _Note: A Spring endpoint can return `Flux` instead of `ResponseEntity`._
 
 Please find [an example in our Spring Boot application](../../sample-code/spring-app/src/main/java/com/sap/ai/sdk/app/services/SpringAiOrchestrationService.java).
 
-## Function Calling
+## Tool Calling
 
 First define a function that will be called by the LLM:
 
@@ -124,12 +124,12 @@ Then add your function to the options:
 OrchestrationChatOptions options = new OrchestrationChatOptions(config);
 options.setToolCallbacks(
     List.of(
-        ToolCallback.builder()
-            .function(
-                "CurrentWeather", new MockWeatherService()) // (1) function name and instance
+        FunctionToolCallback.builder(
+        "CurrentWeather", new MockWeatherService()) // (1) function name and instance
             .description("Get the weather in location") // (2) function description
             .inputType(MockWeatherService.Request.class) // (3) function input type
             .build()));
+options.setInternalToolExecutionEnabled(false);// tool execution is not yet available in orchestration
 Prompt prompt = new Prompt("What is the weather in Potsdam and in Toulouse?", options);
 
 ChatResponse response = client.call(prompt);

orchestration/pom.xml

@@ -31,11 +31,11 @@
   </developers>
   <properties>
     <project.rootdir>${project.basedir}/../</project.rootdir>
-    <coverage.complexity>79%</coverage.complexity>
+    <coverage.complexity>81%</coverage.complexity>
     <coverage.line>92%</coverage.line>
-    <coverage.instruction>92%</coverage.instruction>
-    <coverage.branch>73%</coverage.branch>
-    <coverage.method>90%</coverage.method>
+    <coverage.instruction>93%</coverage.instruction>
+    <coverage.branch>74%</coverage.branch>
+    <coverage.method>93%</coverage.method>
     <coverage.class>100%</coverage.class>
   </properties>
 

orchestration/src/test/java/com/sap/ai/sdk/orchestration/spring/OrchestrationChatModelTest.java

@@ -39,6 +39,7 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.mockito.Mockito;
+import org.springframework.ai.chat.messages.AssistantMessage.ToolCall;
 import org.springframework.ai.chat.model.ChatResponse;
 import org.springframework.ai.chat.prompt.Prompt;
 import org.springframework.ai.tool.function.FunctionToolCallback;
@@ -143,7 +144,44 @@ void testStreamCompletion() throws IOException {
   }
 
   @Test
-  void testToolCalls() throws IOException {
+  void testToolCallsWithoutExecution() throws IOException {
+    stubFor(
+        post(urlPathEqualTo("/completion"))
+            .willReturn(
+                aResponse()
+                    .withBodyFile("toolCallsResponse.json")
+                    .withHeader("Content-Type", "application/json")));
+
+    defaultOptions.setToolCallbacks(
+        List.of(
+            FunctionToolCallback.builder(
+                    "CurrentWeather", new MockWeatherService()) // (1) function name and instance
+                .description("Get the weather in location") // (2) function description
+                .inputType(MockWeatherService.Request.class) // (3) function input type
+                .build()));
+    defaultOptions.setInternalToolExecutionEnabled(false);
+    val prompt = new Prompt("What is the weather in Potsdam and in Toulouse?", defaultOptions);
+    val result = client.call(prompt);
+
+    List<ToolCall> toolCalls = result.getResult().getOutput().getToolCalls();
+    assertThat(toolCalls).hasSize(2);
+    ToolCall toolCall1 = toolCalls.get(0);
+    ToolCall toolCall2 = toolCalls.get(1);
+    assertThat(toolCall1.type()).isEqualTo("function");
+    assertThat(toolCall2.type()).isEqualTo("function");
+    assertThat(toolCall1.name()).isEqualTo("CurrentWeather");
+    assertThat(toolCall2.name()).isEqualTo("CurrentWeather");
+    assertThat(toolCall1.arguments()).isEqualTo("{\"location\": \"Potsdam\", \"unit\": \"C\"}");
+    assertThat(toolCall2.arguments()).isEqualTo("{\"location\": \"Toulouse\", \"unit\": \"C\"}");
+
+    try (var request1InputStream = fileLoader.apply("toolCallsRequest.json")) {
+      final String request1 = new String(request1InputStream.readAllBytes());
+      verify(postRequestedFor(anyUrl()).withRequestBody(equalToJson(request1)));
+    }
+  }
+
+  @Test
+  void testToolCallsWithExecution() throws IOException {
     // https://platform.openai.com/docs/guides/function-calling
     stubFor(
         post(urlPathEqualTo("/completion"))

sample-code/spring-app/src/main/java/com/sap/ai/sdk/app/controllers/SpringAiOrchestrationController.java

@@ -5,6 +5,7 @@
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import lombok.val;
+import org.springframework.ai.chat.messages.AssistantMessage;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -63,16 +64,19 @@ Object masking(@Nullable @RequestParam(value = "format", required = false) final
     return response.getResult().getOutput().getText();
   }
 
-  @GetMapping("/functionCalling")
-  Object functionCalling(
+  @GetMapping("/toolCalling")
+  Object toolCalling(
       @Nullable @RequestParam(value = "format", required = false) final String format) {
-    val response = service.functionCalling();
+    // tool execution broken on orchestration https://jira.tools.sap/browse/AI-86627
+    val response = service.toolCalling(false);
 
     if ("json".equals(format)) {
       return ((OrchestrationSpringChatResponse) response)
           .getOrchestrationResponse()
           .getOriginalResponse();
     }
-    return response.getResult().getOutput().getText();
+    final AssistantMessage message = response.getResult().getOutput();
+    final String text = message.getText();
+    return text.isEmpty() ? message.getToolCalls().toString() : text;
   }
 }

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

@@ -92,22 +92,24 @@ public ChatResponse masking() {
 
   /**
    * Register a function that will be called when the user asks for the weather. <a
-   * href="https://docs.spring.io/spring-ai/reference/api/chat/functions/openai-chat-functions.html#_registercall_functions_with_prompt_options">Spring
+   * href="https://docs.spring.io/spring-ai/reference/api/tools.html#_programmatic_specification_functiontoolcallback">Spring
    * AI Function Calling</a>
    *
    * @return the assistant response object
    */
   @Nonnull
-  public ChatResponse functionCalling() {
+  public ChatResponse toolCalling(final boolean internalToolExecutionEnabled) {
     final OrchestrationChatOptions options = new OrchestrationChatOptions(config);
     options.setToolCallbacks(
         List.of(
-            FunctionToolCallback.builder("CurrentWeather", new MockWeatherService())
+            FunctionToolCallback.builder(
+                    "CurrentWeather", new MockWeatherService()) // (1) function name and instance
                 .description("Get the weather in location") // (2) function description
                 .inputType(MockWeatherService.Request.class) // (3) function input type
                 .build()));
-    val prompt = new Prompt("What is the weather in Potsdam and in Toulouse?", options);
+    options.setInternalToolExecutionEnabled(internalToolExecutionEnabled);
 
+    val prompt = new Prompt("What is the weather in Potsdam and in Toulouse?", options);
     return client.call(prompt);
   }
 }

sample-code/spring-app/src/main/resources/static/index.html

@@ -566,8 +566,8 @@ <h5 class="mb-1">Orchestration Integration</h5>
                             </li>
                             <li class="list-group-item">
                                 <div class="info-tooltip">
-                                    <button type="submit" formaction="/spring-ai-orchestration/functionCalling" class="link-offset-2-hover link-underline link-underline-opacity-0 link-underline-opacity-75-hover endpoint">
-                                        <code>/spring-ai-orchestration/functionCalling</code>
+                                    <button type="submit" formaction="/spring-ai-orchestration/toolCalling" class="link-offset-2-hover link-underline link-underline-opacity-0 link-underline-opacity-75-hover endpoint">
+                                        <code>/spring-ai-orchestration/toolCalling</code>
                                     </button>
                                     <div class="tooltip-content">
                                         Register a function that will be called when the user asks for the weather.

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

@@ -1,11 +1,15 @@
 package com.sap.ai.sdk.app.controllers;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
 
 import com.sap.ai.sdk.app.services.SpringAiOrchestrationService;
+import com.sap.ai.sdk.orchestration.OrchestrationClientException;
+import java.util.List;
 import java.util.concurrent.atomic.AtomicInteger;
 import lombok.extern.slf4j.Slf4j;
 import org.junit.jupiter.api.Test;
+import org.springframework.ai.chat.messages.AssistantMessage.ToolCall;
 import org.springframework.ai.chat.model.ChatResponse;
 
 @Slf4j
@@ -53,4 +57,27 @@ void testMasking() {
     assertThat(response).isNotNull();
     assertThat(response.getResult().getOutput().getText()).isNotEmpty();
   }
+
+  @Test
+  void testToolCallingWithoutExecution() {
+    ChatResponse response = service.toolCalling(false);
+    List<ToolCall> toolCalls = response.getResult().getOutput().getToolCalls();
+    assertThat(toolCalls).hasSize(2);
+    ToolCall toolCall1 = toolCalls.get(0);
+    ToolCall toolCall2 = toolCalls.get(1);
+    assertThat(toolCall1.type()).isEqualTo("function");
+    assertThat(toolCall2.type()).isEqualTo("function");
+    assertThat(toolCall1.name()).isEqualTo("CurrentWeather");
+    assertThat(toolCall2.name()).isEqualTo("CurrentWeather");
+    assertThat(toolCall1.arguments()).isEqualTo("{\"location\": \"Potsdam\", \"unit\": \"C\"}");
+    assertThat(toolCall2.arguments()).isEqualTo("{\"location\": \"Toulouse\", \"unit\": \"C\"}");
+  }
+
+  @Test
+  void testToolCallingWithExecution() {
+    // tool execution broken on orchestration https://jira.tools.sap/browse/AI-86627
+    assertThatThrownBy(() -> service.toolCalling(true))
+        .isExactlyInstanceOf(OrchestrationClientException.class)
+        .hasMessageContaining("Request failed with status 400 Bad Request");
+  }
 }