Skip to content

Commit 48c1829

Browse files
sobychackoleijendary
sobychacko
authored and
leijendary
committed
Addressing vector store releated checkstyle issues
Signed-off-by: leijendary <[email protected]>
1 parent b9fadc0 commit 48c1829

File tree

25 files changed

+59
-91
lines changed

25 files changed

+59
-91
lines changed

‎vector-stores/spring-ai-azure-cosmos-db-store/src/main/java/org/springframework/ai/vectorstore/cosmosdb/CosmosDBVectorStore.java‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,6 @@
5151
import com.fasterxml.jackson.databind.JsonNode;
5252
import com.fasterxml.jackson.databind.ObjectMapper;
5353
import com.fasterxml.jackson.databind.node.ObjectNode;
54-
import io.micrometer.observation.ObservationRegistry;
5554
import org.apache.commons.lang3.tuple.ImmutablePair;
5655
import org.slf4j.Logger;
5756
import org.slf4j.LoggerFactory;
@@ -68,7 +67,6 @@
6867
import org.springframework.ai.vectorstore.filter.Filter;
6968
import org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore;
7069
import org.springframework.ai.vectorstore.observation.VectorStoreObservationContext;
71-
import org.springframework.ai.vectorstore.observation.VectorStoreObservationConvention;
7270
import org.springframework.lang.Nullable;
7371
import org.springframework.util.Assert;
7472

@@ -124,8 +122,9 @@ protected CosmosDBVectorStore(Builder builder) {
124122
this.metadataFieldsList = builder.metadataFieldsList;
125123
this.batchingStrategy = builder.batchingStrategy;
126124

127-
cosmosClient.createDatabaseIfNotExists(databaseName).block();
128-
initializeContainer(containerName, databaseName, vectorStoreThroughput, vectorDimensions, partitionKeyPath);
125+
this.cosmosClient.createDatabaseIfNotExists(this.databaseName).block();
126+
initializeContainer(this.containerName, this.databaseName, this.vectorStoreThroughput, this.vectorDimensions,
127+
this.partitionKeyPath);
129128
}
130129

