test: update Javadoc to include exception details and enhance test coverage for OpenAiFunctionCall and OpenAiFunctionTool

Author: rpanackal

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

@@ -287,6 +287,7 @@ public OpenAiChatCompletionRequest withToolChoice(@Nonnull final OpenAiToolChoic
    *
    * @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

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

@@ -63,6 +63,7 @@ ChatCompletionTool createChatCompletionTool() {
       throw new IllegalArgumentException("Could not generate schema for " + clazz.getTypeName(), e);
     }
 
+    schema.setId(null);
     final var schemaMap =
         objectMapper.convertValue(schema, new TypeReference<Map<String, Object>>() {});
 

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

@@ -4,11 +4,13 @@
 
 import com.sap.ai.sdk.foundationmodels.openai.generated.model.ChatCompletionRequestUserMessage;
 import com.sap.ai.sdk.foundationmodels.openai.generated.model.ChatCompletionRequestUserMessageContent;
+import com.sap.ai.sdk.foundationmodels.openai.generated.model.ChatCompletionTool;
 import com.sap.ai.sdk.foundationmodels.openai.generated.model.ChatCompletionToolChoiceOption;
 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 org.junit.jupiter.api.Test;
 
 class OpenAiChatCompletionRequestTest {
@@ -114,4 +116,45 @@ void messageListExternallyUnmodifiable() {
         .as("Modifying the original list should not affect the messages in the request object.")
         .hasSize(1);
   }
+
+  @Test
+  void withOpenAiTools() {
+    record DummyRequest(String param1, int param2) {}
+
+    var request =
+        new OpenAiChatCompletionRequest(OpenAiMessage.user("Hello, world"))
+            .withOpenAiTools(
+                List.of(
+                    new OpenAiFunctionTool("toolA", DummyRequest.class)
+                        .withDescription("descA")
+                        .withStrict(true),
+                    new OpenAiFunctionTool("toolB", String.class)
+                        .withDescription("descB")
+                        .withStrict(false)));
+
+    var lowLevelRequest = request.createCreateChatCompletionRequest();
+    assertThat(lowLevelRequest.getTools()).hasSize(2);
+
+    var toolA = lowLevelRequest.getTools().get(0);
+    assertThat(toolA).isInstanceOf(ChatCompletionTool.class);
+    assertThat(toolA.getType()).isEqualTo(ChatCompletionTool.TypeEnum.FUNCTION);
+    assertThat(toolA.getFunction().getName()).isEqualTo("toolA");
+    assertThat(toolA.getFunction().getDescription()).isEqualTo("descA");
+    assertThat(toolA.getFunction().isStrict()).isTrue();
+    assertThat(toolA.getFunction().getParameters())
+        .isEqualTo(
+            Map.of(
+                "properties",
+                Map.of("param1", Map.of("type", "string"), "param2", Map.of("type", "integer")),
+                "type",
+                "object"));
+
+    var toolB = lowLevelRequest.getTools().get(1);
+    assertThat(toolB).isInstanceOf(ChatCompletionTool.class);
+    assertThat(toolB.getType()).isEqualTo(ChatCompletionTool.TypeEnum.FUNCTION);
+    assertThat(toolB.getFunction().getName()).isEqualTo("toolB");
+    assertThat(toolB.getFunction().getDescription()).isEqualTo("descB");
+    assertThat(toolB.getFunction().isStrict()).isFalse();
+    assertThat(toolB.getFunction().getParameters()).isEqualTo(Map.of("type", "string"));
+  }
 }

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

@@ -605,5 +605,10 @@ void chatCompletionToolCallGetMessage() {
     assertThat(toolCall.getId()).isEqualTo("call_CUYGJf2j7FRWJMHT3PN3aGxK");
     assertThat(toolCall.getName()).isEqualTo("fibonacci");
     assertThat(toolCall.getArguments()).isEqualTo("{\"N\":12}");
+    assertThat(toolCall.getArgumentsAsMap()).isEqualTo(Map.of("N", 12));
+
+    record DummyRequest(int N) {}
+    assertThat(toolCall.getArgumentsAsObject(DummyRequest.class)).isInstanceOf(DummyRequest.class);
+    assertThat(toolCall.getArgumentsAsObject(DummyRequest.class).N()).isEqualTo(12);
   }
 }