Merge branch 'main' into add-links-orch-docs

Author: Jonas-Isr

docs/guides/ORCHESTRATION_CHAT_COMPLETION.md

@@ -102,10 +102,7 @@ The LLM response is available as the first choice under the `result.getOrchestra
 Use a prepared template and execute requests with by passing only the input parameters:
 
 ```java
-var template =
-    ChatMessage.create()
-        .role("user")
-        .content("Reply with 'Orchestration Service is working!' in {{?language}}");
+var template = Message.user("Reply with 'Orchestration Service is working!' in {{?language}}");
 var templatingConfig = TemplatingModuleConfig.create().template(template);
 var configWithTemplate = config.withTemplateConfig(templatingConfig);
 
@@ -124,10 +121,10 @@ Include a message history to maintain context in the conversation:
 ```java
 var messagesHistory =
         List.of(
-                ChatMessage.create().role("user").content("What is the capital of France?"),
-                ChatMessage.create().role("assistant").content("The capital of France is Paris."));
+            Message.user("What is the capital of France?"),
+            Message.assistant("The capital of France is Paris."));
 var message =
-        ChatMessage.create().role("user").content("What is the typical food there?");
+    Message.user("What is the typical food there?");
 
 var prompt = new OrchestrationPrompt(message).messageHistory(messagesHistory);
 
@@ -175,12 +172,8 @@ var maskingConfig =
     DpiMasking.anonymization().withEntities(DPIEntities.PHONE, DPIEntities.PERSON);
 var configWithMasking = config.withMaskingConfig(maskingConfig);
 
-var systemMessage = ChatMessage.create()
-        .role("system")
-        .content("Please evaluate the following user feedback and judge if the sentiment is positive or negative.");
-var userMessage = ChatMessage.create()
-        .role("user")
-        .content("""
+var systemMessage = Message.system("Please evaluate the following user feedback and judge if the sentiment is positive or negative.");
+var userMessage = Message.user("""
                  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.
                  """);

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

@@ -1,5 +1,6 @@
 package com.sap.ai.sdk.orchestration;
 
+import com.google.common.annotations.Beta;
 import com.sap.ai.sdk.orchestration.model.ChatMessage;
 import javax.annotation.Nonnull;
 
@@ -63,5 +64,6 @@ default ChatMessage createChatMessage() {
    * @return the content.
    */
   @Nonnull
+  @Beta
   String content();
 }

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

@@ -9,7 +9,6 @@
 import com.sap.ai.sdk.orchestration.model.TokenUsage;
 import java.util.ArrayList;
 import java.util.List;
-import java.util.Objects;
 import javax.annotation.Nonnull;
 import lombok.RequiredArgsConstructor;
 import lombok.Value;
@@ -54,10 +53,21 @@ public TokenUsage getTokenUsage() {
    * @return A list of all messages.
    */
   @Nonnull
-  public List<ChatMessage> getAllMessages() {
-    final var items = Objects.requireNonNull(originalResponse.getModuleResults().getTemplating());
-    final var messages = new ArrayList<>(items);
-    messages.add(getCurrentChoice().getMessage());
+  public List<Message> getAllMessages() {
+    final var messages = new ArrayList<Message>();
+
+    for (final ChatMessage chatMessage : originalResponse.getModuleResults().getTemplating()) {
+      final var message =
+          switch (chatMessage.getRole()) {
+            case "user" -> new UserMessage(chatMessage.getContent());
+            case "assistant" -> new AssistantMessage(chatMessage.getContent());
+            case "system" -> new SystemMessage(chatMessage.getContent());
+            default -> throw new IllegalStateException("Unexpected role: " + chatMessage.getRole());
+          };
+      messages.add(message);
+    }
+
+    messages.add(new AssistantMessage(getCurrentChoice().getMessage().getContent()));
     return messages;
   }
 

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

@@ -2,7 +2,7 @@
  * Orchestration
  * Orchestration is an inference service which provides common additional capabilities for business AI scenarios, such as content filtering and data masking. At the core of the service is the LLM module which allows for an easy, harmonized access to the language models of gen AI hub. The service is designed to be modular and extensible, allowing for the addition of new modules in the future. Each module can be configured independently and at runtime, allowing for a high degree of flexibility in the orchestration of AI services.
  *
- * The version of the OpenAPI document: 0.29.3
+ * The version of the OpenAPI document: 0.36.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Orchestration
  * Orchestration is an inference service which provides common additional capabilities for business AI scenarios, such as content filtering and data masking. At the core of the service is the LLM module which allows for an easy, harmonized access to the language models of gen AI hub. The service is designed to be modular and extensible, allowing for the addition of new modules in the future. Each module can be configured independently and at runtime, allowing for a high degree of flexibility in the orchestration of AI services.
  *
- * The version of the OpenAPI document: 0.29.3
+ * The version of the OpenAPI document: 0.36.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Orchestration
  * Orchestration is an inference service which provides common additional capabilities for business AI scenarios, such as content filtering and data masking. At the core of the service is the LLM module which allows for an easy, harmonized access to the language models of gen AI hub. The service is designed to be modular and extensible, allowing for the addition of new modules in the future. Each module can be configured independently and at runtime, allowing for a high degree of flexibility in the orchestration of AI services.
  *
- * The version of the OpenAPI document: 0.29.3
+ * The version of the OpenAPI document: 0.36.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Orchestration
  * Orchestration is an inference service which provides common additional capabilities for business AI scenarios, such as content filtering and data masking. At the core of the service is the LLM module which allows for an easy, harmonized access to the language models of gen AI hub. The service is designed to be modular and extensible, allowing for the addition of new modules in the future. Each module can be configured independently and at runtime, allowing for a high degree of flexibility in the orchestration of AI services.
  *
- * The version of the OpenAPI document: 0.29.3
+ * The version of the OpenAPI document: 0.36.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Orchestration
  * Orchestration is an inference service which provides common additional capabilities for business AI scenarios, such as content filtering and data masking. At the core of the service is the LLM module which allows for an easy, harmonized access to the language models of gen AI hub. The service is designed to be modular and extensible, allowing for the addition of new modules in the future. Each module can be configured independently and at runtime, allowing for a high degree of flexibility in the orchestration of AI services.
  *
- * The version of the OpenAPI document: 0.29.3
+ * The version of the OpenAPI document: 0.36.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Orchestration
  * Orchestration is an inference service which provides common additional capabilities for business AI scenarios, such as content filtering and data masking. At the core of the service is the LLM module which allows for an easy, harmonized access to the language models of gen AI hub. The service is designed to be modular and extensible, allowing for the addition of new modules in the future. Each module can be configured independently and at runtime, allowing for a high degree of flexibility in the orchestration of AI services.
  *
- * The version of the OpenAPI document: 0.29.3
+ * The version of the OpenAPI document: 0.36.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Orchestration
  * Orchestration is an inference service which provides common additional capabilities for business AI scenarios, such as content filtering and data masking. At the core of the service is the LLM module which allows for an easy, harmonized access to the language models of gen AI hub. The service is designed to be modular and extensible, allowing for the addition of new modules in the future. Each module can be configured independently and at runtime, allowing for a high degree of flexibility in the orchestration of AI services.
  *
- * The version of the OpenAPI document: 0.29.3
+ * The version of the OpenAPI document: 0.36.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).