Skip to content

Streamline dependencies and improve API consistency #1550

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

Streamline dependencies and improve API consistency #1550

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e60509
Streamline dependencies and improve API consistency
tzolov Oct 15, 2024
12d3382
Adjust import order
tzolov Oct 16, 2024
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
6 changes: 0 additions & 6 deletions models/spring-ai-bedrock/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,6 @@
<version>${project.parent.version}</version>
</dependency>

<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
<version>${spring-framework.version}</version>
</dependency>

<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webflux</artifactId>
Expand Down
33 changes: 21 additions & 12 deletions models/spring-ai-minimax/src/main/java/org/springframework/ai/minimax/api/MiniMaxApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,30 +15,34 @@
*/
package org.springframework.ai.minimax.api;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonValue;
import java.util.List;
import java.util.Map;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.function.Consumer;
import java.util.function.Predicate;

import org.springframework.ai.model.ChatModelDescription;
import org.springframework.ai.model.ModelOptionsUtils;
import org.springframework.ai.retry.RetryUtils;
import org.springframework.ai.util.api.ApiUtils;
import org.springframework.boot.context.properties.bind.ConstructorBinding;
import org.springframework.core.ParameterizedTypeReference;
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.util.Assert;
import org.springframework.util.CollectionUtils;
import org.springframework.web.client.ResponseErrorHandler;
import org.springframework.web.client.RestClient;
import org.springframework.web.reactive.function.client.WebClient;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonValue;

import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;

import java.util.List;
import java.util.Map;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.function.Predicate;

// @formatter:off
/**
* Single class implementation of the <a href="https://www.minimaxi.com/document/guides/chat-model/V2">MiniMax Chat Completion API</a> and
Expand Down Expand Up @@ -98,15 +102,20 @@ public MiniMaxApi(String baseUrl, String miniMaxToken, RestClient.Builder restCl
*/
public MiniMaxApi(String baseUrl, String miniMaxToken, RestClient.Builder restClientBuilder, ResponseErrorHandler responseErrorHandler) {

Consumer<HttpHeaders> authHeaders = (headers) -> {
headers.setBearerAuth(miniMaxToken);
headers.setContentType(MediaType.APPLICATION_JSON);
};

this.restClient = restClientBuilder
.baseUrl(baseUrl)
.defaultHeaders(ApiUtils.getJsonContentHeaders(miniMaxToken))
.defaultHeaders(authHeaders)
.defaultStatusHandler(responseErrorHandler)
.build();

this.webClient = WebClient.builder()
.baseUrl(baseUrl)
.defaultHeaders(ApiUtils.getJsonContentHeaders(miniMaxToken))
.defaultHeaders(authHeaders)
.build();
}

Expand Down
6 changes: 0 additions & 6 deletions models/spring-ai-oci-genai/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,6 @@
<version>${oci-sdk-version}</version>
</dependency>

<!-- NOTE: Required only by the @ConstructorBinding. -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot</artifactId>
</dependency>

<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context-support</artifactId>
Expand Down
16 changes: 3 additions & 13 deletions models/spring-ai-ollama/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,26 +22,16 @@

<dependencies>

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot</artifactId>
</dependency>

<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-core</artifactId>
<version>${project.parent.version}</version>
</dependency>

<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-retry</artifactId>
<version>${project.parent.version}</version>
</dependency>

<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webflux</artifactId>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-retry</artifactId>
<version>${project.parent.version}</version>
</dependency>

<dependency>
Expand Down
2 changes: 1 addition & 1 deletion models/spring-ai-openai/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
</scm>

<dependencies>

<!-- production dependencies -->
<dependency>
<groupId>org.springframework.ai</groupId>
Expand Down
19 changes: 9 additions & 10 deletions models/spring-ai-openai/src/main/java/org/springframework/ai/openai/api/OpenAiApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
import java.util.List;
import java.util.Map;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.function.Consumer;
import java.util.function.Predicate;

