Some code cleanup

Author: MatKuhr

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

@@ -8,7 +8,7 @@
 /** Endpoint for Configuration operations */
 @SuppressWarnings("unused") // debug class that doesn't need to be tested
 @RestController
-public class ConfigurationController {
+class ConfigurationController {
 
   private static final ConfigurationApi CLIENT = new ConfigurationApi();
 

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

@@ -30,7 +30,7 @@
 class DeploymentController {
 
   private static final DeploymentApi CLIENT = new DeploymentApi();
-  private static final String RESSOURCE_GROUP = "default";
+  private static final String RESOURCE_GROUP = "default";
 
   /**
    * Create and delete a deployment with the Java specific configuration ID
@@ -40,15 +40,15 @@ class DeploymentController {
    */
   @GetMapping("/by-config/{id}/createDelete")
   @Nullable
-  public AiDeploymentDeletionResponse createAndDeleteDeploymentByConfigId(
+  AiDeploymentDeletionResponse createAndDeleteDeploymentByConfigId(
       @Nonnull @PathVariable("id") final String configId) {
     final var deployment =
         CLIENT.create(
-            RESSOURCE_GROUP, AiDeploymentCreationRequest.create().configurationId(configId));
+            RESOURCE_GROUP, AiDeploymentCreationRequest.create().configurationId(configId));
 
     // shortly after creation, the deployment will be status UNKNOWN.
     // We can directly DELETE it, without going through STOPPED
-    return CLIENT.delete(RESSOURCE_GROUP, deployment.getId());
+    return CLIENT.delete(RESOURCE_GROUP, deployment.getId());
   }
 
   /**
@@ -62,7 +62,7 @@ public AiDeploymentDeletionResponse createAndDeleteDeploymentByConfigId(
   @GetMapping("/by-config/{id}/stop")
   @Nonnull
   @SuppressWarnings("unused") // debug method that doesn't need to be tested
-  public List<AiDeploymentModificationResponse> stopByConfigId(
+  List<AiDeploymentModificationResponse> stopByConfigId(
       @Nonnull @PathVariable("id") final String configId) {
     final List<AiDeployment> myDeployments = getAllByConfigId(configId);
     log.info("Found {} deployments to STOP", myDeployments.size());
@@ -72,7 +72,7 @@ public List<AiDeploymentModificationResponse> stopByConfigId(
         .map(
             deployment ->
                 CLIENT.modify(
-                    RESSOURCE_GROUP,
+                    RESOURCE_GROUP,
                     deployment.getId(),
                     AiDeploymentModificationRequest.create()
                         .targetStatus(AiDeploymentTargetStatus.STOPPED)))
@@ -90,14 +90,14 @@ public List<AiDeploymentModificationResponse> stopByConfigId(
   @GetMapping("/by-config/{id}/delete")
   @Nonnull
   @SuppressWarnings("unused") // debug method that doesn't need to be tested
-  public List<AiDeploymentDeletionResponse> deleteByConfigId(
+  List<AiDeploymentDeletionResponse> deleteByConfigId(
       @Nonnull @PathVariable("id") final String configId) {
     final List<AiDeployment> myDeployments = getAllByConfigId(configId);
     log.info("Found {} deployments to DELETE", myDeployments.size());
 
     // DELETE my deployments
     return myDeployments.stream()
-        .map(deployment -> CLIENT.delete(RESSOURCE_GROUP, deployment.getId()))
+        .map(deployment -> CLIENT.delete(RESOURCE_GROUP, deployment.getId()))
         .toList();
   }
 
@@ -109,8 +109,8 @@ public List<AiDeploymentDeletionResponse> deleteByConfigId(
    */
   @GetMapping("/by-config/{id}/getAll")
   @Nonnull
-  public List<AiDeployment> getAllByConfigId(@Nonnull @PathVariable("id") final String configId) {
-    final AiDeploymentList deploymentList = CLIENT.query(RESSOURCE_GROUP);
+  List<AiDeployment> getAllByConfigId(@Nonnull @PathVariable("id") final String configId) {
+    final AiDeploymentList deploymentList = CLIENT.query(RESOURCE_GROUP);
 
     return deploymentList.getResources().stream()
         .filter(deployment -> configId.equals(deployment.getConfigurationId()))
@@ -124,8 +124,8 @@ public List<AiDeployment> getAllByConfigId(@Nonnull @PathVariable("id") final St
    */
   @GetMapping("/getAll")
   @Nullable
-  public AiDeploymentList getAll() {
-    return CLIENT.query(RESSOURCE_GROUP);
+  AiDeploymentList getAll() {
+    return CLIENT.query(RESOURCE_GROUP);
   }
 
   /**
@@ -138,7 +138,7 @@ public AiDeploymentList getAll() {
    */
   @Nonnull
   @SuppressWarnings("unused") // debug method that doesn't need to be tested
-  public AiDeploymentCreationResponse createConfigAndDeploy(final OpenAiModel model) {
+  AiDeploymentCreationResponse createConfigAndDeploy(final OpenAiModel model) {
 
     // Create a configuration
     final var modelNameParameter =
@@ -154,12 +154,12 @@ public AiDeploymentCreationResponse createConfigAndDeploy(final OpenAiModel mode
             .addParameterBindingsItem(modelVersion);
 
     final AiConfigurationCreationResponse configuration =
-        new ConfigurationApi().create(RESSOURCE_GROUP, configurationBaseData);
+        new ConfigurationApi().create(RESOURCE_GROUP, configurationBaseData);
 
     // Create a deployment from the configuration
     final var deploymentCreationRequest =
         AiDeploymentCreationRequest.create().configurationId(configuration.getId());
 
-    return CLIENT.create(RESSOURCE_GROUP, deploymentCreationRequest);
+    return CLIENT.create(RESOURCE_GROUP, deploymentCreationRequest);
   }
 }

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

@@ -40,7 +40,7 @@ class OpenAiController {
    */
   @GetMapping("/chatCompletion")
   @Nonnull
-  public static OpenAiChatCompletionOutput chatCompletion() {
+  OpenAiChatCompletionOutput chatCompletion() {
     return OpenAiClient.forModel(GPT_35_TURBO).chatCompletion("Who is the prettiest");
   }
 
@@ -52,7 +52,7 @@ public static OpenAiChatCompletionOutput chatCompletion() {
   @SuppressWarnings("unused") // The end-to-end test doesn't use this method
   @GetMapping("/streamChatCompletionDeltas")
   @Nonnull
-  public static ResponseEntity<ResponseBodyEmitter> streamChatCompletionDeltas() {
+  ResponseEntity<ResponseBodyEmitter> streamChatCompletionDeltas() {
     final var msg = "Can you give me the first 100 numbers of the Fibonacci sequence?";
     final var request =
         new OpenAiChatCompletionParameters().addMessages(new OpenAiChatUserMessage().addText(msg));
@@ -97,7 +97,7 @@ private static String objectToJson(@Nonnull final Object obj) {
   @SuppressWarnings("unused") // The end-to-end test doesn't use this method
   @GetMapping("/streamChatCompletion")
   @Nonnull
-  public static ResponseEntity<ResponseBodyEmitter> streamChatCompletion() {
+  ResponseEntity<ResponseBodyEmitter> streamChatCompletion() {
     final var stream =
         OpenAiClient.forModel(GPT_35_TURBO)
             .withSystemPrompt("Be a good, honest AI and answer the following question:")
@@ -138,7 +138,7 @@ private static void send(
    */
   @GetMapping("/chatCompletionImage")
   @Nonnull
-  public static OpenAiChatCompletionOutput chatCompletionImage() {
+  OpenAiChatCompletionOutput chatCompletionImage() {
     final var request =
         new OpenAiChatCompletionParameters()
             .addMessages(
@@ -158,7 +158,7 @@ public static OpenAiChatCompletionOutput chatCompletionImage() {
    */
   @GetMapping("/chatCompletionTool")
   @Nonnull
-  public static OpenAiChatCompletionOutput chatCompletionTools() {
+  OpenAiChatCompletionOutput chatCompletionTools() {
     final var question =
         "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?";
     final var par = Map.of("type", "object", "properties", Map.of("N", Map.of("type", "integer")));
@@ -184,7 +184,7 @@ public static OpenAiChatCompletionOutput chatCompletionTools() {
    */
   @GetMapping("/embedding")
   @Nonnull
-  public static OpenAiEmbeddingOutput embedding() {
+  OpenAiEmbeddingOutput embedding() {
     final var request = new OpenAiEmbeddingParameters().setInput("Hello World");
 
     return OpenAiClient.forModel(TEXT_EMBEDDING_ADA_002).embedding(request);

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

@@ -39,7 +39,7 @@ class OrchestrationController {
    */
   @GetMapping("/completion")
   @Nonnull
-  public OrchestrationChatResponse completion() {
+  OrchestrationChatResponse completion() {
     final var prompt = new OrchestrationPrompt("Hello world! Why is this phrase so famous?");
 
     return client.chatCompletion(prompt, config);
@@ -52,7 +52,7 @@ public OrchestrationChatResponse completion() {
    */
   @GetMapping("/template")
   @Nonnull
-  public OrchestrationChatResponse template() {
+  OrchestrationChatResponse template() {
     final var template =
         new UserMessage("Reply with 'Orchestration Service is working!' in {{?language}}");
     final var templatingConfig = Template.create().template(List.of(template.createChatMessage()));
@@ -71,7 +71,7 @@ public OrchestrationChatResponse template() {
    */
   @GetMapping("/messagesHistory")
   @Nonnull
-  public OrchestrationChatResponse messagesHistory() {
+  OrchestrationChatResponse messagesHistory() {
     final List<Message> messagesHistory =
         List.of(
             new UserMessage("What is the capital of France?"),
@@ -91,7 +91,7 @@ public OrchestrationChatResponse messagesHistory() {
    */
   @GetMapping("/filter/{policy}")
   @Nonnull
-  public OrchestrationChatResponse filter(
+  OrchestrationChatResponse filter(
       @Nonnull @PathVariable("policy") final AzureFilterThreshold policy) {
     final var prompt =
         new OrchestrationPrompt(
@@ -118,16 +118,16 @@ public OrchestrationChatResponse filter(
    */
   @GetMapping("/maskingAnonymization")
   @Nonnull
-  public OrchestrationChatResponse maskingAnonymization() {
+  OrchestrationChatResponse maskingAnonymization() {
     final var systemMessage =
         new SystemMessage(
             "Please evaluate the following user feedback and judge if the sentiment is positive or negative.");
     final var userMessage =
         new UserMessage(
             """
-    I think the SDK is good, but could use some further enhancements.
-    My architect Alice and manager Bob pointed out that we need the grounding capabilities, which aren't supported yet.
-    """);
+                I think the SDK is good, but could use some further enhancements.
+                My architect Alice and manager Bob pointed out that we need the grounding capabilities, which aren't supported yet.
+                """);
 
     final var prompt = new OrchestrationPrompt(systemMessage, userMessage);
     final var maskingConfig = DpiMasking.anonymization().withEntities(DPIEntities.PERSON);
@@ -144,7 +144,7 @@ public OrchestrationChatResponse maskingAnonymization() {
    */
   @GetMapping("/maskingPseudonymization")
   @Nonnull
-  public OrchestrationChatResponse maskingPseudonymization() {
+  OrchestrationChatResponse maskingPseudonymization() {
     final var systemMessage =
         new SystemMessage(
             """

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

@@ -10,7 +10,7 @@
 /** Endpoint for Scenario operations */
 @RestController
 @SuppressWarnings("unused") // debug method that doesn't need to be tested
-public class ScenarioController {
+class ScenarioController {
 
   private static final ScenarioApi CLIENT = new ScenarioApi();
 
@@ -32,7 +32,7 @@ AiScenarioList getScenarios() {
    */
   @GetMapping("/models")
   @Nonnull
-  public AiModelList getModels() {
+  AiModelList getModels() {
     return CLIENT.queryModels("foundation-models", "default");
   }
 }