Skip to content

Enable base URL to be configurable for OpenAI #6

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

Closed
wants to merge 2 commits into from
Closed

Enable base URL to be configurable for OpenAI #6

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
54234b8
Enable base URL to be configurable for OpenAI
habuma Aug 31, 2023
3835e1e
Add TextLoader implementation of Loader
habuma Sep 7, 2023
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions spring-ai-spring-boot-autoconfigure/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,12 @@
<optional>true</optional>
</dependency>

<dependency>
<groupId>com.squareup.retrofit2</groupId>
<artifactId>converter-jackson</artifactId>
<version>2.9.0</version>
</dependency>

<!-- test dependencies -->
<dependency>
<groupId>org.springframework.boot</groupId>
Expand Down
21 changes: 20 additions & 1 deletion ...re/src/main/java/org/springframework/ai/autoconfigure/openai/OpenAiAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,15 @@

package org.springframework.ai.autoconfigure.openai;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.theokanning.openai.OpenAiApi;
import com.theokanning.openai.service.OpenAiService;

import okhttp3.OkHttpClient;
import retrofit2.Retrofit;
import retrofit2.adapter.rxjava2.RxJava2CallAdapterFactory;
import retrofit2.converter.jackson.JacksonConverterFactory;

import org.springframework.ai.autoconfigure.NativeHints;
import org.springframework.ai.embedding.EmbeddingClient;
import org.springframework.ai.openai.embedding.OpenAiEmbeddingClient;
Expand Down Expand Up @@ -49,7 +56,19 @@ public OpenAiService theoOpenAiService(OpenAiProperties openAiProperties) {
throw new IllegalArgumentException(
Copy link

@gm2552 gm2552 Aug 31, 2023

Choose a reason for hiding this comment

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

Would it make sense to only force an API key if the URL was anything other than the default base URL (maybe that's too complex or nondeterministic)?
Copy link
Member

@markpollack markpollack Sep 7, 2023

Choose a reason for hiding this comment

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

I've seen two cases of model hosting projects that expose the OpenAI API locally and do not require a key. I think we can remove the requirement for a key when the base url is not https://api.openai.com and see how it goes.
"You must provide an API key with the property name " + CONFIG_PREFIX + ".api-key");
}
return new OpenAiService(openAiProperties.getApiKey(), openAiProperties.getDuration());

ObjectMapper mapper = OpenAiService.defaultObjectMapper();
OkHttpClient client = OpenAiService.defaultClient(openAiProperties.getApiKey(), openAiProperties.getDuration());

Retrofit retrofit = new Retrofit.Builder().baseUrl(openAiProperties.getBaseUrl())
.client(client)
.addConverterFactory(JacksonConverterFactory.create(mapper))
.addCallAdapterFactory(RxJava2CallAdapterFactory.create())
.build();

OpenAiApi api = retrofit.create(OpenAiApi.class);

return new OpenAiService(api);
}

@Bean
Expand Down
10 changes: 10 additions & 0 deletions ...configure/src/main/java/org/springframework/ai/autoconfigure/openai/OpenAiProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ public class OpenAiProperties {

private String model = "gpt-3.5-turbo";

private String baseUrl = "https://api.openai.com";

public String getApiKey() {
return apiKey;
}
Expand Down Expand Up @@ -67,4 +69,12 @@ public void setDuration(Duration duration) {
this.duration = duration;
}

public String getBaseUrl() {
return baseUrl;
}

public void setBaseUrl(String baseUrl) {
this.baseUrl = baseUrl;
}

}