Skip to content

fix: skip OpenAiApi chat bean when no chat API key is configured #5763

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
anuragg-saxenaa wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: skip OpenAiApi chat bean when no chat API key is configured #5763

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
2 changes: 2 additions & 0 deletions ...n/java/org/springframework/ai/model/openai/autoconfigure/OpenAiChatAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ public class OpenAiChatAutoConfiguration {

@Bean
@ConditionalOnMissingBean
@ConditionalOnProperty(prefix = "spring.ai.openai", name = { "api-key", "chat.api-key" },
matchIfMissing = false)
public OpenAiApi openAiApi(OpenAiConnectionProperties commonProperties, OpenAiChatProperties chatProperties,
ObjectProvider<RestClient.Builder> restClientBuilderProvider,
ObjectProvider<WebClient.Builder> webClientBuilderProvider,
Expand Down
20 changes: 20 additions & 0 deletions ...java/org/springframework/ai/model/openai/autoconfigure/OpenAiModelConfigurationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -386,4 +386,24 @@ void openAiApiBean() {
});
}

@Test
void imageOnlyApiKeyDoesNotFailChatAutoConfiguration() {
// Regression test for https://github.com/spring-projects/spring-ai/issues/1818
// When only spring.ai.openai.image.api-key is set (no chat or common api-key),
// OpenAiChatAutoConfiguration must not throw an IllegalArgumentException.
// The OpenAiApi bean for chat should simply not be created.
new ApplicationContextRunner()
.withPropertyValues("spring.ai.openai.image.api-key=IMAGE_API_KEY",
"spring.ai.openai.base-url=TEST_BASE_URL")
.withConfiguration(AutoConfigurations.of(OpenAiChatAutoConfiguration.class,
OpenAiImageAutoConfiguration.class, RestClientAutoConfiguration.class,
SpringAiRetryAutoConfiguration.class, ToolCallingAutoConfiguration.class,
WebClientAutoConfiguration.class))
.run(context -> {
assertThat(context).hasNotFailed();
assertThat(context.getBeansOfType(OpenAiChatModel.class)).isEmpty();
assertThat(context.getBeansOfType(OpenAiImageModel.class)).isNotEmpty();
});
}

}