Create schema with jackson

Author: rpanackal

sample-code/spring-app/pom.xml

@@ -169,7 +169,7 @@
     <dependency>
       <groupId>com.fasterxml.jackson.core</groupId>
       <artifactId>jackson-core</artifactId>
-      <scope>provided</scope>
+      <scope>compile</scope>
     </dependency>
     <!-- scope "test" -->
     <dependency>
@@ -186,6 +186,15 @@
       <groupId>com.sap.cloud.sdk.cloudplatform</groupId>
       <artifactId>cloudplatform-connectivity</artifactId>
     </dependency>
+    <dependency>
+      <groupId>com.fasterxml.jackson.module</groupId>
+      <artifactId>jackson-module-jsonSchema</artifactId>
+      <version>2.18.2</version>
+    </dependency>
+    <dependency>
+      <groupId>io.vavr</groupId>
+      <artifactId>vavr</artifactId>
+    </dependency>
   </dependencies>
 
   <build>
@@ -220,6 +229,20 @@
           <skipAddThirdParty>true</skipAddThirdParty>
         </configuration>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-dependency-plugin</artifactId>
+        <executions>
+          <execution>
+            <id>analyze</id>
+            <configuration>
+              <ignoredDependencies>
+                <ignoredDependency>com.fasterxml.jackson.core:jackson-core</ignoredDependency>
+              </ignoredDependencies>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
   </build>
 </project>

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

@@ -6,6 +6,7 @@
 import static com.sap.ai.sdk.foundationmodels.openai.model.OpenAiChatCompletionTool.ToolType.FUNCTION;
 
 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.OpenAiClient;
 import com.sap.ai.sdk.foundationmodels.openai.model.OpenAiChatCompletionDelta;
@@ -16,6 +17,7 @@
 import com.sap.ai.sdk.foundationmodels.openai.model.OpenAiChatMessage;
 import com.sap.ai.sdk.foundationmodels.openai.model.OpenAiEmbeddingOutput;
 import com.sap.ai.sdk.foundationmodels.openai.model.OpenAiEmbeddingParameters;
+import io.vavr.control.Try;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
@@ -125,18 +127,20 @@ public OpenAiChatCompletionOutput chatCompletionTools(final int months) {
   @Nonnull
   public OpenAiChatCompletionOutput chatCompletionToolExecution(
       @Nonnull final String location, @Nonnull final String unit) {
+
+    final var schemaMap =
+        Try.of(() -> new JsonSchemaGenerator(JACKSON).generateSchema(WeatherMethod.Request.class))
+            .map(schema -> JACKSON.convertValue(schema, Map.class))
+            .getOrElseThrow(
+                e ->
+                    new IllegalArgumentException(
+                        "Could not generate schema for WeatherMethod.Request", e));
+
     final var function =
         new OpenAiChatCompletionFunction()
             .setName("weather")
             .setDescription("Get the weather for the given location")
-            .setParameters(
-                Map.of(
-                    "type",
-                    "object",
-                    "properties",
-                    Map.of(
-                        "location", Map.of("type", "string"),
-                        "unit", Map.of("type", "string", "enum", List.of("C", "F")))));
+            .setParameters(schemaMap);
     final var tool = new OpenAiChatCompletionTool().setType(FUNCTION).setFunction(function);
 
     final var messages = new ArrayList<OpenAiChatMessage>();

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

@@ -7,6 +7,7 @@
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 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.OpenAiChatCompletionDelta;
 import com.sap.ai.sdk.foundationmodels.openai.OpenAiChatCompletionRequest;
@@ -27,6 +28,7 @@
 import com.sap.ai.sdk.foundationmodels.openai.generated.model.CreateChatCompletionRequest;
 import com.sap.ai.sdk.foundationmodels.openai.generated.model.CreateChatCompletionResponse;
 import com.sap.ai.sdk.foundationmodels.openai.generated.model.FunctionObject;
+import io.vavr.control.Try;
 import java.util.List;
 import java.util.Map;
 import java.util.stream.Stream;
@@ -132,18 +134,19 @@ public OpenAiChatCompletionResponse chatCompletionTools(final int months) {
   public CreateChatCompletionResponse chatCompletionToolExecution(
       @Nonnull final String location, @Nonnull final String unit) {
 
+    final var schemaMap =
+        Try.of(() -> new JsonSchemaGenerator(JACKSON).generateSchema(WeatherMethod.Request.class))
+            .map(schema -> JACKSON.convertValue(schema, Map.class))
+            .getOrElseThrow(
+                e ->
+                    new IllegalArgumentException(
+                        "Could not generate schema for WeatherMethod.Request", e));
+
     final var function =
         new FunctionObject()
             .name("weather")
             .description("Get the weather for the given location")
-            .parameters(
-                Map.of(
-                    "type",
-                    "object",
-                    "properties",
-                    Map.of(
-                        "location", Map.of("type", "string"),
-                        "unit", Map.of("type", "string", "enum", List.of("C", "F")))));
+            .parameters(schemaMap);
 
     final var tool = new ChatCompletionTool().type(FUNCTION).function(function);