chore: [OpenAI] Deprecate manually written client and remove @Beta on generated client (#414)

* chore: [OpenAI] Deprecate manually written clien and remove `@Beta` on generated client

* release notes

* merge

Author: CharlesDuboisSAP

docs/release_notes.md

@@ -8,7 +8,8 @@
 
 ### 🔧 Compatibility Notes
 
--
+- The old OpenAI client (v1.0.0) is being deprecated in favor of the new OpenAI client (v1.4.0).
+  [See the documentation for more details](https://sap.github.io/ai-sdk/docs/java/foundation-models/openai/chat-completion)
 
 ### ✨ New Functionality
 

foundation-models/openai/pom.xml

@@ -157,7 +157,6 @@
             <artifactId>openapi-generator-maven-plugin</artifactId>
             <configuration>
               <outputDirectory>${project.basedir}/src/main/java</outputDirectory>
-              <apiMaturity>beta</apiMaturity>
               <enableOneOfAnyOfGeneration>true</enableOneOfAnyOfGeneration>
               <compileScope>COMPILE</compileScope>
               <deleteOutputDirectory>true</deleteOutputDirectory>

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

@@ -112,8 +112,7 @@ public static OpenAiClient withCustomDestination(@Nonnull final Destination dest
   }
 
   /**
-   * Use this method to set a system prompt that should be used across multiple chat completions
-   * with basic string prompts {@link #streamChatCompletionDeltas(OpenAiChatCompletionParameters)}.
+   * Add a system prompt before user prompts.
    *
    * <p>Note: The system prompt is ignored on chat completions invoked with
    * OpenAiChatCompletionPrompt.
@@ -133,8 +132,10 @@ public OpenAiClient withSystemPrompt(@Nonnull final String systemPrompt) {
    * @param prompt a text message.
    * @return the completion output
    * @throws OpenAiClientException if the request fails
+   * @deprecated Use {@link #chatCompletion(OpenAiChatCompletionRequest)} instead.
    */
   @Nonnull
+  @Deprecated
   public OpenAiChatCompletionOutput chatCompletion(@Nonnull final String prompt)
       throws OpenAiClientException {
     final OpenAiChatCompletionParameters parameters = new OpenAiChatCompletionParameters();
@@ -183,8 +184,10 @@ public CreateChatCompletionResponse chatCompletion(
    * @param parameters the completion request.
    * @return the completion output
    * @throws OpenAiClientException if the request fails
+   * @deprecated Use {@link #chatCompletion(OpenAiChatCompletionRequest)} instead.
    */
   @Nonnull
+  @Deprecated
   public OpenAiChatCompletionOutput chatCompletion(
       @Nonnull final OpenAiChatCompletionParameters parameters) throws OpenAiClientException {
     warnIfUnsupportedUsage();
@@ -321,8 +324,10 @@ public Stream<OpenAiChatCompletionDelta> streamChatCompletionDeltas(
    * @param parameters The prompt, including a list of messages.
    * @return A stream of message deltas
    * @throws OpenAiClientException if the request fails or if the finish reason is content_filter
+   * @deprecated Use {@link #streamChatCompletionDeltas(OpenAiChatCompletionRequest)} instead.
    */
   @Nonnull
+  @Deprecated
   public Stream<com.sap.ai.sdk.foundationmodels.openai.model.OpenAiChatCompletionDelta>
       streamChatCompletionDeltas(@Nonnull final OpenAiChatCompletionParameters parameters)
           throws OpenAiClientException {
@@ -383,6 +388,7 @@ public EmbeddingsCreate200Response embedding(@Nonnull final EmbeddingsCreateRequ
    * @throws OpenAiClientException if the request fails
    */
   @Nonnull
+  @Deprecated
   public OpenAiEmbeddingOutput embedding(@Nonnull final OpenAiEmbeddingParameters parameters)
       throws OpenAiClientException {
     return execute("/embeddings", parameters, OpenAiEmbeddingOutput.class);

foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/generated/model/ChatCompletionFunctionCall.java

@@ -15,7 +15,6 @@
 import com.fasterxml.jackson.annotation.JsonAnySetter;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
-import com.google.common.annotations.Beta;
 import java.util.LinkedHashMap;
 import java.util.Map;
 import java.util.NoSuchElementException;
@@ -28,7 +27,7 @@
  * Deprecated and replaced by `tool_calls`. The name and arguments of a function that
  * should be called, as generated by the model.
  */
-@Beta // CHECKSTYLE:OFF
+// CHECKSTYLE:OFF
 public class ChatCompletionFunctionCall
 // CHECKSTYLE:ON
 {

foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/generated/model/ChatCompletionFunctionCallOption.java

@@ -15,7 +15,6 @@
 import com.fasterxml.jackson.annotation.JsonAnySetter;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
-import com.google.common.annotations.Beta;
 import java.util.LinkedHashMap;
 import java.util.Map;
 import java.util.NoSuchElementException;
@@ -28,7 +27,7 @@
  * Specifying a particular function via `{\"name\": \"my_function\"}`
  * forces the model to call that function.
  */
-@Beta // CHECKSTYLE:OFF
+// CHECKSTYLE:OFF
 public class ChatCompletionFunctionCallOption
 // CHECKSTYLE:ON
 {

foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/generated/model/ChatCompletionFunctions.java

@@ -15,7 +15,6 @@
 import com.fasterxml.jackson.annotation.JsonAnySetter;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
-import com.google.common.annotations.Beta;
 import java.util.HashMap;
 import java.util.LinkedHashMap;
 import java.util.Map;
@@ -31,7 +30,7 @@
  * @deprecated
  */
 @Deprecated
-@Beta // CHECKSTYLE:OFF
+// CHECKSTYLE:OFF
 public class ChatCompletionFunctions
 // CHECKSTYLE:ON
 {

foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/generated/model/ChatCompletionMessageToolCall.java

@@ -15,7 +15,6 @@
 import com.fasterxml.jackson.annotation.JsonAnySetter;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
-import com.google.common.annotations.Beta;
 import java.util.LinkedHashMap;
 import java.util.Map;
 import java.util.NoSuchElementException;
@@ -25,7 +24,7 @@
 import javax.annotation.Nullable;
 
 /** ChatCompletionMessageToolCall */
-@Beta // CHECKSTYLE:OFF
+// CHECKSTYLE:OFF
 public class ChatCompletionMessageToolCall
 // CHECKSTYLE:ON
 {

foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/generated/model/ChatCompletionMessageToolCallChunk.java

@@ -17,7 +17,6 @@
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonValue;
-import com.google.common.annotations.Beta;
 import java.util.LinkedHashMap;
 import java.util.Map;
 import java.util.NoSuchElementException;
@@ -27,7 +26,7 @@
 import javax.annotation.Nullable;
 
 /** ChatCompletionMessageToolCallChunk */
-@Beta // CHECKSTYLE:OFF
+// CHECKSTYLE:OFF
 public class ChatCompletionMessageToolCallChunk
 // CHECKSTYLE:ON
 {

foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/generated/model/ChatCompletionMessageToolCallChunkFunction.java

@@ -15,7 +15,6 @@
 import com.fasterxml.jackson.annotation.JsonAnySetter;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
-import com.google.common.annotations.Beta;
 import java.util.LinkedHashMap;
 import java.util.Map;
 import java.util.NoSuchElementException;
@@ -25,7 +24,7 @@
 import javax.annotation.Nullable;
 
 /** ChatCompletionMessageToolCallChunkFunction */
-@Beta // CHECKSTYLE:OFF
+// CHECKSTYLE:OFF
 public class ChatCompletionMessageToolCallChunkFunction
 // CHECKSTYLE:ON
 {

foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/generated/model/ChatCompletionMessageToolCallFunction.java

@@ -15,7 +15,6 @@
 import com.fasterxml.jackson.annotation.JsonAnySetter;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
-import com.google.common.annotations.Beta;
 import java.util.LinkedHashMap;
 import java.util.Map;
 import java.util.NoSuchElementException;
@@ -25,7 +24,7 @@
 import javax.annotation.Nullable;
 
 /** The function that the model called. */
-@Beta // CHECKSTYLE:OFF
+// CHECKSTYLE:OFF
 public class ChatCompletionMessageToolCallFunction
 // CHECKSTYLE:ON
 {