feat: [OpenAI] Stable convenience - Latest

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

@@ -0,0 +1,25 @@
+package com.sap.ai.sdk.foundationmodels.openai;
+
+import com.fasterxml.jackson.annotation.JsonTypeInfo;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.sap.ai.sdk.foundationmodels.openai.generated.model.CreateChatCompletionStreamResponse;
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
+
+/**
+ * This class contains Jackson Mixins for customizing the serialization and deserialization behavior
+ * of certain classes in the OpenAI SDK.
+ */
+@NoArgsConstructor(access = AccessLevel.PRIVATE)
+final class JacksonMixins {
+
+  /**
+   * Mixin interface to customize the deserialization of CreateChatCompletionStreamResponse.
+   *
+   * <p>Disables type information inclusion and specifies the concrete class to use for
+   * deserialization.
+   */
+  @JsonTypeInfo(use = JsonTypeInfo.Id.NONE)
+  @JsonDeserialize(as = CreateChatCompletionStreamResponse.class)
+  interface DefaultChatCompletionCreate200ResponseMixIn {}
+}

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

@@ -0,0 +1,37 @@
+package com.sap.ai.sdk.foundationmodels.openai;
+
+import com.google.common.annotations.Beta;
+import com.sap.ai.sdk.foundationmodels.openai.generated.model.ChatCompletionRequestAssistantMessage;
+import com.sap.ai.sdk.foundationmodels.openai.generated.model.ChatCompletionRequestAssistantMessageContent;
+import javax.annotation.Nonnull;
+import lombok.Value;
+import lombok.experimental.Accessors;
+
+/**
+ * Represents a chat message as 'assistant' to OpenAI service.
+ *
+ * @since 1.4.0
+ */
+@Beta
+@Value
+@Accessors(fluent = true)
+class OpenAiAssistantMessage implements OpenAiMessage {
+
+  /** The role of the message. */
+  @Nonnull String role = "assistant";
+
+  /** The content of the message. */
+  @Nonnull String content;
+
+  /**
+   * Converts the message to a serializable object.
+   *
+   * @return the corresponding {@code ChatCompletionRequestAssistantMessage} object.
+   */
+  @Nonnull
+  ChatCompletionRequestAssistantMessage toChatCompletionRequestSystemMessage() {
+    return new ChatCompletionRequestAssistantMessage()
+        .role(ChatCompletionRequestAssistantMessage.RoleEnum.fromValue(role()))
+        .content(ChatCompletionRequestAssistantMessageContent.create(content));
+  }
+}

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

@@ -0,0 +1,78 @@
+package com.sap.ai.sdk.foundationmodels.openai;
+
+import static lombok.AccessLevel.NONE;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.google.common.annotations.Beta;
+import com.sap.ai.sdk.core.common.StreamedDelta;
+import com.sap.ai.sdk.foundationmodels.openai.generated.model.CompletionUsage;
+import com.sap.ai.sdk.foundationmodels.openai.generated.model.CreateChatCompletionStreamResponse;
+import java.util.Map;
+import java.util.Objects;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+import lombok.RequiredArgsConstructor;
+import lombok.Setter;
+import lombok.Value;
+
+/**
+ * Represents an OpenAI chat completion output delta for streaming.
+ *
+ * @since 1.4.0
+ */
+@Beta
+@Value
+@RequiredArgsConstructor(onConstructor_ = @JsonCreator)
+@Setter(value = NONE)
+public class OpenAiChatCompletionDelta implements StreamedDelta {
+  /** The original response from the chat completion stream. */
+  @Nonnull final CreateChatCompletionStreamResponse originalResponse;
+
+  /**
+   * Retrieves the delta content from the original response.
+   *
+   * @return The delta content as a string, or an empty string if not available.
+   */
+  @Nonnull
+  @Override
+  public String getDeltaContent() {
+    final var choices = getOriginalResponse().getChoices();
+    if (!choices.isEmpty() && choices.get(0).getIndex() == 0) {
+      final var message = choices.get(0).getDelta();
+      return Objects.requireNonNullElse(message.getContent(), "");
+    }
+    return "";
+  }
+
+  /**
+   * Retrieves the finish reason from the original response.
+   *
+   * @return The finish reason as a string, or null if not available.
+   */
+  @Nullable
+  @Override
+  public String getFinishReason() {
+    final var choices = getOriginalResponse().getChoices();
+    if (!choices.isEmpty()) {
+      final var finishReason = choices.get(0).getFinishReason();
+      return finishReason != null ? finishReason.getValue() : null;
+    }
+    return null;
+  }
+
+  /**
+   * Retrieves the completion usage from the response, or null if it is not available.
+   *
+   * @param objectMapper The object mapper to use for conversion.
+   * @return The completion usage or null.
+   */
+  @Nullable
+  public CompletionUsage getCompletionUsage(@Nonnull final ObjectMapper objectMapper) {
+    if (getOriginalResponse().getCustomFieldNames().contains("usage")
+        && getOriginalResponse().getCustomField("usage") instanceof Map<?, ?> usage) {
+      return objectMapper.convertValue(usage, CompletionUsage.class);
+    }
+    return null;
+  }
+}