131130
public static Builder builder(CosmosAsyncClient cosmosClient, EmbeddingModel embeddingModel) {
@@ -136,10 +135,10 @@ private void initializeContainer(String containerName, String databaseName, int
136135
long vectorDimensions, String partitionKeyPath) {
137136

138137
// Set defaults if not provided
139-
if (vectorStoreThroughput == 0) {
138+
if (this.vectorStoreThroughput == 0) {
140139
vectorStoreThroughput = 400;
141140
}
142-
if (partitionKeyPath == null) {
141+
if (this.partitionKeyPath == null) {
143142
partitionKeyPath = "/id";
144143
}
145144

@@ -153,17 +152,17 @@ private void initializeContainer(String containerName, String databaseName, int
153152
subPartitionKeyDefinition.setKind(PartitionKind.MULTI_HASH);
154153
}
155154
else {
156-
subPartitionKeyDefinition.setPaths(Collections.singletonList(partitionKeyPath));
155+
subPartitionKeyDefinition.setPaths(Collections.singletonList(this.partitionKeyPath));
157156
subPartitionKeyDefinition.setKind(PartitionKind.HASH);
158157
}
159-
CosmosContainerProperties collectionDefinition = new CosmosContainerProperties(containerName,
158+
CosmosContainerProperties collectionDefinition = new CosmosContainerProperties(this.containerName,
160159
subPartitionKeyDefinition);
161160
// Set vector embedding policy
162161
CosmosVectorEmbeddingPolicy embeddingPolicy = new CosmosVectorEmbeddingPolicy();
163162
CosmosVectorEmbedding embedding = new CosmosVectorEmbedding();
164163
embedding.setPath("/embedding");
165164
embedding.setDataType(CosmosVectorDataType.FLOAT32);
166-
embedding.setDimensions(vectorDimensions);
165+
embedding.setDimensions(this.vectorDimensions);
167166
embedding.setDistanceFunction(CosmosVectorDistanceFunction.COSINE);
168167
embeddingPolicy.setCosmosVectorEmbeddings(Collections.singletonList(embedding));
169168
collectionDefinition.setVectorEmbeddingPolicy(embeddingPolicy);
@@ -182,10 +181,11 @@ private void initializeContainer(String containerName, String databaseName, int
182181
indexingPolicy.setVectorIndexes(List.of(cosmosVectorIndexSpec));
183182
collectionDefinition.setIndexingPolicy(indexingPolicy);
184183

185-
ThroughputProperties throughputProperties = ThroughputProperties.createManualThroughput(vectorStoreThroughput);
186-
CosmosAsyncDatabase cosmosAsyncDatabase = this.cosmosClient.getDatabase(databaseName);
184+
ThroughputProperties throughputProperties = ThroughputProperties
185+
.createManualThroughput(this.vectorStoreThroughput);
186+
CosmosAsyncDatabase cosmosAsyncDatabase = this.cosmosClient.getDatabase(this.databaseName);
187187
cosmosAsyncDatabase.createContainerIfNotExists(collectionDefinition, throughputProperties).block();
188-
this.container = cosmosAsyncDatabase.getContainer(containerName);
188+
this.container = cosmosAsyncDatabase.getContainer(this.containerName);
189189
}
190190

191191
@Override
@@ -385,7 +385,7 @@ public VectorStoreObservationContext.Builder createObservationContextBuilder(Str
385385
*
386386
* @since 1.0.0
387387
*/
388-
public static class Builder extends AbstractVectorStoreBuilder<Builder> {
388+
public static final class Builder extends AbstractVectorStoreBuilder<Builder> {
389389

390390
private final CosmosAsyncClient cosmosClient;
391391

@@ -419,7 +419,7 @@ private Builder(CosmosAsyncClient cosmosClient, EmbeddingModel embeddingModel) {
419419
* @throws IllegalArgumentException if containerName is null or empty
420420
*/
421421
public Builder containerName(String containerName) {
422-
Assert.hasText(containerName, "Container name must not be empty");
422+
Assert.hasText(this.containerName, "Container name must not be empty");
423423
this.containerName = containerName;
424424
return this;
425425
}
@@ -431,7 +431,7 @@ public Builder containerName(String containerName) {
431431
* @throws IllegalArgumentException if databaseName is null or empty
432432
*/
433433
public Builder databaseName(String databaseName) {
434-
Assert.hasText(databaseName, "Database name must not be empty");
434+
Assert.hasText(this.databaseName, "Database name must not be empty");
435435
this.databaseName = databaseName;
436436
return this;
437437
}
@@ -443,7 +443,7 @@ public Builder databaseName(String databaseName) {
443443
* @throws IllegalArgumentException if partitionKeyPath is null or empty
444444
*/
445445
public Builder partitionKeyPath(String partitionKeyPath) {
446-
Assert.hasText(partitionKeyPath, "Partition key path must not be empty");
446+
Assert.hasText(this.partitionKeyPath, "Partition key path must not be empty");
447447
this.partitionKeyPath = partitionKeyPath;
448448
return this;
449449
}
@@ -455,7 +455,7 @@ public Builder partitionKeyPath(String partitionKeyPath) {
455455
* @throws IllegalArgumentException if vectorStoreThroughput is not positive
456456
*/
457457
public Builder vectorStoreThroughput(int vectorStoreThroughput) {
458-
Assert.isTrue(vectorStoreThroughput > 0, "Vector store throughput must be positive");
458+
Assert.isTrue(this.vectorStoreThroughput > 0, "Vector store throughput must be positive");
459459
this.vectorStoreThroughput = vectorStoreThroughput;
460460
return this;
461461
}
@@ -467,7 +467,7 @@ public Builder vectorStoreThroughput(int vectorStoreThroughput) {
467467
* @throws IllegalArgumentException if vectorDimensions is not positive
468468
*/
469469
public Builder vectorDimensions(long vectorDimensions) {
470-
Assert.isTrue(vectorDimensions > 0, "Vector dimensions must be positive");
470+
Assert.isTrue(this.vectorDimensions > 0, "Vector dimensions must be positive");
471471
this.vectorDimensions = vectorDimensions;
472472
return this;
473473
}
@@ -478,7 +478,7 @@ public Builder vectorDimensions(long vectorDimensions) {
478478
* @return the builder instance
479479
*/
480480
public Builder metadataFields(List<String> metadataFieldsList) {
481-
this.metadataFieldsList = metadataFieldsList != null ? new ArrayList<>(metadataFieldsList)
481+
this.metadataFieldsList = metadataFieldsList != null ? new ArrayList<>(this.metadataFieldsList)
482482
: new ArrayList<>();
483483
return this;
484484
}
@@ -490,7 +490,7 @@ public Builder metadataFields(List<String> metadataFieldsList) {
490490
* @throws IllegalArgumentException if batchingStrategy is null
491491
*/
492492
public Builder batchingStrategy(BatchingStrategy batchingStrategy) {
493-
Assert.notNull(batchingStrategy, "BatchingStrategy must not be null");
493+
Assert.notNull(this.batchingStrategy, "BatchingStrategy must not be null");
494494
this.batchingStrategy = batchingStrategy;
495495
return this;
496496
}

‎vector-stores/spring-ai-azure-store/src/main/java/org/springframework/ai/vectorstore/azure/AzureVectorStore.java‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@
4242
import com.azure.search.documents.models.SearchOptions;
4343
import com.azure.search.documents.models.VectorSearchOptions;
4444
import com.azure.search.documents.models.VectorizedQuery;
45-
import io.micrometer.observation.ObservationRegistry;
4645
import org.slf4j.Logger;
4746
import org.slf4j.LoggerFactory;
4847

@@ -60,7 +59,6 @@
6059
import org.springframework.ai.vectorstore.filter.FilterExpressionConverter;
6160
import org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore;
6261
import org.springframework.ai.vectorstore.observation.VectorStoreObservationContext;
63-
import org.springframework.ai.vectorstore.observation.VectorStoreObservationConvention;
6462
import org.springframework.beans.factory.InitializingBean;
6563
import org.springframework.lang.Nullable;
6664
import org.springframework.util.Assert;

‎vector-stores/spring-ai-cassandra-store/src/main/java/org/springframework/ai/vectorstore/cassandra/CassandraVectorStore.java‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,6 @@
6060
import com.datastax.oss.driver.api.querybuilder.schema.CreateTableStart;
6161
import com.datastax.oss.driver.shaded.guava.common.annotations.VisibleForTesting;
6262
import com.datastax.oss.driver.shaded.guava.common.base.Preconditions;
63-
import io.micrometer.observation.ObservationRegistry;
6463
import org.slf4j.Logger;
6564
import org.slf4j.LoggerFactory;
6665

@@ -80,7 +79,6 @@
8079
import org.springframework.ai.vectorstore.filter.FilterExpressionConverter;
8180
import org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore;
8281
import org.springframework.ai.vectorstore.observation.VectorStoreObservationContext;
83-
import org.springframework.ai.vectorstore.observation.VectorStoreObservationConvention;
8482
import org.springframework.util.Assert;
8583

8684
/**

‎vector-stores/spring-ai-chroma-store/src/main/java/org/springframework/ai/chroma/vectorstore/ChromaVectorStore.java‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525
import com.fasterxml.jackson.core.JsonProcessingException;
2626
import com.fasterxml.jackson.databind.ObjectMapper;
2727
import com.fasterxml.jackson.databind.json.JsonMapper;
28-
import io.micrometer.observation.ObservationRegistry;
2928

3029
import org.springframework.ai.chroma.vectorstore.ChromaApi.AddEmbeddingsRequest;
3130
import org.springframework.ai.chroma.vectorstore.ChromaApi.DeleteEmbeddingsRequest;
@@ -44,7 +43,6 @@
4443
import org.springframework.ai.vectorstore.filter.FilterExpressionConverter;
4544
import org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore;
4645
import org.springframework.ai.vectorstore.observation.VectorStoreObservationContext;
47-
import org.springframework.ai.vectorstore.observation.VectorStoreObservationConvention;
4846
import org.springframework.beans.factory.InitializingBean;
4947
import org.springframework.lang.NonNull;
5048
import org.springframework.lang.Nullable;

‎vector-stores/spring-ai-coherence-store/src/main/java/org/springframework/ai/vectorstore/coherence/CoherenceVectorStore.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,7 @@ public VectorStoreObservationContext.Builder createObservationContextBuilder(Str
283283
*
284284
* @since 1.0.0
285285
*/
286-
public static class Builder extends AbstractVectorStoreBuilder<Builder> {
286+
public static final class Builder extends AbstractVectorStoreBuilder<Builder> {
287287

288288
private final Session session;
289289

‎vector-stores/spring-ai-elasticsearch-store/src/main/java/org/springframework/ai/vectorstore/elasticsearch/ElasticsearchVectorStore.java‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@
3434
import co.elastic.clients.transport.rest_client.RestClientTransport;
3535
import com.fasterxml.jackson.databind.DeserializationFeature;
3636
import com.fasterxml.jackson.databind.ObjectMapper;
37-
import io.micrometer.observation.ObservationRegistry;
3837
import org.elasticsearch.client.RestClient;
3938
import org.slf4j.Logger;
4039
import org.slf4j.LoggerFactory;
@@ -54,7 +53,6 @@
5453
import org.springframework.ai.vectorstore.filter.FilterExpressionConverter;
5554
import org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore;
5655
import org.springframework.ai.vectorstore.observation.VectorStoreObservationContext;
57-
import org.springframework.ai.vectorstore.observation.VectorStoreObservationConvention;
5856
import org.springframework.beans.factory.InitializingBean;
5957
import org.springframework.util.Assert;
6058

@@ -344,6 +342,14 @@ private String getSimilarityMetric() {
344342
return SIMILARITY_TYPE_MAPPING.get(this.options.getSimilarity()).value();
345343
}
346344

345+
/**
346+
* Creates a new builder instance for ElasticsearchVectorStore.
347+
* @return a new ElasticsearchBuilder instance
348+
*/
349+
public static Builder builder(RestClient restClient, EmbeddingModel embeddingModel) {
350+
return new Builder(restClient, embeddingModel);
351+
}
352+
347353
/**
348354
* The representation of {@link Document} along with its embedding.
349355
*
@@ -355,14 +361,6 @@ private String getSimilarityMetric() {
355361
public record ElasticSearchDocument(String id, String content, Map<String, Object> metadata, float[] embedding) {
356362
}
357363

358-
/**
359-
* Creates a new builder instance for ElasticsearchVectorStore.
360-
* @return a new ElasticsearchBuilder instance
361-
*/
362-
public static Builder builder(RestClient restClient, EmbeddingModel embeddingModel) {
363-
return new Builder(restClient, embeddingModel);
364-
}
365-
366364
public static class Builder extends AbstractVectorStoreBuilder<Builder> {
367365

368366
private final RestClient restClient;

‎vector-stores/spring-ai-elasticsearch-store/src/test/java/org/springframework/ai/vectorstore/elasticsearch/ElasticsearchVectorStoreIT.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,12 @@
4242
import org.junit.jupiter.api.condition.EnabledIfEnvironmentVariable;
4343
import org.junit.jupiter.params.ParameterizedTest;
4444
import org.junit.jupiter.params.provider.ValueSource;
45-
import org.springframework.ai.document.DocumentMetadata;
4645
import org.testcontainers.elasticsearch.ElasticsearchContainer;
4746
import org.testcontainers.junit.jupiter.Container;
4847
import org.testcontainers.junit.jupiter.Testcontainers;
4948

5049
import org.springframework.ai.document.Document;
50+
import org.springframework.ai.document.DocumentMetadata;
5151
import org.springframework.ai.embedding.EmbeddingModel;
5252
import org.springframework.ai.openai.OpenAiEmbeddingModel;
5353
import org.springframework.ai.openai.api.OpenAiApi;

‎vector-stores/spring-ai-gemfire-store/src/main/java/org/springframework/ai/vectorstore/gemfire/GemFireVectorStore.java‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,11 @@
2727
import com.fasterxml.jackson.core.JsonProcessingException;
2828
import com.fasterxml.jackson.databind.ObjectMapper;
2929
import com.fasterxml.jackson.databind.json.JsonMapper;
30-
import io.micrometer.observation.ObservationRegistry;
3130
import org.slf4j.Logger;
3231
import org.slf4j.LoggerFactory;
33-
import org.springframework.ai.document.DocumentMetadata;
3432

3533
import org.springframework.ai.document.Document;
34+
import org.springframework.ai.document.DocumentMetadata;
3635
import org.springframework.ai.embedding.BatchingStrategy;
3736
import org.springframework.ai.embedding.EmbeddingModel;
3837
import org.springframework.ai.embedding.EmbeddingOptionsBuilder;
@@ -43,7 +42,6 @@
4342
import org.springframework.ai.vectorstore.SearchRequest;
4443
import org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore;
4544
import org.springframework.ai.vectorstore.observation.VectorStoreObservationContext;
46-
import org.springframework.ai.vectorstore.observation.VectorStoreObservationConvention;
4745
import org.springframework.beans.factory.InitializingBean;
4846
import org.springframework.http.HttpMethod;
4947
import org.springframework.http.MediaType;
@@ -564,7 +562,7 @@ public void setDeleteData(boolean deleteData) {
564562
*
565563
* @since 1.0.0
566564
*/
567-
public static class Builder extends AbstractVectorStoreBuilder<Builder> {
565+
public static final class Builder extends AbstractVectorStoreBuilder<Builder> {
568566

569567
private String host = GemFireVectorStore.DEFAULT_HOST;
570568

‎vector-stores/spring-ai-hanadb-store/src/main/java/org/springframework/ai/vectorstore/hanadb/HanaCloudVectorStore.java‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424
import com.fasterxml.jackson.core.JsonProcessingException;
2525
import com.fasterxml.jackson.databind.ObjectMapper;
2626
import com.fasterxml.jackson.databind.json.JsonMapper;
27-
import io.micrometer.observation.ObservationRegistry;
2827
import org.slf4j.Logger;
2928
import org.slf4j.LoggerFactory;
3029

@@ -38,7 +37,6 @@
3837
import org.springframework.ai.vectorstore.SearchRequest;
3938
import org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore;
4039
import org.springframework.ai.vectorstore.observation.VectorStoreObservationContext;
41-
import org.springframework.ai.vectorstore.observation.VectorStoreObservationConvention;
4240
import org.springframework.lang.Nullable;
4341
import org.springframework.util.Assert;
4442

‎vector-stores/spring-ai-mariadb-store/src/main/java/org/springframework/ai/vectorstore/mariadb/MariaDBVectorStore.java‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@
2828
import com.fasterxml.jackson.core.JsonProcessingException;
2929
import com.fasterxml.jackson.databind.ObjectMapper;
3030
import com.fasterxml.jackson.databind.json.JsonMapper;
31-
import io.micrometer.observation.ObservationRegistry;
3231
import org.slf4j.Logger;
3332
import org.slf4j.LoggerFactory;
3433

@@ -45,7 +44,6 @@
4544
import org.springframework.ai.vectorstore.filter.FilterExpressionConverter;
4645
import org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore;
4746
import org.springframework.ai.vectorstore.observation.VectorStoreObservationContext;
48-
import org.springframework.ai.vectorstore.observation.VectorStoreObservationConvention;
4947
import org.springframework.beans.factory.InitializingBean;
5048
import org.springframework.jdbc.core.BatchPreparedStatementSetter;
5149
import org.springframework.jdbc.core.JdbcTemplate;

0 commit comments

Comments
 (0)