Test OpenAI Model Availability

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

@@ -9,6 +9,9 @@
  */
 public record OpenAiModel(@Nonnull String model) {
 
+  /** Azure OpenAI dall-e-3 image generate model */
+  public static final OpenAiModel DALL_E_3 = new OpenAiModel("dall-e-3");
+
   /** Azure OpenAI GPT-3.5 Turbo chat completions model */
   public static final OpenAiModel GPT_35_TURBO = new OpenAiModel("gpt-35-turbo");
 
@@ -27,6 +30,17 @@ public record OpenAiModel(@Nonnull String model) {
   /** Azure OpenAI GPT-4o chat completions model */
   public static final OpenAiModel GPT_4O = new OpenAiModel("gpt-4o");
 
+  /** Azure OpenAI GPT-4o Mini chat completions model */
+  public static final OpenAiModel GPT_4O_MINI = new OpenAiModel("gpt-4o-mini");
+
+  /** Azure OpenAI Text Embedding 3 Large model */
+  public static final OpenAiModel TEXT_EMBEDDING_3_LARGE =
+      new OpenAiModel("text-embedding-3-large");
+
+  /** Azure OpenAI Text Embedding 3 Small model */
+  public static final OpenAiModel TEXT_EMBEDDING_3_SMALL =
+      new OpenAiModel("text-embedding-3-small");
+
   /** Azure OpenAI Text Embedding ADA 002 model */
   public static final OpenAiModel TEXT_EMBEDDING_ADA_002 =
       new OpenAiModel("text-embedding-ada-002");

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

@@ -2,14 +2,20 @@
 
 import static com.sap.ai.sdk.core.Core.getClient;
 
+import com.sap.ai.sdk.core.client.ConfigurationApi;
 import com.sap.ai.sdk.core.client.DeploymentApi;
+import com.sap.ai.sdk.core.client.model.AiConfigurationBaseData;
+import com.sap.ai.sdk.core.client.model.AiConfigurationCreationResponse;
 import com.sap.ai.sdk.core.client.model.AiDeployment;
 import com.sap.ai.sdk.core.client.model.AiDeploymentCreationRequest;
+import com.sap.ai.sdk.core.client.model.AiDeploymentCreationResponse;
 import com.sap.ai.sdk.core.client.model.AiDeploymentDeletionResponse;
 import com.sap.ai.sdk.core.client.model.AiDeploymentList;
 import com.sap.ai.sdk.core.client.model.AiDeploymentModificationRequest;
 import com.sap.ai.sdk.core.client.model.AiDeploymentModificationResponse;
 import com.sap.ai.sdk.core.client.model.AiDeploymentTargetStatus;
+import com.sap.ai.sdk.core.client.model.AiParameterArgumentBinding;
+import com.sap.ai.sdk.foundationmodels.openai.OpenAiModel;
 import java.util.List;
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
@@ -121,4 +127,39 @@ public List<AiDeployment> getAllByConfigId(@Nonnull @PathVariable("id") final St
   public AiDeploymentList getAll() {
     return API.query("default");
   }
+
+  /**
+   * Create a configuration, and deploy it.
+   *
+   * <p>This is to be invoked from a unit test.
+   *
+   * @param model The OpenAI model to deploy
+   * @return the deployment creation response
+   */
+  @Nonnull
+  @SuppressWarnings("unused") // debug method that doesn't need to be tested
+  public AiDeploymentCreationResponse createConfigAndDeploy(final OpenAiModel model) {
+
+    // Create a configuration
+    final var modelNameParameter =
+        AiParameterArgumentBinding.create().key("model").value(model.model());
+    final var modelVersion =
+        AiParameterArgumentBinding.create().key("modelVersion").value("latest");
+    final var configurationBaseData =
+        AiConfigurationBaseData.create()
+            .name(model.model())
+            .executableId("azure-openai")
+            .scenarioId("foundation-models")
+            .addParameterBindingsItem(modelNameParameter)
+            .addParameterBindingsItem(modelVersion);
+
+    final AiConfigurationCreationResponse configuration =
+        new ConfigurationApi(getClient()).create("default", configurationBaseData);
+
+    // Create a deployment from the configuration
+    final var deploymentCreationRequest =
+        AiDeploymentCreationRequest.create().configurationId(configuration.getId());
+
+    return API.create("default", deploymentCreationRequest);
+  }
 }

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

@@ -5,7 +5,7 @@
 import com.sap.ai.sdk.core.client.ScenarioApi;
 import com.sap.ai.sdk.core.client.model.AiModelList;
 import com.sap.ai.sdk.core.client.model.AiScenarioList;
-import javax.annotation.Nullable;
+import javax.annotation.Nonnull;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RestController;
 
@@ -22,6 +22,7 @@ public class ScenarioController {
    * @return the list of available scenarios
    */
   @GetMapping("/scenarios")
+  @Nonnull
   AiScenarioList getScenarios() {
     return API.query("default");
   }
@@ -32,7 +33,7 @@ AiScenarioList getScenarios() {
    * @return the list of available models
    */
   @GetMapping("/models")
-  @Nullable
+  @Nonnull
   public AiModelList getModels() {
     return API.queryModels("foundation-models", "default");
   }

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

@@ -0,0 +1,44 @@
+package com.sap.ai.sdk.app.controllers;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import com.sap.ai.sdk.core.client.model.AiModelBaseData;
+import com.sap.ai.sdk.foundationmodels.openai.OpenAiModel;
+import java.lang.reflect.Field;
+import java.util.ArrayList;
+import java.util.List;
+import lombok.SneakyThrows;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+
+public class ScenarioTest {
+
+  @Test
+  @DisplayName("Declared OpenAI models must match AI Core's available OpenAI models")
+  @SneakyThrows
+  public void openAiModelAvailability() {
+
+    // Gather AI Core's list of available OpenAI models
+    final var aiModelList = new ScenarioController().getModels().getResources();
+
+    final var availableOpenAiModels =
+        aiModelList.stream()
+            .filter(model -> model.getExecutableId().equals("azure-openai"))
+            .map(AiModelBaseData::getModel)
+            .toList();
+
+    // Gather our declared OpenAI models
+    Field[] declaredFields = OpenAiModel.class.getFields();
+
+    // get the models from the OpenAiModel class
+    List<String> declaredOpenAiModelList = new ArrayList<>();
+    for (Field field : declaredFields) {
+      if (field.getType().equals(OpenAiModel.class)) {
+        declaredOpenAiModelList.add(((OpenAiModel) field.get(null)).model());
+      }
+    }
+
+    // Assert that the declared OpenAI models match the expected list
+    assertThat(declaredOpenAiModelList).hasSameElementsAs(availableOpenAiModels);
+  }
+}