Skip to content

Commit 767a1cb

Browse files
KoreaNirsaKoreaNirsa
committed
Chore: apply code formatting
1 parent 134ed71 commit 767a1cb

File tree

5 files changed

+201
-195
lines changed

5 files changed

+201
-195
lines changed

‎spring-ai-rag/src/main/java/org/springframework/ai/rag/postretrieval/rerank/CohereApi.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
* @author KoreaNirsa
77
*/
88
public class CohereApi {
9+
910
private String apiKey;
1011

1112
public static Builder builder() {
@@ -17,6 +18,7 @@ public String getApiKey() {
1718
}
1819

1920
public static class Builder {
21+
2022
private final CohereApi instance = new CohereApi();
2123

2224
public Builder apiKey(String key) {
@@ -30,5 +32,7 @@ public CohereApi build() {
3032
}
3133
return instance;
3234
}
35+
3336
}
37+
3438
}

‎spring-ai-rag/src/main/java/org/springframework/ai/rag/postretrieval/rerank/CohereReranker.java

Lines changed: 83 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -14,106 +14,103 @@
1414
import org.springframework.web.reactive.function.client.WebClient;
1515

1616
/**
17-
* A Reranker implementation that integrates with Cohere's Rerank API.
18-
* This component reorders retrieved documents based on semantic relevance to the input query.
17+
* A Reranker implementation that integrates with Cohere's Rerank API. This component
18+
* reorders retrieved documents based on semantic relevance to the input query.
1919
*
2020
* @author KoreaNirsa
21-
* @see <a href="https://docs.cohere.com/reference/rerank">Cohere Rerank API Documentation</a>
21+
* @see <a href="https://docs.cohere.com/reference/rerank">Cohere Rerank API
22+
* Documentation</a>
2223
*/
2324
public class CohereReranker {
25+
2426
private static final String COHERE_RERANK_ENDPOINT = "https://api.cohere.ai/v1/rerank";
2527

2628
private static final Logger logger = LoggerFactory.getLogger(CohereReranker.class);
27-
29+
2830
private static final int MAX_DOCUMENTS = 1000;
2931

3032
private final WebClient webClient;
3133

3234
/**
3335
* Constructs a CohereReranker that communicates with the Cohere Rerank API.
3436
* Initializes the internal WebClient with the provided API key for authorization.
35-
*
36-
* @param cohereApi the API configuration object containing the required API key (must not be null)
37+
* @param cohereApi the API configuration object containing the required API key (must
38+
* not be null)
3739
* @throws IllegalArgumentException if cohereApi is null
3840
*/
39-
CohereReranker(CohereApi cohereApi) {
40-
if (cohereApi == null) {
41-
throw new IllegalArgumentException("CohereApi must not be null");
42-
}
43-
44-
this.webClient = WebClient.builder()
45-
.baseUrl(COHERE_RERANK_ENDPOINT)
46-
.defaultHeader(HttpHeaders.AUTHORIZATION, "Bearer " + cohereApi.getApiKey())
47-
.build();
48-
}
49-
50-
/**
51-
* Reranks a list of documents based on the provided query using the Cohere API.
52-
*
53-
* @param query The user input query.
54-
* @param documents The list of documents to rerank.
55-
* @param topN The number of top results to return (at most).
56-
* @return A reranked list of documents. If the API fails, returns the original list.
57-
*/
58-
public List<Document> rerank(String query, List<Document> documents, int topN) {
59-
if (topN < 1) {
60-
throw new IllegalArgumentException("topN must be ≥ 1. Provided: " + topN);
61-
}
62-
63-
if (documents == null || documents.isEmpty()) {
64-
logger.warn("Empty document list provided. Skipping rerank.");
65-
return Collections.emptyList();
66-
}
67-
68-
if (documents.size() > MAX_DOCUMENTS) {
69-
logger.warn("Cohere recommends ≤ {} documents per rerank request. Larger sizes may cause errors.", MAX_DOCUMENTS);
70-
return documents;
71-
}
72-
73-
int adjustedTopN = Math.min(topN, documents.size());
74-
75-
Map<String, Object> payload = Map.of(
76-
"query", query,
77-
"documents", documents.stream().map(Document::getText).toList(),
78-
"top_n", adjustedTopN
79-
);
80-
81-
// Call the API and process the result
82-
return sendRerankRequest(payload)
83-
.map(results -> results.stream()
84-
.sorted(Comparator.comparingDouble(RerankResponse.Result::getRelevanceScore).reversed())
85-
.map(r -> {
86-
Document original = documents.get(r.getIndex());
87-
Map<String, Object> metadata = new HashMap<>(original.getMetadata());
88-
metadata.put("score", String.format("%.4f", r.getRelevanceScore()));
89-
return new Document(original.getText(), metadata);
90-
})
91-
.toList())
92-
.orElseGet(() -> {
93-
logger.warn("Cohere response is null or invalid");
94-
return documents;
95-
});
96-
}
97-
98-
/**
99-
* Sends a rerank request to the Cohere API and returns the result list.
100-
*
101-
* @param payload The request body including query, documents, and top_n.
102-
* @return An Optional list of reranked results, or empty if failed.
103-
*/
104-
private Optional<List<RerankResponse.Result>> sendRerankRequest(Map<String, Object> payload) {
105-
try {
106-
RerankResponse response = webClient.post()
107-
.bodyValue(payload)
108-
.retrieve()
109-
.bodyToMono(RerankResponse.class)
110-
.block();
111-
112-
return Optional.ofNullable(response)
113-
.map(RerankResponse::getResults);
114-
} catch (Exception e) {
115-
logger.error("Cohere rerank failed, fallback to original order: {}", e.getMessage(), e);
116-
return Optional.empty();
117-
}
118-
}
41+
CohereReranker(CohereApi cohereApi) {
42+
if (cohereApi == null) {
43+
throw new IllegalArgumentException("CohereApi must not be null");
44+
}
45+
46+
this.webClient = WebClient.builder()
47+
.baseUrl(COHERE_RERANK_ENDPOINT)
48+
.defaultHeader(HttpHeaders.AUTHORIZATION, "Bearer " + cohereApi.getApiKey())
49+
.build();
50+
}
51+
52+
/**
53+
* Reranks a list of documents based on the provided query using the Cohere API.
54+
* @param query The user input query.
55+
* @param documents The list of documents to rerank.
56+
* @param topN The number of top results to return (at most).
57+
* @return A reranked list of documents. If the API fails, returns the original list.
58+
*/
59+
public List<Document> rerank(String query, List<Document> documents, int topN) {
60+
if (topN < 1) {
61+
throw new IllegalArgumentException("topN must be ≥ 1. Provided: " + topN);
62+
}
63+
64+
if (documents == null || documents.isEmpty()) {
65+
logger.warn("Empty document list provided. Skipping rerank.");
66+
return Collections.emptyList();
67+
}
68+
69+
if (documents.size() > MAX_DOCUMENTS) {
70+
logger.warn("Cohere recommends ≤ {} documents per rerank request. Larger sizes may cause errors.",
71+
MAX_DOCUMENTS);
72+
return documents;
73+
}
74+
75+
int adjustedTopN = Math.min(topN, documents.size());
76+
77+
Map<String, Object> payload = Map.of("query", query, "documents",
78+
documents.stream().map(Document::getText).toList(), "top_n", adjustedTopN);
79+
80+
// Call the API and process the result
81+
return sendRerankRequest(payload).map(results -> results.stream()
82+
.sorted(Comparator.comparingDouble(RerankResponse.Result::getRelevanceScore).reversed())
83+
.map(r -> {
84+
Document original = documents.get(r.getIndex());
85+
Map<String, Object> metadata = new HashMap<>(original.getMetadata());
86+
metadata.put("score", String.format("%.4f", r.getRelevanceScore()));
87+
return new Document(original.getText(), metadata);
88+
})
89+
.toList()).orElseGet(() -> {
90+
logger.warn("Cohere response is null or invalid");
91+
return documents;
92+
});
93+
}
94+
95+
/**
96+
* Sends a rerank request to the Cohere API and returns the result list.
97+
* @param payload The request body including query, documents, and top_n.
98+
* @return An Optional list of reranked results, or empty if failed.
99+
*/
100+
private Optional<List<RerankResponse.Result>> sendRerankRequest(Map<String, Object> payload) {
101+
try {
102+
RerankResponse response = webClient.post()
103+
.bodyValue(payload)
104+
.retrieve()
105+
.bodyToMono(RerankResponse.class)
106+
.block();
107+
108+
return Optional.ofNullable(response).map(RerankResponse::getResults);
109+
}
110+
catch (Exception e) {
111+
logger.error("Cohere rerank failed, fallback to original order: {}", e.getMessage(), e);
112+
return Optional.empty();
113+
}
114+
}
115+
119116
}

‎spring-ai-rag/src/main/java/org/springframework/ai/rag/postretrieval/rerank/RerankConfig.java

Lines changed: 37 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -8,49 +8,50 @@
88
import org.springframework.context.annotation.Configuration;
99

1010
/**
11-
* Rerank configuration that conditionally registers a DocumentPostProcessor
12-
* when rerank is enabled via application properties.
11+
* Rerank configuration that conditionally registers a DocumentPostProcessor when rerank
12+
* is enabled via application properties.
1313
*
1414
* This configuration is activated only when the following properties are set
15-
*
15+
*
1616
* <ul>
17-
* <li>spring.ai.rerank.enabled=true</li>
18-
* <li>spring.ai.rerank.cohere.api-key=your-api-key</li>
17+
* <li>spring.ai.rerank.enabled=true</li>
18+
* <li>spring.ai.rerank.cohere.api-key=your-api-key</li>
1919
* </ul>
2020
*
2121
* @author KoreaNirsa
2222
*/
2323
@Configuration
2424
public class RerankConfig {
25-
@Value("${spring.ai.rerank.cohere.api-key}")
26-
private String apiKey;
27-
28-
/**
29-
* Registers a DocumentPostProcessor bean that enables reranking using Cohere.
30-
*
31-
* This bean is only created when the property `spring.ai.rerank.enabled=true` is set.
32-
* The API key is injected from application properties or environment variables.
33-
*
34-
* @return An instance of RerankerPostProcessor backed by Cohere API
35-
*/
36-
@Bean
37-
@ConditionalOnProperty(name = "spring.ai.rerank.enabled", havingValue = "true")
38-
public DocumentPostProcessor rerankerPostProcessor() {
39-
return new RerankerPostProcessor(CohereApi.builder().apiKey(apiKey).build());
40-
}
41-
42-
/**
43-
* Provides a fallback DocumentPostProcessor when reranking is disabled
44-
* or no custom implementation is registered.
45-
*
46-
* This implementation performs no reranking and simply returns the original list of documents.
47-
* If additional post-processing is required, a custom bean should be defined.
48-
*
49-
* @return A pass-through DocumentPostProcessor that returns input as-is
50-
*/
51-
@Bean
52-
@ConditionalOnMissingBean
53-
public DocumentPostProcessor noOpPostProcessor() {
54-
return (query, documents) -> documents;
55-
}
25+
26+
@Value("${spring.ai.rerank.cohere.api-key}")
27+
private String apiKey;
28+
29+
/**
30+
* Registers a DocumentPostProcessor bean that enables reranking using Cohere.
31+
*
32+
* This bean is only created when the property `spring.ai.rerank.enabled=true` is set.
33+
* The API key is injected from application properties or environment variables.
34+
* @return An instance of RerankerPostProcessor backed by Cohere API
35+
*/
36+
@Bean
37+
@ConditionalOnProperty(name = "spring.ai.rerank.enabled", havingValue = "true")
38+
public DocumentPostProcessor rerankerPostProcessor() {
39+
return new RerankerPostProcessor(CohereApi.builder().apiKey(apiKey).build());
40+
}
41+
42+
/**
43+
* Provides a fallback DocumentPostProcessor when reranking is disabled or no custom
44+
* implementation is registered.
45+
*
46+
* This implementation performs no reranking and simply returns the original list of
47+
* documents. If additional post-processing is required, a custom bean should be
48+
* defined.
49+
* @return A pass-through DocumentPostProcessor that returns input as-is
50+
*/
51+
@Bean
52+
@ConditionalOnMissingBean
53+
public DocumentPostProcessor noOpPostProcessor() {
54+
return (query, documents) -> documents;
55+
}
56+
5657
}

‎spring-ai-rag/src/main/java/org/springframework/ai/rag/postretrieval/rerank/RerankResponse.java

Lines changed: 42 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -5,47 +5,50 @@
55
import com.fasterxml.jackson.annotation.JsonProperty;
66

77
/**
8-
* Represents the response returned from Cohere's Rerank API.
9-
* The response includes a list of result objects that specify document indices
10-
* and their semantic relevance scores.
8+
* Represents the response returned from Cohere's Rerank API. The response includes a list
9+
* of result objects that specify document indices and their semantic relevance scores.
1110
*
1211
* @author KoreaNirsa
1312
*/
1413
public class RerankResponse {
15-
private List<Result> results;
16-
17-
public List<Result> getResults() {
18-
return results;
19-
}
20-
21-
public void setResults(List<Result> results) {
22-
this.results = results;
23-
}
24-
25-
/**
26-
* Represents a single reranked document result returned by the Cohere API.
27-
* Contains the original index and the computed relevance score.
28-
*/
29-
public static class Result {
30-
private int index;
31-
32-
@JsonProperty("relevance_score")
33-
private double relevanceScore;
34-
35-
public int getIndex() {
36-
return index;
37-
}
38-
39-
public void setIndex(int index) {
40-
this.index = index;
41-
}
42-
43-
public double getRelevanceScore() {
44-
return relevanceScore;
45-
}
46-
47-
public void setRelevanceScore(double relevanceScore) {
48-
this.relevanceScore = relevanceScore;
49-
}
50-
}
14+
15+
private List<Result> results;
16+
17+
public List<Result> getResults() {
18+
return results;
19+
}
20+
21+
public void setResults(List<Result> results) {
22+
this.results = results;
23+
}
24+
25+
/**
26+
* Represents a single reranked document result returned by the Cohere API. Contains
27+
* the original index and the computed relevance score.
28+
*/
29+
public static class Result {
30+
31+
private int index;
32+
33+
@JsonProperty("relevance_score")
34+
private double relevanceScore;
35+
36+
public int getIndex() {
37+
return index;
38+
}
39+
40+
public void setIndex(int index) {
41+
this.index = index;
42+
}
43+
44+
public double getRelevanceScore() {
45+
return relevanceScore;
46+
}
47+
48+
public void setRelevanceScore(double relevanceScore) {
49+
this.relevanceScore = relevanceScore;
50+
}
51+
52+
}
53+
5154
}

0 commit comments

Comments
 (0)