diff --git a/foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/OpenAiModel.java b/foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/OpenAiModel.java index 468eae9b9..e3236958d 100644 --- a/foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/OpenAiModel.java +++ b/foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/OpenAiModel.java @@ -16,53 +16,57 @@ */ public record OpenAiModel(@Nonnull String name, @Nullable String version) implements AiModel { - /** Azure OpenAI dall-e-3 image generate model */ + /** internal [Azure OpenAI dall-e-3 model] */ public static final OpenAiModel DALL_E_3 = new OpenAiModel("dall-e-3", null); /** - * Azure OpenAI GPT-3.5 Turbo chat completions model + * Azure OpenAI GPT-3.5 Turbo model * - * @deprecated This model is not usable anymore. It is retired on AI Core since 2024-11-17. + * @deprecated This model is deprecated on AI Core with a planned retirement on 2025-02-13. The + * suggested replacement model is {@link OpenAiModel#GPT_4O_MINI}. */ @Deprecated public static final OpenAiModel GPT_35_TURBO = new OpenAiModel("gpt-35-turbo", null); /** - * Azure OpenAI GPT-3.5 Turbo chat completions model + * Azure OpenAI GPT-3.5 Turbo model * - * @deprecated This model is not usable anymore. It is retired on AI Core since 2025-02-22. + * @deprecated This model is deprecated on AI Core with a planned retirement on 2025-02-22. The + * suggested replacement model is {@link OpenAiModel#GPT_4O_MINI}. */ @Deprecated public static final OpenAiModel GPT_35_TURBO_1025 = new OpenAiModel("gpt-35-turbo-0125", null); /** - * Azure OpenAI GPT-3.5 Turbo chat completions model + * Azure OpenAI GPT-3.5 Turbo model * - * @deprecated This model is not usable anymore. It is retired on AI Core since 2025-02-13. + * @deprecated This model is deprecated on AI Core with a planned retirement on 2025-02-13. The + * suggested replacement model is {@link OpenAiModel#GPT_4O_MINI}. */ @Deprecated public static final OpenAiModel GPT_35_TURBO_16K = new OpenAiModel("gpt-35-turbo-16k", null); - /** Azure OpenAI GPT-4 chat completions model */ + /** Azure OpenAI GPT-4 model */ public static final OpenAiModel GPT_4 = new OpenAiModel("gpt-4", null); /** - * Azure OpenAI GPT-4-32k chat completions model + * Azure OpenAI GPT-4 model * - * @deprecated This model will not be usable anymore on 2025-05-30. + * @deprecated This model is deprecated on AI Core with a planned retirement on 2025-05-13. The + * suggested replacement model is {@link OpenAiModel#GPT_4O}. */ @Deprecated public static final OpenAiModel GPT_4_32K = new OpenAiModel("gpt-4-32k", null); - /** Azure OpenAI GPT-4o chat completions model */ + /** Azure OpenAI GPT-4o model */ public static final OpenAiModel GPT_4O = new OpenAiModel("gpt-4o", null); - /** Azure OpenAI GPT-4o Mini chat completions model */ + /** Azure OpenAI GPT-4o Mini model */ public static final OpenAiModel GPT_4O_MINI = new OpenAiModel("gpt-4o-mini", null); - /** Azure OpenAI GPT-o3 Mini chat completions model */ - public static final OpenAiModel GPT_O3_MINI = new OpenAiModel("o3-mini", null); + /** Azure OpenAI GPT-o3 Mini model */ + public static final OpenAiModel O3_MINI = new OpenAiModel("o3-mini", null); - /** Azure OpenAI GPT-o1 chat completions model */ - public static final OpenAiModel GPT_O1 = new OpenAiModel("o1", null); + /** Azure OpenAI GPT-o1 model */ + public static final OpenAiModel O1 = new OpenAiModel("o1", null); /** Azure OpenAI Text Embedding 3 Large model */ public static final OpenAiModel TEXT_EMBEDDING_3_LARGE = @@ -75,7 +79,9 @@ public record OpenAiModel(@Nonnull String name, @Nullable String version) implem /** * Azure OpenAI Text Embedding ADA 002 model * - * @deprecated This model is deprecated on AI Core. + * @deprecated This model is deprecated on AI Core with a planned retirement on 2025-10-03. The + * suggested replacement models are {@link OpenAiModel#TEXT_EMBEDDING_3_SMALL} and {@link + * OpenAiModel#TEXT_EMBEDDING_3_LARGE}. */ @Deprecated public static final OpenAiModel TEXT_EMBEDDING_ADA_002 = diff --git a/orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationAiModel.java b/orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationAiModel.java index 0bfc8e934..e595db8e5 100644 --- a/orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationAiModel.java +++ b/orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationAiModel.java @@ -44,7 +44,7 @@ public class OrchestrationAiModel { /** The version of the model, defaults to "latest". */ String version; - /** IBM Granite 13B chat completions model */ + /** IBM Granite 13B Chat model */ public static final OrchestrationAiModel IBM_GRANITE_13B_CHAT = new OrchestrationAiModel("ibm--granite-13b-chat"); @@ -56,7 +56,13 @@ public class OrchestrationAiModel { public static final OrchestrationAiModel MIXTRAL_8X7B_INSTRUCT_V01 = new OrchestrationAiModel("mistralai--mixtral-8x7b-instruct-v01"); - /** Meta Llama3 70B Instruct model */ + /** + * Meta Llama3 70B Instruct model + * + * @deprecated This model is deprecated on AI Core with a planned retirement on 2024-12-15. The + * suggested replacement model is {@link OrchestrationAiModel#LLAMA3_1_70B_INSTRUCT}. + */ + @Deprecated public static final OrchestrationAiModel LLAMA3_70B_INSTRUCT = new OrchestrationAiModel("meta--llama3-70b-instruct"); @@ -99,34 +105,59 @@ public class OrchestrationAiModel { public static final OrchestrationAiModel NOVA_MICRO = new OrchestrationAiModel("amazon--nova-micro"); - /** Azure OpenAI GPT-3.5 Turbo chat completions model */ + /** + * Azure OpenAI GPT-3.5 Turbo model + * + * @deprecated This model is deprecated on AI Core with a planned retirement on 2025-02-13. The + * suggested replacement model is {@link OrchestrationAiModel#GPT_4O_MINI}. + */ + @Deprecated public static final OrchestrationAiModel GPT_35_TURBO = new OrchestrationAiModel("gpt-35-turbo"); /** - * Azure OpenAI GPT-3.5 Turbo chat completions model + * Azure OpenAI GPT-3.5 Turbo model * - * @deprecated This model is not usable anymore. It is retired on AI Core since 2025-02-13. + * @deprecated This model is deprecated on AI Core with a planned retirement on 2025-02-13. The + * suggested replacement model is {@link OrchestrationAiModel#GPT_4O_MINI}. */ @Deprecated public static final OrchestrationAiModel GPT_35_TURBO_16K = new OrchestrationAiModel("gpt-35-turbo-16k"); - /** Azure OpenAI GPT-3.5 Turbo chat completions model */ + /** + * Azure OpenAI GPT-3.5 Turbo model + * + * @deprecated This model is deprecated on AI Core with a planned retirement on 2025-02-22. The + * suggested replacement model is {@link OrchestrationAiModel#GPT_4O_MINI}. + */ + @Deprecated public static final OrchestrationAiModel GPT_35_TURBO_0125 = new OrchestrationAiModel("gpt-35-turbo-0125"); - /** Azure OpenAI GPT-4 chat completions model */ + /** Azure OpenAI GPT-4 model */ public static final OrchestrationAiModel GPT_4 = new OrchestrationAiModel("gpt-4"); - /** Azure OpenAI GPT-4-32k chat completions model */ + /** + * Azure OpenAI GPT-4 model + * + * @deprecated This model is deprecated on AI Core with a planned retirement on 2025-05-13. The + * suggested replacement model is {@link OrchestrationAiModel#GPT_4O}. + */ + @Deprecated public static final OrchestrationAiModel GPT_4_32K = new OrchestrationAiModel("gpt-4-32k"); - /** Azure OpenAI GPT-4o chat completions model */ + /** Azure OpenAI GPT-4o model */ public static final OrchestrationAiModel GPT_4O = new OrchestrationAiModel("gpt-4o"); - /** Azure OpenAI GPT-4o-mini chat completions model */ + /** Azure OpenAI GPT-4o-mini model */ public static final OrchestrationAiModel GPT_4O_MINI = new OrchestrationAiModel("gpt-4o-mini"); + /** Azure OpenAI o1 model */ + public static final OrchestrationAiModel OPENAI_O1 = new OrchestrationAiModel("o1"); + + /** Azure OpenAI o3-mini model */ + public static final OrchestrationAiModel OPENAI_O3_MINI = new OrchestrationAiModel("o3-mini"); + /** Google Cloud Platform Gemini 1.0 Pro model */ public static final OrchestrationAiModel GEMINI_1_0_PRO = new OrchestrationAiModel("gemini-1.0-pro");