tag public api with @since

- make jackson mixin package private

Author: rpanackal

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

@@ -10,5 +10,5 @@
 final class JacksonMixins {
   @JsonTypeInfo(use = JsonTypeInfo.Id.NONE)
   @JsonDeserialize(as = CreateChatCompletionStreamResponse.class)
-  public interface DefaultChatCompletionCreate200ResponseMixIn {}
+  interface DefaultChatCompletionCreate200ResponseMixIn {}
 }

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

@@ -6,7 +6,11 @@
 import lombok.Value;
 import lombok.experimental.Accessors;
 
-/** Represents a chat message as 'assistant' to OpenAI service. */
+/**
+ * Represents a chat message as 'assistant' to OpenAI service.
+ *
+ * @since 1.3.0
+ */
 @Value
 @Accessors(fluent = true)
 class OpenAiAssistantMessage implements OpenAiMessage {

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

@@ -18,6 +18,8 @@
 
 /**
  * Represents a request for OpenAI chat completion, including conversation messages and parameters.
+ *
+ * @since 1.3.0
  */
 @Accessors(fluent = true)
 @Data

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

@@ -11,7 +11,11 @@
 import lombok.Data;
 import lombok.RequiredArgsConstructor;
 
-/** Represents the output of an OpenAI chat completion. */
+/**
+ * Represents the output of an OpenAI chat completion. *
+ *
+ * @since 1.3.0
+ */
 @Data
 @RequiredArgsConstructor(access = PACKAGE)
 public class OpenAiChatCompletionResponse {

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

@@ -158,6 +158,7 @@ public OpenAiChatCompletionOutput chatCompletion(@Nonnull final String prompt)
    * @param request the completion request.
    * @return the completion output
    * @throws OpenAiClientException if the request fails
+   * @since 1.3.0
    */
   @Nonnull
   public OpenAiChatCompletionResponse chatCompletion(
@@ -173,6 +174,7 @@ public OpenAiChatCompletionResponse chatCompletion(
    * @param request the completion request.
    * @return the completion output
    * @throws OpenAiClientException if the request fails
+   * @since 1.3.0
    */
   @Nonnull
   public CreateChatCompletionResponse chatCompletion(
@@ -272,6 +274,7 @@ private static void throwOnContentFilter(@Nonnull final OpenAiChatCompletionDelt
    * @return A stream of message deltas
    * @throws OpenAiClientException if the request fails or if the finish reason is content_filter
    * @see #streamChatCompletion(String)
+   * @since 1.3.0
    */
   @Nonnull
   public Stream<OpenAiChatCompletionDelta> streamChatCompletionDeltas(
@@ -287,6 +290,7 @@ public Stream<OpenAiChatCompletionDelta> streamChatCompletionDeltas(
    * @return A stream of message deltas
    * @throws OpenAiClientException if the request fails or if the finish reason is content_filter
    * @see #streamChatCompletionDeltas(OpenAiChatCompletionRequest) for a higher-level API
+   * @since 1.3.0
    */
   @Nonnull
   public Stream<OpenAiChatCompletionDelta> streamChatCompletionDeltas(
@@ -351,6 +355,7 @@ private void warnIfUnsupportedUsage() {
    * @param input the input text.
    * @return the embedding output
    * @throws OpenAiClientException if the request fails
+   * @since 1.3.0
    */
   @Nonnull
   public EmbeddingsCreate200Response embedding(@Nonnull final String input)
@@ -366,6 +371,7 @@ public EmbeddingsCreate200Response embedding(@Nonnull final String input)
    * @param request the request with input text.
    * @return the embedding output
    * @throws OpenAiClientException if the request fails
+   * @since 1.3.0
    */
   @Nonnull
   public EmbeddingsCreate200Response embedding(@Nonnull final EmbeddingsCreateRequest request)

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

@@ -10,7 +10,11 @@
 import lombok.Value;
 import lombok.experimental.Delegate;
 
-/** Represents an error response from the OpenAI API. */
+/**
+ * Represents an error response from the OpenAI API.
+ *
+ * @since 1.3.0
+ */
 @Beta
 @Value
 @AllArgsConstructor(onConstructor = @__({@JsonCreator}), access = AccessLevel.PROTECTED)

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

@@ -3,7 +3,11 @@
 import com.sap.ai.sdk.foundationmodels.openai.model2.ChatCompletionRequestMessage;
 import javax.annotation.Nonnull;
 
-/** Interface representing convenience wrappers of chat message to the openai service. */
+/**
+ * Interface representing convenience wrappers of chat message to the openai service.
+ *
+ * @since 1.3.0
+ */
 public interface OpenAiMessage {
 
   /**

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

@@ -6,7 +6,11 @@
 import lombok.Value;
 import lombok.experimental.Accessors;
 
-/** Represents a chat message as 'system' to OpenAI service. */
+/**
+ * Represents a chat message as 'system' to OpenAI service. *
+ *
+ * @since 1.3.0
+ */
 @Value
 @Accessors(fluent = true)
 class OpenAiSystemMessage implements OpenAiMessage {

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

@@ -6,7 +6,11 @@
 import lombok.Value;
 import lombok.experimental.Accessors;
 
-/** Represents a chat message as 'user' to OpenAI service. */
+/**
+ * Represents a chat message as 'user' to OpenAI service. *
+ *
+ * @since 1.3.0
+ */
 @Value
 @Accessors(fluent = true)
 class OpenAiUserMessage implements OpenAiMessage {