Merge remote-tracking branch 'refs/remotes/origin/main' into feat/openai-conv-embedding

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

Author: rpanackal

README.md

@@ -1,7 +1,7 @@
 ![build](https://github.com/SAP/ai-sdk-java/actions/workflows/continuous-integration.yaml/badge.svg?branch=main)
 ![CodeQL](https://github.com/SAP/ai-sdk-java/actions/workflows/github-code-scanning/codeql/badge.svg)
 [![REUSE status](https://api.reuse.software/badge/git.fsfe.org/reuse/api)](https://api.reuse.software/info/git.fsfe.org/reuse/api)
-[![Fosstars security rating](https://github.com/SAP/ai-sdk-java/blob/fosstars-report/fosstars_badge.svg)](https://github.com/SAP/ai-sdk-java/blob/fosstars-report/fosstars_report.md)
+[![Fosstars security rating](https://github.com/SAP/ai-sdk-java/actions/workflows/fosstars-report.yml/badge.svg?branch=main)](https://github.com/SAP/ai-sdk-java/blob/fosstars-report/fosstars_report.md)
 
 # <img src="https://sap.github.io/cloud-sdk/img/logo.svg" alt="SAP Cloud SDK" width="30"/> SAP Cloud SDK for AI (for Java)
 

docs/guides/SPRING_AI_INTEGRATION.md

@@ -32,12 +32,11 @@ First, add the Spring AI dependency to your `pom.xml`:
 </repository>
 ```
 
-:::note Spring AI Milestone Version
-Note that currently no stable version of Spring AI exists just yet.
-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.
-:::
+> [!NOTE]
+> Note that currently no stable version of Spring AI exists just yet.
+> 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.
 
 ## Orchestration Chat Completion
 

docs/release-notes/release_notes.md

@@ -9,6 +9,9 @@
 ### 🔧 Compatibility Notes
 
 - The constructors `UserMessage(MessageContent)` and `SystemMessage(MessageContent)` are removed. Use `Message.user(String)`, `Message.user(ImageItem)`, or `Message.system(String)` instead.
+- Deprecate `getCustomField(String)` in favor of `toMap()` on generated model classes.
+  - `com.sap.ai.sdk.core.model.*`
+  - `com.sap.ai.sdk.orchestration.model.*`
 
 ### ✨ New Functionality
 

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

@@ -2,6 +2,8 @@
 
 import com.google.common.annotations.Beta;
 import com.google.common.collect.Lists;
+import com.sap.ai.sdk.foundationmodels.openai.generated.model.ChatCompletionNamedToolChoice;
+import com.sap.ai.sdk.foundationmodels.openai.generated.model.ChatCompletionNamedToolChoiceFunction;
 import com.sap.ai.sdk.foundationmodels.openai.generated.model.ChatCompletionStreamOptions;
 import com.sap.ai.sdk.foundationmodels.openai.generated.model.ChatCompletionTool;
 import com.sap.ai.sdk.foundationmodels.openai.generated.model.ChatCompletionToolChoiceOption;
@@ -126,7 +128,9 @@ public class OpenAiChatCompletionRequest {
   @Nullable List<ChatCompletionTool> tools;
 
   /** Option to control which tool is invoked by the model. */
-  @Nullable ChatCompletionToolChoiceOption toolChoice;
+  @With(AccessLevel.PRIVATE)
+  @Nullable
+  ChatCompletionToolChoiceOption toolChoice;
 
   /**
    * Creates an OpenAiChatCompletionPrompt with string as user message.
@@ -248,6 +252,51 @@ public OpenAiChatCompletionRequest withLogprobs(@Nonnull final Boolean logprobs)
             this.toolChoice);
   }
 
+  /**
+   * Only message generation will be performed without calling any tool.
+   *
+   * @return the current OpenAiChatCompletionRequest instance.
+   */
+  @Nonnull
+  public OpenAiChatCompletionRequest withToolChoiceNone() {
+    return this.withToolChoice(ChatCompletionToolChoiceOption.create("none"));
+  }
+
+  /**
+   * The model may decide whether to call a (one or more) tool.
+   *
+   * @return the current OpenAiChatCompletionRequest instance.
+   */
+  @Nonnull
+  public OpenAiChatCompletionRequest withToolChoiceOptional() {
+    return this.withToolChoice(ChatCompletionToolChoiceOption.create("auto"));
+  }
+
+  /**
+   * The model must call one or more tools as part of its processing.
+   *
+   * @return the current OpenAiChatCompletionRequest instance.
+   */
+  @Nonnull
+  public OpenAiChatCompletionRequest withToolChoiceRequired() {
+    return this.withToolChoice(ChatCompletionToolChoiceOption.create("required"));
+  }
+
+  /**
+   * The model must call the function specified by {@code functionName}.
+   *
+   * @param functionName the name of the function that must be called.
+   * @return the current OpenAiChatCompletionRequest instance.
+   */
+  @Nonnull
+  public OpenAiChatCompletionRequest withToolChoiceFunction(@Nonnull final String functionName) {
+    return this.withToolChoice(
+        ChatCompletionToolChoiceOption.create(
+            new ChatCompletionNamedToolChoice()
+                .type(ChatCompletionNamedToolChoice.TypeEnum.FUNCTION)
+                .function(new ChatCompletionNamedToolChoiceFunction().name(functionName))));
+  }
+
   /**
    * Converts the request to a generated model class CreateChatCompletionRequest.
    *

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

@@ -40,6 +40,12 @@ public record OpenAiModel(@Nonnull String name, @Nullable String version) implem
   /** Azure OpenAI GPT-4o Mini chat completions model */
   public static final OpenAiModel GPT_4O_MINI = new OpenAiModel("gpt-4o-mini", null);
 
+  /** Azure OpenAI GPT-o3 Mini chat completions model */
+  public static final OpenAiModel GPT_O3_MINI = new OpenAiModel("o3-mini", null);
+
+  /** Azure OpenAI GPT-o1 chat completions model */
+  public static final OpenAiModel GPT_O1 = new OpenAiModel("o1", null);
+
   /** Azure OpenAI Text Embedding 3 Large model */
   public static final OpenAiModel TEXT_EMBEDDING_3_LARGE =
       new OpenAiModel("text-embedding-3-large", null);

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

@@ -4,6 +4,7 @@
 
 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.ChatCompletionToolChoiceOption;
 import com.sap.ai.sdk.foundationmodels.openai.generated.model.CreateChatCompletionRequestAllOfStop;
 import java.math.BigDecimal;
 import java.util.List;
@@ -45,4 +46,51 @@ void createWithExistingRequest() {
     assertThat(lowlevelRequest.getSeed()).isEqualTo(123);
     assertThat(lowlevelRequest.getTemperature()).isEqualTo(BigDecimal.valueOf(0.5));
   }
+
+  @Test
+  void withToolChoiceNone() {
+    OpenAiChatCompletionRequest request =
+        new OpenAiChatCompletionRequest("message").withToolChoiceNone();
+
+    var lowLevelRequest = request.createCreateChatCompletionRequest();
+    var choice =
+        ((ChatCompletionToolChoiceOption.InnerString) lowLevelRequest.getToolChoice()).value();
+    assertThat(choice).isEqualTo("none");
+  }
+
+  @Test
+  void withToolChoiceOptional() {
+    OpenAiChatCompletionRequest request =
+        new OpenAiChatCompletionRequest("message").withToolChoiceOptional();
+
+    var lowLevelRequest = request.createCreateChatCompletionRequest();
+    var choice =
+        ((ChatCompletionToolChoiceOption.InnerString) lowLevelRequest.getToolChoice()).value();
+    assertThat(choice).isEqualTo("auto");
+  }
+
+  @Test
+  void withToolChoiceRequired() {
+    OpenAiChatCompletionRequest request =
+        new OpenAiChatCompletionRequest("message").withToolChoiceRequired();
+
+    var lowLevelRequest = request.createCreateChatCompletionRequest();
+    var choice =
+        ((ChatCompletionToolChoiceOption.InnerString) lowLevelRequest.getToolChoice()).value();
+    assertThat(choice).isEqualTo("required");
+  }
+
+  @Test
+  void withToolChoiceFunction() {
+    OpenAiChatCompletionRequest request =
+        new OpenAiChatCompletionRequest("message").withToolChoiceFunction("functionName");
+
+    var lowLevelRequest = request.createCreateChatCompletionRequest();
+    var choice =
+        ((ChatCompletionToolChoiceOption.InnerChatCompletionNamedToolChoice)
+                lowLevelRequest.getToolChoice())
+            .value();
+    assertThat(choice.getType().getValue()).isEqualTo("function");
+    assertThat(choice.getFunction().getName()).isEqualTo("functionName");
+  }
 }

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

@@ -25,11 +25,8 @@
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.when;
 
-import com.sap.ai.sdk.foundationmodels.openai.generated.model.ChatCompletionNamedToolChoice;
-import com.sap.ai.sdk.foundationmodels.openai.generated.model.ChatCompletionNamedToolChoiceFunction;
 import com.sap.ai.sdk.foundationmodels.openai.generated.model.ChatCompletionResponseMessageRole;
 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.ContentFilterPromptResults;
 import com.sap.ai.sdk.foundationmodels.openai.generated.model.CreateChatCompletionRequest;
 import com.sap.ai.sdk.foundationmodels.openai.generated.model.CreateChatCompletionStreamResponseChoicesInner;
@@ -526,17 +523,11 @@ void chatCompletionTool() {
     final var tool =
         new ChatCompletionTool().type(ChatCompletionTool.TypeEnum.FUNCTION).function(function);
 
-    final var toolChoice =
-        ChatCompletionToolChoiceOption.create(
-            new ChatCompletionNamedToolChoice()
-                .type(ChatCompletionNamedToolChoice.TypeEnum.FUNCTION)
-                .function(new ChatCompletionNamedToolChoiceFunction().name("fibonacci")));
-
     final var request =
         new OpenAiChatCompletionRequest(
                 "A pair of rabbits is placed in a field. Each month, every pair produces one new pair, starting from the second month. How many rabbits will there be after 12 months?")
             .withTools(List.of(tool))
-            .withToolChoice(toolChoice);
+            .withToolChoiceFunction("fibonacci");
 
     var response = client.chatCompletion(request).getOriginalResponse();
 

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

@@ -14,7 +14,8 @@
 class ScenarioTest {
 
   @Test
-  @DisplayName("Declared OpenAI models must match AI Core's available OpenAI models")
+  @DisplayName(
+      "Declared OpenAI models must be superset of our AI Core account's available OpenAI models")
   @SneakyThrows
   void openAiModelAvailability() {
 
@@ -39,6 +40,6 @@ void openAiModelAvailability() {
     }
 
     // Assert that the declared OpenAI models match the expected list
-    assertThat(declaredOpenAiModelList).hasSameElementsAs(availableOpenAiModels);
+    assertThat(declaredOpenAiModelList).containsAll(availableOpenAiModels);
   }
 }

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

@@ -14,10 +14,7 @@
 import com.sap.ai.sdk.foundationmodels.openai.OpenAiEmbeddingResponse;
 import com.sap.ai.sdk.foundationmodels.openai.OpenAiImageItem;
 import com.sap.ai.sdk.foundationmodels.openai.OpenAiMessage;
-import com.sap.ai.sdk.foundationmodels.openai.generated.model.ChatCompletionNamedToolChoice;
-import com.sap.ai.sdk.foundationmodels.openai.generated.model.ChatCompletionNamedToolChoiceFunction;
 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.FunctionObject;
 import java.util.List;
 import java.util.Map;
@@ -102,18 +99,12 @@ public OpenAiChatCompletionResponse chatCompletionTools(final int months) {
 
     final var tool = new ChatCompletionTool().type(FUNCTION).function(function);
 
-    final var toolChoice =
-        ChatCompletionToolChoiceOption.create(
-            new ChatCompletionNamedToolChoice()
-                .type(ChatCompletionNamedToolChoice.TypeEnum.FUNCTION)
-                .function(new ChatCompletionNamedToolChoiceFunction().name("fibonacci")));
-
     final var request =
         new OpenAiChatCompletionRequest(
                 "A pair of rabbits is placed in a field. Each month, every pair produces one new pair, starting from the second month. How many rabbits will there be after %s months?"
                     .formatted(months))
             .withTools(List.of(tool))
-            .withToolChoice(toolChoice);
+            .withToolChoiceFunction("fibonacci");
 
     return OpenAiClient.forModel(GPT_35_TURBO).chatCompletion(request);
   }