Skip to content

Add support for multiple named OpenAI chat models in Spring Boot starter #162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ghtjr410 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add support for multiple named OpenAI chat models in Spring Boot starter #162

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
295 changes: 295 additions & 0 deletions ...j-open-ai-spring-boot-starter/src/main/java/dev/langchain4j/openai/spring/AutoConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,37 @@
import dev.langchain4j.model.openai.*;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.BeanDefinitionRegistryPostProcessor;
import org.springframework.beans.factory.support.GenericBeanDefinition;
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.autoconfigure.web.client.RestClientAutoConfiguration;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.boot.context.properties.bind.Binder;
import org.springframework.context.annotation.Bean;
import org.springframework.core.env.Environment;
import org.springframework.core.task.AsyncTaskExecutor;
import org.springframework.core.task.support.ContextPropagatingTaskDecorator;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
import org.springframework.web.client.RestClient;

import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;

import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.EnumerablePropertySource;
import org.springframework.core.env.PropertySource;

import static dev.langchain4j.openai.spring.Properties.PREFIX;

@AutoConfiguration(after = RestClientAutoConfiguration.class)
Expand Down Expand Up @@ -378,4 +396,281 @@ HttpClientBuilder openAiImageModelHttpClientBuilder(ObjectProvider<RestClient.Bu
// executor is not needed for no-streaming OpenAiImageModel
.createDefaultStreamingRequestExecutor(false);
}

@Bean
static BeanDefinitionRegistryPostProcessor namedOpenAiChatModelBeanRegistrar(Environment environment) {
return new NamedModelBeanRegistrar(environment);
}

static class NamedModelBeanRegistrar implements BeanDefinitionRegistryPostProcessor, ApplicationContextAware {

private static final String CHAT_MODEL_PREFIX = PREFIX + ".chat-model";
private static final String STREAMING_CHAT_MODEL_PREFIX = PREFIX + ".streaming-chat-model";

private static final Set<String> KNOWN_PROPERTIES = Set.of(
"base-url", "api-key", "organization-id", "project-id", "model-name",
Copy link

@Tcharl Tcharl Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Strong typing and specific class would have been better IMHO

"temperature", "top-p", "stop", "max-tokens", "max-completion-tokens",
"presence-penalty", "frequency-penalty", "logit-bias", "response-format",
"supported-capabilities", "strict-json-schema", "seed", "user",
"strict-tools", "parallel-tool-calls", "store", "metadata", "service-tier",
"reasoning-effort", "return-thinking", "timeout", "max-retries",
"log-requests", "log-responses", "custom-headers", "custom-query-params",
"custom-parameters"
);

private final Environment environment;
private ApplicationContext applicationContext;

NamedModelBeanRegistrar(Environment environment) {
this.environment = environment;
}

@Override
public void setApplicationContext(ApplicationContext applicationContext) {
this.applicationContext = applicationContext;
}

@Override
public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) {
registerNamedChatModels(registry, CHAT_MODEL_PREFIX, "openAiChatModel", false);
registerNamedChatModels(registry, STREAMING_CHAT_MODEL_PREFIX, "openAiStreamingChatModel", true);
}

private void registerNamedChatModels(BeanDefinitionRegistry registry, String prefix,
String beanNamePrefix, boolean streaming) {
ChatModelProperties globalProps = Binder.get(environment)
.bind(prefix, ChatModelProperties.class)
.orElse(null);

Set<String> namedModelKeys = findNamedModelKeys(prefix);

for (String modelName : namedModelKeys) {
String namedPrefix = prefix + "." + modelName;
ChatModelProperties namedProps = Binder.get(environment)
.bind(namedPrefix, ChatModelProperties.class)
.orElse(null);

if (namedProps == null) {
continue;
}

ChatModelProperties mergedProps = mergeWithGlobal(globalProps, namedProps);

if (mergedProps.apiKey() == null) {
continue;
}

String beanName = beanNamePrefix + toPascalCase(modelName);

GenericBeanDefinition beanDefinition = new GenericBeanDefinition();
beanDefinition.setScope(BeanDefinition.SCOPE_SINGLETON);

if (streaming) {
beanDefinition.setBeanClass(OpenAiStreamingChatModel.class);
beanDefinition.setInstanceSupplier(() -> {
HttpClientBuilder httpClientBuilder = createHttpClientBuilder(true);
List<ChatModelListener> listeners = getListeners();
return createStreamingChatModel(mergedProps, httpClientBuilder, listeners);
});
} else {
beanDefinition.setBeanClass(OpenAiChatModel.class);
beanDefinition.setInstanceSupplier(() -> {
HttpClientBuilder httpClientBuilder = createHttpClientBuilder(false);
List<ChatModelListener> listeners = getListeners();
return createChatModel(mergedProps, httpClientBuilder, listeners);
});
}

registry.registerBeanDefinition(beanName, beanDefinition);
}
}

