feat: [DevOps] Update orchestration specification (#669)

* Update orchestration based on rel-0.108.12

* Fixed error classes

* Formatting

---------

Co-authored-by: I538344 <charles.dubois@sap.com>

Author: bot-sdk-js

orchestration/pom.xml

@@ -38,8 +38,8 @@
     <project.rootdir>${project.basedir}/../</project.rootdir>
     <coverage.complexity>80%</coverage.complexity>
     <coverage.line>94%</coverage.line>
-    <coverage.instruction>94%</coverage.instruction>
-    <coverage.branch>75%</coverage.branch>
+    <coverage.instruction>93%</coverage.instruction>
+    <coverage.branch>74%</coverage.branch>
     <coverage.method>93%</coverage.method>
     <coverage.class>100%</coverage.class>
   </properties>

orchestration/src/main/java/com/sap/ai/sdk/orchestration/ConfigToRequestTransformer.java

@@ -1,9 +1,10 @@
 package com.sap.ai.sdk.orchestration;
 
-import com.sap.ai.sdk.orchestration.model.ChatMessage;
 import com.sap.ai.sdk.orchestration.model.CompletionRequestConfiguration;
 import com.sap.ai.sdk.orchestration.model.ModuleConfigs;
 import com.sap.ai.sdk.orchestration.model.OrchestrationConfig;
+import com.sap.ai.sdk.orchestration.model.OrchestrationConfigModules;
+import com.sap.ai.sdk.orchestration.model.OrchestrationConfigModules.InnerModuleConfigs;
 import com.sap.ai.sdk.orchestration.model.PromptTemplatingModuleConfig;
 import com.sap.ai.sdk.orchestration.model.PromptTemplatingModuleConfigPrompt;
 import com.sap.ai.sdk.orchestration.model.Template;
@@ -31,10 +32,7 @@ static CompletionRequestConfiguration toCompletionPostRequest(
     val configCopy = config.withTemplateConfig(template);
 
     val messageHistory =
-        prompt.getMessagesHistory().stream()
-            .map(Message::createChatMessage)
-            .map(ChatMessage.class::cast)
-            .toList();
+        prompt.getMessagesHistory().stream().map(Message::createChatMessage).toList();
 
     val moduleConfigs = toModuleConfigs(configCopy);
 
@@ -81,13 +79,13 @@ static PromptTemplatingModuleConfigPrompt toTemplateModuleConfig(
             .responseFormat(template.getResponseFormat());
 
     for (val customFieldName : template.getCustomFieldNames()) {
-      result.setCustomField(customFieldName, template.getCustomField(customFieldName));
+      result.setCustomField(customFieldName, template.toMap().get(customFieldName));
     }
     return result;
   }
 
   @Nonnull
-  static ModuleConfigs toModuleConfigs(@Nonnull final OrchestrationModuleConfig config) {
+  static InnerModuleConfigs toModuleConfigs(@Nonnull final OrchestrationModuleConfig config) {
     val llmConfig =
         Option.of(config.getLlmConfig())
             .getOrElseThrow(() -> new IllegalStateException("LLM config is required."));
@@ -113,6 +111,6 @@ static ModuleConfigs toModuleConfigs(@Nonnull final OrchestrationModuleConfig co
       outputTranslation.forEach(moduleConfig.getTranslation()::output);
     }
 
-    return moduleConfig;
+    return OrchestrationConfigModules.createInnerModuleConfigs(moduleConfig);
   }
 }

orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationAiModel.java

@@ -29,7 +29,7 @@ public class OrchestrationAiModel {
    *
    * <pre>{@code
    * Map.of(
-   *     "max_tokens", 50,
+   *     "max_completion_tokens", 50,
    *     "temperature", 0.1,
    *     "frequency_penalty", 0,
    *     "presence_penalty", 0)
@@ -375,7 +375,7 @@ public <ValueT> OrchestrationAiModel withParam(
   @FunctionalInterface
   public interface Parameter<ValueT> {
     /** The maximum number of tokens to generate. */
-    Parameter<Integer> MAX_TOKENS = () -> "max_tokens";
+    Parameter<Integer> MAX_TOKENS = () -> "max_completion_tokens";
 
     /** The sampling temperature. */
     Parameter<Number> TEMPERATURE = () -> "temperature";

orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationClientException.java

@@ -6,7 +6,9 @@
 import com.sap.ai.sdk.orchestration.OrchestrationFilterException.Input;
 import com.sap.ai.sdk.orchestration.model.Error;
 import com.sap.ai.sdk.orchestration.model.ErrorResponse;
+import com.sap.ai.sdk.orchestration.model.ErrorResponseError;
 import com.sap.ai.sdk.orchestration.model.ErrorResponseStreaming;
+import com.sap.ai.sdk.orchestration.model.ErrorResponseStreamingError;
 import com.sap.ai.sdk.orchestration.model.ErrorStreaming;
 import com.sap.ai.sdk.orchestration.model.GenericModuleResult;
 import com.sap.ai.sdk.orchestration.model.ModuleResults;
@@ -17,6 +19,7 @@
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import lombok.experimental.StandardException;
+import lombok.val;
 
 /** Exception thrown by the {@link OrchestrationClient} in case of an error. */
 @StandardException
@@ -37,6 +40,7 @@ static Map<String, Object> extractInputFilterDetails(@Nullable final Orchestrati
     if (error instanceof OrchestrationError.Synchronous synchronousError) {
       return Optional.of(synchronousError.getErrorResponse())
           .map(ErrorResponse::getError)
+          .flatMap(OrchestrationClientException::lastError)
           .map(Error::getIntermediateResults)
           .map(ModuleResults::getInputFiltering)
           .filter(filter -> !filter.getMessage().equals("Input Filter passed successfully."))
@@ -46,6 +50,7 @@ static Map<String, Object> extractInputFilterDetails(@Nullable final Orchestrati
     } else if (error instanceof OrchestrationError.Streaming streamingError) {
       return Optional.of(streamingError.getErrorResponse())
           .map(ErrorResponseStreaming::getError)
+          .flatMap(OrchestrationClientException::lastErrorStreaming)
           .map(ErrorStreaming::getIntermediateResults)
           .map(ModuleResultsStreaming::getInputFiltering)
           .filter(filter -> !filter.getMessage().equals("Input Filter passed successfully."))
@@ -57,6 +62,29 @@ static Map<String, Object> extractInputFilterDetails(@Nullable final Orchestrati
     return Collections.emptyMap();
   }
 
+  static Optional<Error> lastError(final ErrorResponseError responseError) {
+    if (responseError instanceof ErrorResponseError.InnerError innerError) {
+      return Optional.of(innerError.value());
+    }
+    if (responseError instanceof ErrorResponseError.ListOfErrors listOfErrors) {
+      val list = listOfErrors.values();
+      return list.isEmpty() ? Optional.empty() : Optional.of(list.get(list.size() - 1));
+    }
+    return Optional.empty();
+  }
+
+  static Optional<ErrorStreaming> lastErrorStreaming(
+      final ErrorResponseStreamingError responseError) {
+    if (responseError instanceof ErrorResponseStreamingError.InnerErrorStreaming innerError) {
+      return Optional.of(innerError.value());
+    }
+    if (responseError instanceof ErrorResponseStreamingError.ListOfErrorStreamings listOfErrors) {
+      val list = listOfErrors.values();
+      return list.isEmpty() ? Optional.empty() : Optional.of(list.get(list.size() - 1));
+    }
+    return Optional.empty();
+  }
+
   @Override
   @Nullable
   public OrchestrationError getClientError() {
@@ -104,6 +132,7 @@ public ErrorResponseStreaming getErrorResponseStreaming() {
   public Integer getStatusCode() {
     return Optional.ofNullable(getErrorResponse())
         .map(ErrorResponse::getError)
+        .flatMap(OrchestrationClientException::lastError)
         .map(Error::getCode)
         .orElse(null);
   }

orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationError.java

@@ -1,5 +1,8 @@
 package com.sap.ai.sdk.orchestration;
 
+import static com.sap.ai.sdk.orchestration.OrchestrationClientException.lastError;
+import static com.sap.ai.sdk.orchestration.OrchestrationClientException.lastErrorStreaming;
+
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.google.common.annotations.Beta;
 import com.sap.ai.sdk.core.common.ClientError;
@@ -27,12 +30,14 @@ public interface OrchestrationError extends ClientError {
   @AllArgsConstructor(onConstructor = @__({@JsonCreator}), access = AccessLevel.PROTECTED)
   @Value
   class Synchronous implements OrchestrationError {
+    private static Error NOT_FOUND =
+        Error.create().requestId("").code(-1).message("Error not found.").location("");
     ErrorResponse errorResponse;
 
     @Override
     @Nonnull
     public String getMessage() {
-      final Error e = errorResponse.getError();
+      final Error e = lastError(errorResponse.getError()).orElse(NOT_FOUND);
       final String message = e.getMessage();
       return e.getCode() == 500 ? "%s located in %s".formatted(message, e.getLocation()) : message;
     }
@@ -46,12 +51,14 @@ public String getMessage() {
   @AllArgsConstructor(onConstructor = @__({@JsonCreator}), access = AccessLevel.PROTECTED)
   @Value
   class Streaming implements OrchestrationError {
+    private static ErrorStreaming NOT_FOUND =
+        ErrorStreaming.create().requestId("").code(-1).message("Error not found.").location("");
     ErrorResponseStreaming errorResponse;
 
     @Override
     @Nonnull
     public String getMessage() {
-      final ErrorStreaming e = errorResponse.getError();
+      final ErrorStreaming e = lastErrorStreaming(errorResponse.getError()).orElse(NOT_FOUND);
       final String message = e.getMessage();
       return e.getCode() == 500 ? "%s located in %s".formatted(message, e.getLocation()) : message;
     }

orchestration/src/main/java/com/sap/ai/sdk/orchestration/model/AzureContentSafetyInput.java

@@ -177,7 +177,8 @@ public void setViolence(@Nullable final AzureThreshold violence) {
    * Set the promptShield of this {@link AzureContentSafetyInput} instance and return the same
    * instance.
    *
-   * @param promptShield A flag to use prompt shield
+   * @param promptShield Filter prompts for harmful content such as jailbreaks and prompt
+   *     injections.
    * @return The same instance of this {@link AzureContentSafetyInput} class
    */
   @Nonnull
@@ -187,7 +188,7 @@ public AzureContentSafetyInput promptShield(@Nullable final Boolean promptShield
   }
 
   /**
-   * A flag to use prompt shield
+   * Filter prompts for harmful content such as jailbreaks and prompt injections.
    *
    * @return promptShield The promptShield of this {@link AzureContentSafetyInput} instance.
    */
@@ -199,7 +200,8 @@ public Boolean isPromptShield() {
   /**
    * Set the promptShield of this {@link AzureContentSafetyInput} instance.
    *
-   * @param promptShield A flag to use prompt shield
+   * @param promptShield Filter prompts for harmful content such as jailbreaks and prompt
+   *     injections.
    */
   public void setPromptShield(@Nullable final Boolean promptShield) {
     this.promptShield = promptShield;

orchestration/src/main/java/com/sap/ai/sdk/orchestration/model/AzureContentSafetyOutput.java

@@ -40,6 +40,9 @@ public class AzureContentSafetyOutput
   @JsonProperty("violence")
   private AzureThreshold violence;
 
+  @JsonProperty("protected_material_code")
+  private Boolean protectedMaterialCode = false;
+
   @JsonAnySetter @JsonAnyGetter
   private final Map<String, Object> cloudSdkCustomFields = new LinkedHashMap<>();
 
@@ -172,6 +175,45 @@ public void setViolence(@Nullable final AzureThreshold violence) {
     this.violence = violence;
   }
 
+  /**
+   * Set the protectedMaterialCode of this {@link AzureContentSafetyOutput} instance and return the
+   * same instance.
+   *
+   * @param protectedMaterialCode Detect protected code content from known GitHub repositories. The
+   *     scan includes software libraries, source code, algorithms, and other proprietary
+   *     programming content.
+   * @return The same instance of this {@link AzureContentSafetyOutput} class
+   */
+  @Nonnull
+  public AzureContentSafetyOutput protectedMaterialCode(
+      @Nullable final Boolean protectedMaterialCode) {
+    this.protectedMaterialCode = protectedMaterialCode;
+    return this;
+  }
+
+  /**
+   * Detect protected code content from known GitHub repositories. The scan includes software
+   * libraries, source code, algorithms, and other proprietary programming content.
+   *
+   * @return protectedMaterialCode The protectedMaterialCode of this {@link
+   *     AzureContentSafetyOutput} instance.
+   */
+  @Nonnull
+  public Boolean isProtectedMaterialCode() {
+    return protectedMaterialCode;
+  }
+
+  /**
+   * Set the protectedMaterialCode of this {@link AzureContentSafetyOutput} instance.
+   *
+   * @param protectedMaterialCode Detect protected code content from known GitHub repositories. The
+   *     scan includes software libraries, source code, algorithms, and other proprietary
+   *     programming content.
+   */
+  public void setProtectedMaterialCode(@Nullable final Boolean protectedMaterialCode) {
+    this.protectedMaterialCode = protectedMaterialCode;
+  }
+
   /**
    * Get the names of the unrecognizable properties of the {@link AzureContentSafetyOutput}.
    *
@@ -215,6 +257,8 @@ public Map<String, Object> toMap() {
     if (selfHarm != null) declaredFields.put("selfHarm", selfHarm);
     if (sexual != null) declaredFields.put("sexual", sexual);
     if (violence != null) declaredFields.put("violence", violence);
+    if (protectedMaterialCode != null)
+      declaredFields.put("protectedMaterialCode", protectedMaterialCode);
     return declaredFields;
   }
 
@@ -243,12 +287,15 @@ public boolean equals(@Nullable final java.lang.Object o) {
         && Objects.equals(this.hate, azureContentSafetyOutput.hate)
         && Objects.equals(this.selfHarm, azureContentSafetyOutput.selfHarm)
         && Objects.equals(this.sexual, azureContentSafetyOutput.sexual)
-        && Objects.equals(this.violence, azureContentSafetyOutput.violence);
+        && Objects.equals(this.violence, azureContentSafetyOutput.violence)
+        && Objects.equals(
+            this.protectedMaterialCode, azureContentSafetyOutput.protectedMaterialCode);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(hate, selfHarm, sexual, violence, cloudSdkCustomFields);
+    return Objects.hash(
+        hate, selfHarm, sexual, violence, protectedMaterialCode, cloudSdkCustomFields);
   }
 
   @Override
@@ -260,6 +307,9 @@ public String toString() {
     sb.append("    selfHarm: ").append(toIndentedString(selfHarm)).append("\n");
     sb.append("    sexual: ").append(toIndentedString(sexual)).append("\n");
     sb.append("    violence: ").append(toIndentedString(violence)).append("\n");
+    sb.append("    protectedMaterialCode: ")
+        .append(toIndentedString(protectedMaterialCode))
+        .append("\n");
     cloudSdkCustomFields.forEach(
         (k, v) ->
             sb.append("    ").append(k).append(": ").append(toIndentedString(v)).append("\n"));