import org.springframework.ai.model.ChatModelDescription;
Expand All @@ -26,6 +27,7 @@
import org.springframework.ai.retry.RetryUtils;
import org.springframework.boot.context.properties.bind.ConstructorBinding;
import org.springframework.core.ParameterizedTypeReference;
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.util.Assert;
Expand Down Expand Up @@ -154,22 +156,19 @@ public OpenAiApi(String baseUrl, String apiKey, MultiValueMap<String, String> he
this.completionsPath = completionsPath;
this.embeddingsPath = embeddingsPath;
// @formatter:off
Consumer<HttpHeaders> finalHeaders = h -> {
h.setBearerAuth(apiKey);
h.setContentType(MediaType.APPLICATION_JSON);
h.addAll(headers);
};
this.restClient = restClientBuilder.baseUrl(baseUrl)
.defaultHeaders(h -> {
h.setBearerAuth(apiKey);
h.setContentType(MediaType.APPLICATION_JSON);
h.addAll(headers);
})
.defaultHeaders(finalHeaders)
.defaultStatusHandler(responseErrorHandler)
.build();

this.webClient = webClientBuilder
.baseUrl(baseUrl)
.defaultHeaders(h -> {
h.setBearerAuth(apiKey);
h.setContentType(MediaType.APPLICATION_JSON);
h.addAll(headers);
})
.defaultHeaders(finalHeaders)
.build();// @formatter:on
}

Expand Down
53 changes: 25 additions & 28 deletions models/spring-ai-openai/src/main/java/org/springframework/ai/openai/api/OpenAiAudioApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,10 @@

import java.util.List;
import java.util.Map;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.function.Consumer;

import org.springframework.ai.openai.api.common.OpenAiApiConstants;
import org.springframework.ai.retry.RetryUtils;
import org.springframework.ai.util.api.ApiUtils;
import org.springframework.core.io.ByteArrayResource;
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
Expand All @@ -36,6 +32,11 @@
import org.springframework.web.client.ResponseErrorHandler;
import org.springframework.web.client.RestClient;
import org.springframework.web.reactive.function.client.WebClient;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.annotation.JsonProperty;

import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;