private Set<String> findNamedModelKeys(String prefix) {
Set<String> namedKeys = new HashSet<>();
String searchPrefix = prefix + ".";

if (environment instanceof ConfigurableEnvironment configurableEnv) {
for (PropertySource<?> propertySource : configurableEnv.getPropertySources()) {
if (propertySource instanceof EnumerablePropertySource<?> enumerable) {
for (String propertyName : enumerable.getPropertyNames()) {
if (propertyName.startsWith(searchPrefix)) {
String remainder = propertyName.substring(searchPrefix.length());
int dotIndex = remainder.indexOf('.');
String firstSegment = dotIndex > 0 ? remainder.substring(0, dotIndex) : remainder;

if (!KNOWN_PROPERTIES.contains(firstSegment)) {
namedKeys.add(firstSegment);
}
}
}
}
}
}

return namedKeys;
}

private HttpClientBuilder createHttpClientBuilder(boolean streaming) {
ObjectProvider<RestClient.Builder> restClientBuilderProvider =
applicationContext.getBeanProvider(RestClient.Builder.class);
RestClient.Builder restClientBuilder = restClientBuilderProvider.getIfAvailable(RestClient::builder);

if (streaming) {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
executor.setQueueCapacity(0);
executor.setThreadNamePrefix(TASK_EXECUTOR_THREAD_NAME_PREFIX);
executor.initialize();
return SpringRestClient.builder()
.restClientBuilder(restClientBuilder)
.streamingRequestExecutor(executor);
} else {
return SpringRestClient.builder()
.restClientBuilder(restClientBuilder)
.createDefaultStreamingRequestExecutor(false);
}
}

private List<ChatModelListener> getListeners() {
return applicationContext.getBeanProvider(ChatModelListener.class)
.orderedStream()
.toList();
}

private ChatModelProperties mergeWithGlobal(ChatModelProperties global, ChatModelProperties named) {
if (global == null) {
return named;
}
return new ChatModelProperties(
named.baseUrl() != null ? named.baseUrl() : global.baseUrl(),
named.apiKey() != null ? named.apiKey() : global.apiKey(),
named.organizationId() != null ? named.organizationId() : global.organizationId(),
named.projectId() != null ? named.projectId() : global.projectId(),
named.modelName() != null ? named.modelName() : global.modelName(),
named.temperature() != null ? named.temperature() : global.temperature(),
named.topP() != null ? named.topP() : global.topP(),
named.stop() != null ? named.stop() : global.stop(),
named.maxTokens() != null ? named.maxTokens() : global.maxTokens(),
named.maxCompletionTokens() != null ? named.maxCompletionTokens() : global.maxCompletionTokens(),
named.presencePenalty() != null ? named.presencePenalty() : global.presencePenalty(),
named.frequencyPenalty() != null ? named.frequencyPenalty() : global.frequencyPenalty(),
named.logitBias() != null ? named.logitBias() : global.logitBias(),
named.responseFormat() != null ? named.responseFormat() : global.responseFormat(),
named.supportedCapabilities() != null ? named.supportedCapabilities() : global.supportedCapabilities(),
named.strictJsonSchema() != null ? named.strictJsonSchema() : global.strictJsonSchema(),
named.seed() != null ? named.seed() : global.seed(),
named.user() != null ? named.user() : global.user(),
named.strictTools() != null ? named.strictTools() : global.strictTools(),
named.parallelToolCalls() != null ? named.parallelToolCalls() : global.parallelToolCalls(),
named.store() != null ? named.store() : global.store(),
named.metadata() != null ? named.metadata() : global.metadata(),
named.serviceTier() != null ? named.serviceTier() : global.serviceTier(),
named.reasoningEffort() != null ? named.reasoningEffort() : global.reasoningEffort(),
named.returnThinking() != null ? named.returnThinking() : global.returnThinking(),
named.timeout() != null ? named.timeout() : global.timeout(),
named.maxRetries() != null ? named.maxRetries() : global.maxRetries(),
named.logRequests() != null ? named.logRequests() : global.logRequests(),
named.logResponses() != null ? named.logResponses() : global.logResponses(),
named.customHeaders() != null ? named.customHeaders() : global.customHeaders(),
named.customQueryParams() != null ? named.customQueryParams() : global.customQueryParams(),
named.customParameters() != null ? named.customParameters() : global.customParameters()
);
}

