fix: use the same schema generation dependency as in orchestration module

Author: rpanackal

foundation-models/openai/pom.xml

@@ -78,8 +78,12 @@
       <artifactId>jackson-annotations</artifactId>
     </dependency>
     <dependency>
-      <groupId>com.fasterxml.jackson.module</groupId>
-      <artifactId>jackson-module-jsonSchema</artifactId>
+      <groupId>com.github.victools</groupId>
+      <artifactId>jsonschema-generator</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>com.github.victools</groupId>
+      <artifactId>jsonschema-module-jackson</artifactId>
     </dependency>
     <dependency>
       <groupId>io.vavr</groupId>

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

@@ -3,10 +3,13 @@
 import static com.sap.ai.sdk.foundationmodels.openai.generated.model.ChatCompletionTool.TypeEnum.FUNCTION;
 
 import com.fasterxml.jackson.core.type.TypeReference;
-import com.fasterxml.jackson.databind.JsonMappingException;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.module.jsonSchema.JsonSchema;
-import com.fasterxml.jackson.module.jsonSchema.JsonSchemaGenerator;
+import com.github.victools.jsonschema.generator.Option;
+import com.github.victools.jsonschema.generator.OptionPreset;
+import com.github.victools.jsonschema.generator.SchemaGenerator;
+import com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder;
+import com.github.victools.jsonschema.generator.SchemaVersion;
+import com.github.victools.jsonschema.module.jackson.JacksonModule;
+import com.github.victools.jsonschema.module.jackson.JacksonOption;
 import com.google.common.annotations.Beta;
 import com.sap.ai.sdk.foundationmodels.openai.generated.model.ChatCompletionTool;
 import com.sap.ai.sdk.foundationmodels.openai.generated.model.FunctionObject;
@@ -21,9 +24,9 @@
 import lombok.experimental.Accessors;
 
 /**
- * Represents an OpenAI function tool that can be used to define a function call in an OpenAI Chat
- * Completion request. This tool generates a JSON schema based on the provided class representing
- * the function's request structure.
+ * Represents an OpenAI tool that can be used to define a function call in an OpenAI Chat Completion
+ * request. This tool generates a JSON schema based on the provided class representing the
+ * function's request structure.
  *
  * @param <I> the type of the input argument for the function
  * @see <a href="https://platform.openai.com/docs/guides/gpt/function-calling"/>OpenAI Function
@@ -36,20 +39,23 @@
 @AllArgsConstructor(access = AccessLevel.PRIVATE)
 public class OpenAiTool<I> {
 
+  /** The schema generator used to create JSON schemas. */
+  @Nonnull private static final SchemaGenerator GENERATOR = createSchemaGenerator();
+
   /** The name of the function. */
-  private @Nonnull String name;
+  @Nonnull private String name;
 
   /** The model class for function request. */
-  private @Nonnull Class<I> requestClass;
+  @Nonnull private Class<I> requestClass;
 
   /** An optional description of the function. */
-  private @Nullable String description;
+  @Nullable private String description;
 
   /** An optional flag indicating whether the function parameters should be treated strictly. */
-  private @Nullable Boolean strict;
+  @Nullable private Boolean strict;
 
   /** The function to be called. */
-  private @Nullable Function<I, ?> function;
+  @Nullable private Function<I, ?> function;
 
   /**
    * Constructs an {@code OpenAiFunctionTool} with the specified name and a model class that
@@ -65,22 +71,16 @@ public OpenAiTool(@Nonnull final String name, @Nonnull final Class<I> requestCla
   @Nonnull
   Object execute(@Nonnull final I argument) {
     if (getFunction() == null) {
-      throw new IllegalStateException("Function must not be set to execute the tool.");
+      throw new IllegalStateException("No function configured to execute.");
     }
     return getFunction().apply(argument);
   }
 
   ChatCompletionTool createChatCompletionTool() {
-    final var objectMapper = new ObjectMapper();
-    JsonSchema schema = null;
-    try {
-      schema = new JsonSchemaGenerator(objectMapper).generateSchema(getRequestClass());
-    } catch (JsonMappingException e) {
-      throw new IllegalArgumentException("Could not generate schema for " + getRequestClass(), e);
-    }
-
+    final var schema = GENERATOR.generateSchema(getRequestClass());
     final var schemaMap =
-        objectMapper.convertValue(schema, new TypeReference<Map<String, Object>>() {});
+        OpenAiUtils.getOpenAiObjectMapper()
+            .convertValue(schema, new TypeReference<Map<String, Object>>() {});
 
     final var function =
         new FunctionObject()
@@ -90,4 +90,15 @@ ChatCompletionTool createChatCompletionTool() {
             .strict(getStrict());
     return new ChatCompletionTool().type(FUNCTION).function(function);
   }
+
+  private static SchemaGenerator createSchemaGenerator() {
+    final var module =
+        new JacksonModule(
+            JacksonOption.RESPECT_JSONPROPERTY_REQUIRED, JacksonOption.RESPECT_JSONPROPERTY_ORDER);
+    return new SchemaGenerator(
+        new SchemaGeneratorConfigBuilder(SchemaVersion.DRAFT_2020_12, OptionPreset.PLAIN_JSON)
+            .without(Option.SCHEMA_VERSION_INDICATOR)
+            .with(module)
+            .build());
+  }
 }

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

@@ -145,12 +145,11 @@ record DummyRequest(String param1, int param2) {}
     assertThat(toolA.getFunction().getParameters())
         .isEqualTo(
             Map.of(
-                "id",
-                    "urn:jsonschema:com:sap:ai:sdk:foundationmodels:openai:OpenAiChatCompletionRequestTest:1DummyRequest",
                 "properties",
-                    Map.of(
-                        "param1", Map.of("type", "string"),
-                        "param2", Map.of("type", "integer")),
-                "type", "object"));
+                Map.of(
+                    "param1", Map.of("type", "string"),
+                    "param2", Map.of("type", "integer")),
+                "type",
+                "object"));
   }
 }

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

@@ -75,7 +75,7 @@ void executeToolsThrowsOnNoFunction() {
     assertThatThrownBy(
             () -> OpenAiToolExecutor.executeTools(List.of(toolA), List.of(functionCallA)))
         .isInstanceOf(IllegalStateException.class)
-        .hasMessageContaining("Function must not be set to execute the tool");
+        .hasMessageContaining("No function configured to execute.");
   }
 
   @Test