Expand Down Expand Up @@ -71,13 +72,14 @@ public OpenAiAudioApi(String openAiToken) {
public OpenAiAudioApi(String baseUrl, String openAiToken, RestClient.Builder restClientBuilder,
ResponseErrorHandler responseErrorHandler) {

this.restClient = restClientBuilder.baseUrl(baseUrl).defaultHeaders(headers -> {
headers.setBearerAuth(openAiToken);
}).defaultStatusHandler(responseErrorHandler).build();
Consumer<HttpHeaders> authHeaders = h -> h.setBearerAuth(openAiToken);

this.webClient = WebClient.builder().baseUrl(baseUrl).defaultHeaders(headers -> {
headers.setBearerAuth(openAiToken);
}).defaultHeaders(ApiUtils.getJsonContentHeaders(openAiToken)).build();
this.restClient = restClientBuilder.baseUrl(baseUrl)
.defaultHeaders(authHeaders)
.defaultStatusHandler(responseErrorHandler)
.build();

this.webClient = WebClient.builder().baseUrl(baseUrl).defaultHeaders(authHeaders).build();
}

/**
Expand Down Expand Up @@ -108,23 +110,18 @@ public OpenAiAudioApi(String baseUrl, String apiKey, MultiValueMap<String, Strin
RestClient.Builder restClientBuilder, WebClient.Builder webClientBuilder,
ResponseErrorHandler responseErrorHandler) {

// @formatter:off
this.restClient = restClientBuilder
.baseUrl(baseUrl)
.defaultHeaders(h -> {
h.setBearerAuth(apiKey);
h.addAll(headers);
})
.defaultStatusHandler(responseErrorHandler).build();

this.webClient = webClientBuilder
.baseUrl(baseUrl)
.defaultHeaders(h -> {
h.setBearerAuth(apiKey);
h.addAll(headers);
})
.defaultHeaders(ApiUtils.getJsonContentHeaders(apiKey)).build();
// @formatter:on
Consumer<HttpHeaders> authHeaders = h -> {
h.setBearerAuth(apiKey);
h.addAll(headers);
// h.setContentType(MediaType.APPLICATION_JSON);
};

this.restClient = restClientBuilder.baseUrl(baseUrl)
.defaultHeaders(authHeaders)
.defaultStatusHandler(responseErrorHandler)
.build();

this.webClient = webClientBuilder.baseUrl(baseUrl).defaultHeaders(authHeaders).build();
}

/**
Expand Down
25 changes: 8 additions & 17 deletions ...spring-ai-openai/src/main/java/org/springframework/ai/openai/api/OpenAiModerationApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,17 @@
*/
package org.springframework.ai.openai.api;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.ai.retry.RetryUtils;
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.http.client.ClientHttpResponse;
import org.springframework.util.Assert;
import org.springframework.web.client.ResponseErrorHandler;
import org.springframework.web.client.RestClient;

import java.io.IOException;
import java.util.function.Consumer;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;

/**
* OpenAI Moderation API.
Expand Down Expand Up @@ -61,15 +57,10 @@ public OpenAiModerationApi(String baseUrl, String openAiToken, RestClient.Builde

this.objectMapper = new ObjectMapper().configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);

Consumer<HttpHeaders> jsonContentHeaders = headers -> {
headers.setBearerAuth(openAiToken);
headers.setContentType(MediaType.APPLICATION_JSON);
};

this.restClient = restClientBuilder.baseUrl(baseUrl)
.defaultHeaders(jsonContentHeaders)
.defaultStatusHandler(responseErrorHandler)
.build();
this.restClient = restClientBuilder.baseUrl(baseUrl).defaultHeaders(h -> {
h.setBearerAuth(openAiToken);
h.setContentType(MediaType.APPLICATION_JSON);
}).defaultStatusHandler(responseErrorHandler).build();
}

// @formatter:off
Expand Down
18 changes: 10 additions & 8 deletions ...i/audio/transcription/OpenAiTranscriptionModelWithTranscriptionResponseMetadataTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,14 @@
*/
package org.springframework.ai.openai.audio.transcription;

import static org.assertj.core.api.Assertions.assertThat;
import static org.springframework.test.web.client.match.MockRestRequestMatchers.header;
import static org.springframework.test.web.client.match.MockRestRequestMatchers.method;
import static org.springframework.test.web.client.match.MockRestRequestMatchers.requestTo;
import static org.springframework.test.web.client.response.MockRestResponseCreators.withSuccess;

import java.time.Duration;

import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;
import org.springframework.ai.audio.transcription.AudioTranscriptionMetadata;
Expand All @@ -38,12 +46,6 @@
import org.springframework.test.web.client.MockRestServiceServer;
import org.springframework.web.client.RestClient;

import java.time.Duration;

import static org.assertj.core.api.Assertions.assertThat;
import static org.springframework.test.web.client.match.MockRestRequestMatchers.*;
import static org.springframework.test.web.client.response.MockRestResponseCreators.withSuccess;

/**
* @author Michael Lavelle
*/
Expand All @@ -53,7 +55,7 @@ public class OpenAiTranscriptionModelWithTranscriptionResponseMetadataTests {
private static String TEST_API_KEY = "sk-1234567890";

@Autowired
private OpenAiAudioTranscriptionModel openAiTranscriptionClient;
private OpenAiAudioTranscriptionModel openAiTranscriptionModel;

@Autowired
private MockRestServiceServer server;
Expand All @@ -72,7 +74,7 @@ void aiResponseContainsAiMetadata() {

AudioTranscriptionPrompt transcriptionRequest = new AudioTranscriptionPrompt(audioFile);

AudioTranscriptionResponse response = this.openAiTranscriptionClient.call(transcriptionRequest);
AudioTranscriptionResponse response = this.openAiTranscriptionModel.call(transcriptionRequest);

assertThat(response).isNotNull();

Expand Down
7 changes: 0 additions & 7 deletions models/spring-ai-vertex-ai-embedding/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,6 @@
<version>${project.parent.version}</version>
</dependency>

<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
<version>${spring-framework.version}</version>
</dependency>


<!-- Spring Framework -->
<dependency>
<groupId>org.springframework</groupId>
Expand Down
6 changes: 0 additions & 6 deletions models/spring-ai-vertex-ai-gemini/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,6 @@
<version>${project.parent.version}</version>
</dependency>

<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
<version>${spring-framework.version}</version>
</dependency>


<!-- Spring Framework -->
<dependency>
Expand Down
3 changes: 1 addition & 2 deletions models/spring-ai-vertex-ai-palm2/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,7 @@

<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
<version>${spring-framework.version}</version>
<artifactId>spring-web</artifactId>
</dependency>


Expand Down
Loading