|
1 | 1 | package com.sap.ai.sdk.foundationmodels.openai; |
2 | 2 |
|
3 | 3 | import com.sap.ai.sdk.core.AiModel; |
4 | | - |
5 | 4 | import javax.annotation.Nonnull; |
6 | 5 | import javax.annotation.Nullable; |
7 | 6 |
|
|
12 | 11 | * latest availability of OpenAI models in AI Core, please refer to <a |
13 | 12 | * href="https://me.sap.com/notes/3437766">SAP Availability of Generative AI Models </a>. |
14 | 13 | * |
15 | | - * @param name The name of the model. |
| 14 | + * @param name The name of the model. |
16 | 15 | * @param version The version of the model (optional). |
17 | 16 | */ |
18 | 17 | public record OpenAiModel(@Nonnull String name, @Nullable String version) implements AiModel { |
19 | 18 |
|
20 | | - /** |
21 | | - * internal [Azure OpenAI dall-e-3 model] |
22 | | - */ |
23 | | - public static final OpenAiModel DALL_E_3 = new OpenAiModel("dall-e-3", null); |
24 | | - |
25 | | - /** |
26 | | - * Azure OpenAI GPT-3.5 Turbo model |
27 | | - * |
28 | | - * @deprecated This model is deprecated on AI Core with a planned retirement on 2025-02-13. The |
29 | | - * suggested replacement model is {@link OpenAiModel#GPT_4O_MINI}. |
30 | | - */ |
31 | | - @Deprecated |
32 | | - public static final OpenAiModel GPT_35_TURBO = new OpenAiModel("gpt-35-turbo", null); |
33 | | - |
34 | | - /** |
35 | | - * Azure OpenAI GPT-3.5 Turbo model |
36 | | - * |
37 | | - * @deprecated This model is deprecated on AI Core with a planned retirement on 2025-02-22. The |
38 | | - * suggested replacement model is {@link OpenAiModel#GPT_4O_MINI}. |
39 | | - */ |
40 | | - @Deprecated |
41 | | - public static final OpenAiModel GPT_35_TURBO_1025 = new OpenAiModel("gpt-35-turbo-0125", null); |
42 | | - |
43 | | - /** |
44 | | - * Azure OpenAI GPT-3.5 Turbo model |
45 | | - * |
46 | | - * @deprecated This model is deprecated on AI Core with a planned retirement on 2025-02-13. The |
47 | | - * suggested replacement model is {@link OpenAiModel#GPT_4O_MINI}. |
48 | | - */ |
49 | | - @Deprecated |
50 | | - public static final OpenAiModel GPT_35_TURBO_16K = new OpenAiModel("gpt-35-turbo-16k", null); |
51 | | - |
52 | | - /** |
53 | | - * Azure OpenAI GPT-4 model |
54 | | - * |
55 | | - * @deprecated This model is deprecated on AI Core with a planned retirement on 2025-09-01. The |
56 | | - * suggested replacement model is {@link OpenAiModel#GPT_4O} or {@link OpenAiModel#GPT_41}. |
57 | | - */ |
58 | | - @Deprecated |
59 | | - public static final OpenAiModel GPT_4 = new OpenAiModel("gpt-4", null); |
60 | | - |
61 | | - /** |
62 | | - * Azure OpenAI GPT-4 model |
63 | | - * |
64 | | - * @deprecated This model is deprecated on AI Core. |
65 | | - */ |
66 | | - @Deprecated |
67 | | - public static final OpenAiModel GPT_4_32K = new OpenAiModel("gpt-4-32k", null); |
68 | | - |
69 | | - /** |
70 | | - * Azure OpenAI GPT-4o model |
71 | | - */ |
72 | | - public static final OpenAiModel GPT_4O = new OpenAiModel("gpt-4o", null); |
73 | | - |
74 | | - /** |
75 | | - * Azure OpenAI GPT-4o Mini model |
76 | | - */ |
77 | | - public static final OpenAiModel GPT_4O_MINI = new OpenAiModel("gpt-4o-mini", null); |
78 | | - |
79 | | - /** |
80 | | - * Azure OpenAI GPT-o3 Mini model |
81 | | - */ |
82 | | - public static final OpenAiModel O3_MINI = new OpenAiModel("o3-mini", null); |
83 | | - |
84 | | - /** |
85 | | - * Azure OpenAI GPT-o1 model |
86 | | - */ |
87 | | - public static final OpenAiModel O1 = new OpenAiModel("o1", null); |
88 | | - |
89 | | - /** |
90 | | - * Azure OpenAI Text Embedding 3 Large model |
91 | | - */ |
92 | | - public static final OpenAiModel TEXT_EMBEDDING_3_LARGE = |
93 | | - new OpenAiModel("text-embedding-3-large", null); |
94 | | - |
95 | | - /** |
96 | | - * Azure OpenAI Text Embedding 3 Small model |
97 | | - */ |
98 | | - public static final OpenAiModel TEXT_EMBEDDING_3_SMALL = |
99 | | - new OpenAiModel("text-embedding-3-small", null); |
100 | | - |
101 | | - /** |
102 | | - * Azure OpenAI GPT-o4 Mini model |
103 | | - */ |
104 | | - public static final OpenAiModel O4_MINI = new OpenAiModel("o4-mini", null); |
105 | | - |
106 | | - /** |
107 | | - * Azure OpenAI GPT-o3 model |
108 | | - */ |
109 | | - public static final OpenAiModel O3 = new OpenAiModel("o3", null); |
110 | | - |
111 | | - /** |
112 | | - * Azure OpenAI GPT-4.1 model |
113 | | - */ |
114 | | - public static final OpenAiModel GPT_41 = new OpenAiModel("gpt-4.1", null); |
115 | | - |
116 | | - /** |
117 | | - * Azure OpenAI GPT-4.1-nano model |
118 | | - */ |
119 | | - public static final OpenAiModel GPT_41_NANO = new OpenAiModel("gpt-4.1-nano", null); |
120 | | - |
121 | | - /** |
122 | | - * Azure OpenAI GPT-4.1-mini model |
123 | | - */ |
124 | | - public static final OpenAiModel GPT_41_MINI = new OpenAiModel("gpt-4.1-mini", null); |
125 | | - |
126 | | - /** |
127 | | - * Azure OpenAI GPT-5 model |
128 | | - */ |
129 | | - public static final OpenAiModel GPT_5 = new OpenAiModel("gpt-5", null); |
130 | | - |
131 | | - /** |
132 | | - * Azure OpenAI GPT-5-mini model |
133 | | - */ |
134 | | - public static final OpenAiModel GPT_5_MINI = new OpenAiModel("gpt-5-mini", null); |
135 | | - |
136 | | - /** |
137 | | - * Azure OpenAI GPT-5-nano model |
138 | | - */ |
139 | | - public static final OpenAiModel GPT_5_NANO = new OpenAiModel("gpt-5-nano", null); |
140 | | - |
141 | | - /** |
142 | | - * Azure OpenAI Text Embedding ADA 002 model |
143 | | - * |
144 | | - * @deprecated This model is deprecated on AI Core with a planned retirement on 2025-10-03. The |
145 | | - * suggested replacement models are {@link OpenAiModel#TEXT_EMBEDDING_3_SMALL} and {@link |
146 | | - * OpenAiModel#TEXT_EMBEDDING_3_LARGE}. |
147 | | - */ |
148 | | - @Deprecated |
149 | | - public static final OpenAiModel TEXT_EMBEDDING_ADA_002 = |
150 | | - new OpenAiModel("text-embedding-ada-002", null); |
151 | | - |
152 | | - /** |
153 | | - * Perplexity AI Sonar model |
154 | | - */ |
155 | | - public static final OpenAiModel SONAR = new OpenAiModel("sonar", "perplexity-us"); |
156 | | - |
157 | | - /** |
158 | | - * Perplexity AI Sonar Pro model |
159 | | - */ |
160 | | - public static final OpenAiModel SONAR_PRO = new OpenAiModel("sonar-pro", "perplexity-us"); |
161 | | - |
162 | | - /** |
163 | | - * Create a new instance of OpenAiModel with the provided version. |
164 | | - * |
165 | | - * @param version The version of the model. |
166 | | - * @return The new instance of OpenAiModel. |
167 | | - */ |
168 | | - @Nonnull |
169 | | - public OpenAiModel withVersion(@Nonnull final String version) { |
170 | | - return new OpenAiModel(name, version); |
171 | | - } |
| 19 | + /** internal [Azure OpenAI dall-e-3 model] */ |
| 20 | + public static final OpenAiModel DALL_E_3 = new OpenAiModel("dall-e-3", null); |
| 21 | + |
| 22 | + /** |
| 23 | + * Azure OpenAI GPT-3.5 Turbo model |
| 24 | + * |
| 25 | + * @deprecated This model is deprecated on AI Core with a planned retirement on 2025-02-13. The |
| 26 | + * suggested replacement model is {@link OpenAiModel#GPT_4O_MINI}. |
| 27 | + */ |
| 28 | + @Deprecated public static final OpenAiModel GPT_35_TURBO = new OpenAiModel("gpt-35-turbo", null); |
| 29 | + |
| 30 | + /** |
| 31 | + * Azure OpenAI GPT-3.5 Turbo model |
| 32 | + * |
| 33 | + * @deprecated This model is deprecated on AI Core with a planned retirement on 2025-02-22. The |
| 34 | + * suggested replacement model is {@link OpenAiModel#GPT_4O_MINI}. |
| 35 | + */ |
| 36 | + @Deprecated |
| 37 | + public static final OpenAiModel GPT_35_TURBO_1025 = new OpenAiModel("gpt-35-turbo-0125", null); |
| 38 | + |
| 39 | + /** |
| 40 | + * Azure OpenAI GPT-3.5 Turbo model |
| 41 | + * |
| 42 | + * @deprecated This model is deprecated on AI Core with a planned retirement on 2025-02-13. The |
| 43 | + * suggested replacement model is {@link OpenAiModel#GPT_4O_MINI}. |
| 44 | + */ |
| 45 | + @Deprecated |
| 46 | + public static final OpenAiModel GPT_35_TURBO_16K = new OpenAiModel("gpt-35-turbo-16k", null); |
| 47 | + |
| 48 | + /** |
| 49 | + * Azure OpenAI GPT-4 model |
| 50 | + * |
| 51 | + * @deprecated This model is deprecated on AI Core with a planned retirement on 2025-09-01. The |
| 52 | + * suggested replacement model is {@link OpenAiModel#GPT_4O} or {@link OpenAiModel#GPT_41}. |
| 53 | + */ |
| 54 | + @Deprecated public static final OpenAiModel GPT_4 = new OpenAiModel("gpt-4", null); |
| 55 | + |
| 56 | + /** |
| 57 | + * Azure OpenAI GPT-4 model |
| 58 | + * |
| 59 | + * @deprecated This model is deprecated on AI Core. |
| 60 | + */ |
| 61 | + @Deprecated public static final OpenAiModel GPT_4_32K = new OpenAiModel("gpt-4-32k", null); |
| 62 | + |
| 63 | + /** Azure OpenAI GPT-4o model */ |
| 64 | + public static final OpenAiModel GPT_4O = new OpenAiModel("gpt-4o", null); |
| 65 | + |
| 66 | + /** Azure OpenAI GPT-4o Mini model */ |
| 67 | + public static final OpenAiModel GPT_4O_MINI = new OpenAiModel("gpt-4o-mini", null); |
| 68 | + |
| 69 | + /** Azure OpenAI GPT-o3 Mini model */ |
| 70 | + public static final OpenAiModel O3_MINI = new OpenAiModel("o3-mini", null); |
| 71 | + |
| 72 | + /** Azure OpenAI GPT-o1 model */ |
| 73 | + public static final OpenAiModel O1 = new OpenAiModel("o1", null); |
| 74 | + |
| 75 | + /** Azure OpenAI Text Embedding 3 Large model */ |
| 76 | + public static final OpenAiModel TEXT_EMBEDDING_3_LARGE = |
| 77 | + new OpenAiModel("text-embedding-3-large", null); |
| 78 | + |
| 79 | + /** Azure OpenAI Text Embedding 3 Small model */ |
| 80 | + public static final OpenAiModel TEXT_EMBEDDING_3_SMALL = |
| 81 | + new OpenAiModel("text-embedding-3-small", null); |
| 82 | + |
| 83 | + /** Azure OpenAI GPT-o4 Mini model */ |
| 84 | + public static final OpenAiModel O4_MINI = new OpenAiModel("o4-mini", null); |
| 85 | + |
| 86 | + /** Azure OpenAI GPT-o3 model */ |
| 87 | + public static final OpenAiModel O3 = new OpenAiModel("o3", null); |
| 88 | + |
| 89 | + /** Azure OpenAI GPT-4.1 model */ |
| 90 | + public static final OpenAiModel GPT_41 = new OpenAiModel("gpt-4.1", null); |
| 91 | + |
| 92 | + /** Azure OpenAI GPT-4.1-nano model */ |
| 93 | + public static final OpenAiModel GPT_41_NANO = new OpenAiModel("gpt-4.1-nano", null); |
| 94 | + |
| 95 | + /** Azure OpenAI GPT-4.1-mini model */ |
| 96 | + public static final OpenAiModel GPT_41_MINI = new OpenAiModel("gpt-4.1-mini", null); |
| 97 | + |
| 98 | + /** Azure OpenAI GPT-5 model */ |
| 99 | + public static final OpenAiModel GPT_5 = new OpenAiModel("gpt-5", null); |
| 100 | + |
| 101 | + /** Azure OpenAI GPT-5-mini model */ |
| 102 | + public static final OpenAiModel GPT_5_MINI = new OpenAiModel("gpt-5-mini", null); |
| 103 | + |
| 104 | + /** Azure OpenAI GPT-5-nano model */ |
| 105 | + public static final OpenAiModel GPT_5_NANO = new OpenAiModel("gpt-5-nano", null); |
| 106 | + |
| 107 | + /** |
| 108 | + * Azure OpenAI Text Embedding ADA 002 model |
| 109 | + * |
| 110 | + * @deprecated This model is deprecated on AI Core with a planned retirement on 2025-10-03. The |
| 111 | + * suggested replacement models are {@link OpenAiModel#TEXT_EMBEDDING_3_SMALL} and {@link |
| 112 | + * OpenAiModel#TEXT_EMBEDDING_3_LARGE}. |
| 113 | + */ |
| 114 | + @Deprecated |
| 115 | + public static final OpenAiModel TEXT_EMBEDDING_ADA_002 = |
| 116 | + new OpenAiModel("text-embedding-ada-002", null); |
| 117 | + |
| 118 | + /** Perplexity AI Sonar model */ |
| 119 | + public static final OpenAiModel SONAR = new OpenAiModel("sonar", "perplexity-us"); |
| 120 | + |
| 121 | + /** Perplexity AI Sonar Pro model */ |
| 122 | + public static final OpenAiModel SONAR_PRO = new OpenAiModel("sonar-pro", "perplexity-us"); |
| 123 | + |
| 124 | + /** |
| 125 | + * Create a new instance of OpenAiModel with the provided version. |
| 126 | + * |
| 127 | + * @param version The version of the model. |
| 128 | + * @return The new instance of OpenAiModel. |
| 129 | + */ |
| 130 | + @Nonnull |
| 131 | + public OpenAiModel withVersion(@Nonnull final String version) { |
| 132 | + return new OpenAiModel(name, version); |
| 133 | + } |
172 | 134 | } |
0 commit comments