private OpenAiChatModel createChatModel(ChatModelProperties props,
HttpClientBuilder httpClientBuilder,
List<ChatModelListener> listeners) {
return OpenAiChatModel.builder()
.httpClientBuilder(httpClientBuilder)
.baseUrl(props.baseUrl())
.apiKey(props.apiKey())
.organizationId(props.organizationId())
.projectId(props.projectId())
.modelName(props.modelName())
.temperature(props.temperature())
.topP(props.topP())
.stop(props.stop())
.maxTokens(props.maxTokens())
.maxCompletionTokens(props.maxCompletionTokens())
.presencePenalty(props.presencePenalty())
.frequencyPenalty(props.frequencyPenalty())
.logitBias(props.logitBias())
.responseFormat(props.responseFormat())
.supportedCapabilities(props.supportedCapabilities())
.strictJsonSchema(props.strictJsonSchema())
.seed(props.seed())
.user(props.user())
.strictTools(props.strictTools())
.parallelToolCalls(props.parallelToolCalls())
.store(props.store())
.metadata(props.metadata())
.serviceTier(props.serviceTier())
.defaultRequestParameters(OpenAiChatRequestParameters.builder()
.reasoningEffort(props.reasoningEffort())
.customParameters(props.customParameters())
.build())
.returnThinking(props.returnThinking())
.timeout(props.timeout())
.maxRetries(props.maxRetries())
.logRequests(props.logRequests())
.logResponses(props.logResponses())
.customHeaders(props.customHeaders())
.customQueryParams(props.customQueryParams())
.listeners(listeners)
.build();
}

private OpenAiStreamingChatModel createStreamingChatModel(ChatModelProperties props,
HttpClientBuilder httpClientBuilder,
List<ChatModelListener> listeners) {
return OpenAiStreamingChatModel.builder()
.httpClientBuilder(httpClientBuilder)
.baseUrl(props.baseUrl())
.apiKey(props.apiKey())
.organizationId(props.organizationId())
.projectId(props.projectId())
.modelName(props.modelName())
.temperature(props.temperature())
.topP(props.topP())
.stop(props.stop())
.maxTokens(props.maxTokens())
.maxCompletionTokens(props.maxCompletionTokens())
.presencePenalty(props.presencePenalty())
.frequencyPenalty(props.frequencyPenalty())
.logitBias(props.logitBias())
.responseFormat(props.responseFormat())
.seed(props.seed())
.user(props.user())
.strictTools(props.strictTools())
.parallelToolCalls(props.parallelToolCalls())
.store(props.store())
.metadata(props.metadata())
.serviceTier(props.serviceTier())
.defaultRequestParameters(OpenAiChatRequestParameters.builder()
.reasoningEffort(props.reasoningEffort())
.customParameters(props.customParameters())
.build())
.returnThinking(props.returnThinking())
.timeout(props.timeout())
.logRequests(props.logRequests())
.logResponses(props.logResponses())
.customHeaders(props.customHeaders())
.customQueryParams(props.customQueryParams())
.listeners(listeners)
.build();
}

private String toPascalCase(String input) {
if (input == null || input.isEmpty()) {
return input;
}
return Arrays.stream(input.split("[-_]"))
.map(segment -> {
if (segment.isEmpty()) {
return "";
}
return Character.toUpperCase(segment.charAt(0)) + segment.substring(1).toLowerCase();
})
.collect(Collectors.joining());
}
}
}
Loading