Implementation of the OpenAI Java SDK

Create the OpenAiOfficialChatModel class:
- This is a first implementation that is not of good quality yet
- Tests do not pass yet

Signed-off-by: Julien Dubois <[email protected]>

Author: jdubois

models/spring-ai-openai-official/src/main/java/org/springframework/ai/openaiofficial/OpenAiOfficialChatModel.java

@@ -37,13 +37,17 @@
 import java.util.Objects;
 import java.util.Set;
 
+import static com.openai.models.ChatModel.GPT_5_MINI;
+
 /**
  * Configuration information for the Chat Model implementation using the OpenAI Java SDK.
  *
  * @author Julien Dubois
  */
 public class OpenAiOfficialChatOptions extends AbstractOpenAiOfficialOptions implements ToolCallingChatOptions {
 
+	public static final String DEFAULT_CHAT_MODEL = GPT_5_MINI.asString();
+
 	private static final Logger logger = LoggerFactory.getLogger(OpenAiOfficialChatOptions.class);
 
 	private Double frequencyPenalty;
@@ -60,8 +64,6 @@ public class OpenAiOfficialChatOptions extends AbstractOpenAiOfficialOptions imp
 
 	private Integer n;
 
-	private List<String> outputModalities;
-
 	private ChatCompletionAudioParam outputAudio;
 
 	private Double presencePenalty;
@@ -164,14 +166,6 @@ public void setN(Integer n) {
 		this.n = n;
 	}
 
-	public List<String> getOutputModalities() {
-		return this.outputModalities;
-	}
-
-	public void setOutputModalities(List<String> outputModalities) {
-		this.outputModalities = outputModalities;
-	}
-
 	public ChatCompletionAudioParam getOutputAudio() {
 		return this.outputAudio;
 	}
@@ -396,8 +390,7 @@ public boolean equals(Object o) {
 		return Objects.equals(frequencyPenalty, options.frequencyPenalty)
 				&& Objects.equals(logitBias, options.logitBias) && Objects.equals(logprobs, options.logprobs)
 				&& Objects.equals(topLogprobs, options.topLogprobs) && Objects.equals(maxTokens, options.maxTokens)
-				&& Objects.equals(n, options.n) && Objects.equals(outputModalities, options.outputModalities)
-				&& Objects.equals(outputAudio, options.outputAudio)
+				&& Objects.equals(n, options.n) && Objects.equals(outputAudio, options.outputAudio)
 				&& Objects.equals(presencePenalty, options.presencePenalty)
 				&& Objects.equals(responseFormat, options.responseFormat)
 				&& Objects.equals(streamOptions, options.streamOptions) && Objects.equals(seed, options.seed)
@@ -415,24 +408,24 @@ public boolean equals(Object o) {
 
 	@Override
 	public int hashCode() {
-		return Objects.hash(frequencyPenalty, logitBias, logprobs, topLogprobs, maxTokens, n, outputModalities,
-				outputAudio, presencePenalty, responseFormat, streamOptions, seed, stop, temperature, topP, tools,
-				toolChoice, user, parallelToolCalls, store, metadata, reasoningEffort, verbosity, serviceTier,
-				toolCallbacks, toolNames, internalToolExecutionEnabled, httpHeaders, toolContext);
+		return Objects.hash(frequencyPenalty, logitBias, logprobs, topLogprobs, maxTokens, n, outputAudio,
+				presencePenalty, responseFormat, streamOptions, seed, stop, temperature, topP, tools, toolChoice, user,
+				parallelToolCalls, store, metadata, reasoningEffort, verbosity, serviceTier, toolCallbacks, toolNames,
+				internalToolExecutionEnabled, httpHeaders, toolContext);
 	}
 
 	@Override
 	public String toString() {
 		return "OpenAiOfficialChatOptions{" + "frequencyPenalty=" + frequencyPenalty + ", logitBias=" + logitBias
 				+ ", logprobs=" + logprobs + ", topLogprobs=" + topLogprobs + ", maxTokens=" + maxTokens + ", n=" + n
-				+ ", outputModalities=" + outputModalities + ", outputAudio=" + outputAudio + ", presencePenalty="
-				+ presencePenalty + ", responseFormat=" + responseFormat + ", streamOptions=" + streamOptions
-				+ ", seed=" + seed + ", stop=" + stop + ", temperature=" + temperature + ", topP=" + topP + ", tools="
-				+ tools + ", toolChoice=" + toolChoice + ", user='" + user + '\'' + ", parallelToolCalls="
-				+ parallelToolCalls + ", store=" + store + ", metadata=" + metadata + ", reasoningEffort='"
-				+ reasoningEffort + '\'' + ", verbosity='" + verbosity + '\'' + ", serviceTier='" + serviceTier + '\''
-				+ ", toolCallbacks=" + toolCallbacks + ", toolNames=" + toolNames + ", internalToolExecutionEnabled="
-				+ internalToolExecutionEnabled + ", httpHeaders=" + httpHeaders + ", toolContext=" + toolContext + '}';
+				+ ", outputAudio=" + outputAudio + ", presencePenalty=" + presencePenalty + ", responseFormat="
+				+ responseFormat + ", streamOptions=" + streamOptions + ", seed=" + seed + ", stop=" + stop
+				+ ", temperature=" + temperature + ", topP=" + topP + ", tools=" + tools + ", toolChoice=" + toolChoice
+				+ ", user='" + user + '\'' + ", parallelToolCalls=" + parallelToolCalls + ", store=" + store
+				+ ", metadata=" + metadata + ", reasoningEffort='" + reasoningEffort + '\'' + ", verbosity='"
+				+ verbosity + '\'' + ", serviceTier='" + serviceTier + '\'' + ", toolCallbacks=" + toolCallbacks
+				+ ", toolNames=" + toolNames + ", internalToolExecutionEnabled=" + internalToolExecutionEnabled
+				+ ", httpHeaders=" + httpHeaders + ", toolContext=" + toolContext + '}';
 	}
 
 	public static final class Builder {
@@ -449,8 +442,6 @@ public Builder from(OpenAiOfficialChatOptions fromOptions) {
 			this.options.setMaxTokens(fromOptions.getMaxTokens());
 			this.options.setMaxCompletionTokens(fromOptions.getMaxCompletionTokens());
 			this.options.setN(fromOptions.getN());
-			this.options.setOutputModalities(fromOptions.getOutputModalities() != null
-					? new ArrayList<>(fromOptions.getOutputModalities()) : null);
 			this.options.setOutputAudio(fromOptions.getOutputAudio());
 			this.options.setPresencePenalty(fromOptions.getPresencePenalty());
 			this.options.setResponseFormat(fromOptions.getResponseFormat());
@@ -505,9 +496,6 @@ public Builder merge(OpenAiOfficialChatOptions from) {
 			if (from.getN() != null) {
 				this.options.setN(from.getN());
 			}
-			if (from.getOutputModalities() != null) {
-				this.options.setOutputModalities(new ArrayList<>(from.getOutputModalities()));
-			}
 			if (from.getOutputAudio() != null) {
 				this.options.setOutputAudio(from.getOutputAudio());
 			}
@@ -636,11 +624,6 @@ public Builder N(Integer n) {
 			return this;
 		}
 
-		public Builder outputModalities(List<String> modalities) {
-			this.options.setOutputModalities(modalities);
-			return this;
-		}
-
 		public Builder outputAudio(ChatCompletionAudioParam audio) {
 			this.options.setOutputAudio(audio);
 			return this;

models/spring-ai-openai-official/src/main/java/org/springframework/ai/openaiofficial/OpenAiOfficialChatOptions.java

@@ -19,7 +19,9 @@
 import com.openai.azure.AzureOpenAIServiceVersion;
 import com.openai.azure.credential.AzureApiKeyCredential;
 import com.openai.client.OpenAIClient;
+import com.openai.client.OpenAIClientAsync;
 import com.openai.client.okhttp.OpenAIOkHttpClient;
+import com.openai.client.okhttp.OpenAIOkHttpClientAsync;
 import com.openai.credential.Credential;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -64,32 +66,64 @@ public static OpenAIClient setupSyncClient(String baseUrl, String apiKey, Creden
 			boolean isAzure, boolean isGitHubModels, String modelName, Duration timeout, Integer maxRetries,
 			Proxy proxy, Map<String, String> customHeaders) {
 
-		if (apiKey == null && credential == null) {
-			var openAiKey = System.getenv("OPENAI_API_KEY");
-			if (openAiKey != null) {
-				apiKey = openAiKey;
-				logger.debug("OpenAI API Key detected from environment variable OPENAI_API_KEY.");
-			}
-			var azureOpenAiKey = System.getenv("AZURE_OPENAI_KEY");
-			if (azureOpenAiKey != null) {
-				apiKey = azureOpenAiKey;
-				logger.debug("Azure OpenAI Key detected from environment variable AZURE_OPENAI_KEY.");
-			}
+		baseUrl = detectBaseUrlFromEnv(baseUrl);
+		var modelHost = detectModelHost(isAzure, isGitHubModels, baseUrl, azureDeploymentName,
+				azureOpenAiServiceVersion);
+		if (timeout == null) {
+			timeout = DEFAULT_DURATION;
 		}
-		if (baseUrl == null) {
-			var openAiBaseUrl = System.getenv("OPENAI_BASE_URL");
-			if (openAiBaseUrl != null) {
-				baseUrl = openAiBaseUrl;
-				logger.debug("OpenAI Base URL detected from environment variable OPENAI_BASE_URL.");
-			}
-			var azureOpenAiBaseUrl = System.getenv("AZURE_OPENAI_BASE_URL");
-			if (azureOpenAiBaseUrl != null) {
-				baseUrl = azureOpenAiBaseUrl;
-				logger.debug("Azure OpenAI Base URL detected from environment variable AZURE_OPENAI_BASE_URL.");
-			}
+		if (maxRetries == null) {
+			maxRetries = DEFAULT_MAX_RETRIES;
+		}
+
+		OpenAIOkHttpClient.Builder builder = OpenAIOkHttpClient.builder();
+		builder
+			.baseUrl(calculateBaseUrl(baseUrl, modelHost, modelName, azureDeploymentName, azureOpenAiServiceVersion));
+
+		Credential calculatedCredential = calculateCredential(modelHost, apiKey, credential);
+		String calculatedApiKey = calculateApiKey(modelHost, apiKey);
+		if (calculatedCredential == null && calculatedApiKey == null) {
+			throw new IllegalArgumentException("Either apiKey or credential must be set to authenticate");
+		}
+		else if (calculatedCredential != null) {
+			builder.credential(calculatedCredential);
+		}
+		else {
+			builder.apiKey(calculatedApiKey);
+		}
+		builder.organization(organizationId);
+
+		if (azureOpenAiServiceVersion != null) {
+			builder.azureServiceVersion(azureOpenAiServiceVersion);
 		}
 
-		ModelHost modelHost = detectModelHost(isAzure, isGitHubModels, baseUrl, azureDeploymentName,
+		if (proxy != null) {
+			builder.proxy(proxy);
+		}
+
+		builder.putHeader("User-Agent", DEFAULT_USER_AGENT);
+		if (customHeaders != null) {
+			builder.putAllHeaders(customHeaders.entrySet()
+				.stream()
+				.collect(Collectors.toMap(Map.Entry::getKey, entry -> Collections.singletonList(entry.getValue()))));
+		}
+
+		builder.timeout(timeout);
+		builder.maxRetries(maxRetries);
+		return builder.build();
+	}
+
+	/**
+	 * The asynchronous client setup is the same as the synchronous one in the OpenAI Java
+	 * SDK, but uses a different client implementation.
+	 */
+	public static OpenAIClientAsync setupAsyncClient(String baseUrl, String apiKey, Credential credential,
+			String azureDeploymentName, AzureOpenAIServiceVersion azureOpenAiServiceVersion, String organizationId,
+			boolean isAzure, boolean isGitHubModels, String modelName, Duration timeout, Integer maxRetries,
+			Proxy proxy, Map<String, String> customHeaders) {
+
+		baseUrl = detectBaseUrlFromEnv(baseUrl);
+		var modelHost = detectModelHost(isAzure, isGitHubModels, baseUrl, azureDeploymentName,
 				azureOpenAiServiceVersion);
 		if (timeout == null) {
 			timeout = DEFAULT_DURATION;
@@ -98,7 +132,7 @@ public static OpenAIClient setupSyncClient(String baseUrl, String apiKey, Creden
 			maxRetries = DEFAULT_MAX_RETRIES;
 		}
 
-		OpenAIOkHttpClient.Builder builder = OpenAIOkHttpClient.builder();
+		OpenAIOkHttpClientAsync.Builder builder = OpenAIOkHttpClientAsync.builder();
 		builder
 			.baseUrl(calculateBaseUrl(baseUrl, modelHost, modelName, azureDeploymentName, azureOpenAiServiceVersion));
 
@@ -135,8 +169,25 @@ else if (calculatedCredential != null) {
 		return builder.build();
 	}
 
+	static String detectBaseUrlFromEnv(String baseUrl) {
+		if (baseUrl == null) {
+			var openAiBaseUrl = System.getenv("OPENAI_BASE_URL");
+			if (openAiBaseUrl != null) {
+				baseUrl = openAiBaseUrl;
+				logger.debug("OpenAI Base URL detected from environment variable OPENAI_BASE_URL.");
+			}
+			var azureOpenAiBaseUrl = System.getenv("AZURE_OPENAI_BASE_URL");
+			if (azureOpenAiBaseUrl != null) {
+				baseUrl = azureOpenAiBaseUrl;
+				logger.debug("Azure OpenAI Base URL detected from environment variable AZURE_OPENAI_BASE_URL.");
+			}
+		}
+		return baseUrl;
+	}
+
 	static ModelHost detectModelHost(boolean isAzure, boolean isGitHubModels, String baseUrl,
 			String azureDeploymentName, AzureOpenAIServiceVersion azureOpenAIServiceVersion) {
+
 		if (isAzure) {
 			return ModelHost.AZURE_OPENAI; // Forced by the user
 		}
@@ -159,8 +210,9 @@ else if (baseUrl.startsWith(GITHUB_MODELS_URL)) {
 		return ModelHost.OPENAI;
 	}
 
-	static String calculateBaseUrl(final String baseUrl, ModelHost modelHost, String modelName,
-			String azureDeploymentName, AzureOpenAIServiceVersion azureOpenAiServiceVersion) {
+	static String calculateBaseUrl(String baseUrl, ModelHost modelHost, String modelName, String azureDeploymentName,
+			AzureOpenAIServiceVersion azureOpenAiServiceVersion) {
+
 		if (modelHost == ModelHost.OPENAI) {
 			if (baseUrl == null || baseUrl.isBlank()) {
 				return OPENAI_URL;
@@ -211,6 +263,18 @@ else if (modelHost == ModelHost.AZURE_OPENAI) {
 	}
 
 	static String calculateApiKey(ModelHost modelHost, String apiKey) {
+		if (apiKey == null) {
+			var openAiKey = System.getenv("OPENAI_API_KEY");
+			if (openAiKey != null) {
+				apiKey = openAiKey;
+				logger.debug("OpenAI API Key detected from environment variable OPENAI_API_KEY.");
+			}
+			var azureOpenAiKey = System.getenv("AZURE_OPENAI_KEY");
+			if (azureOpenAiKey != null) {
+				apiKey = azureOpenAiKey;
+				logger.debug("Azure OpenAI Key detected from environment variable AZURE_OPENAI_KEY.");
+			}
+		}
 		if (modelHost != ModelHost.AZURE_OPENAI && apiKey != null) {
 			return apiKey;
 		}

models/spring-ai-openai-official/src/main/java/org/springframework/ai/openaiofficial/setup/OpenAiOfficialSetup.java

@@ -37,4 +37,9 @@ public OpenAiOfficialImageModel openAiImageModel() {
 		return new OpenAiOfficialImageModel();
 	}
 
+	@Bean
+	public OpenAiOfficialChatModel openAiChatModel() {
+		return new OpenAiOfficialChatModel();
+	}
+
 }