Skip to content

Commit a57a7ed

Browse files
sobychackoleijendary
sobychacko
authored and
leijendary
committed
Standardize builder class names in vector stores
- Rename all specific builder inner classes (PineconeBuilder, MongoDBBuilder, etc.) to simply Builder for consistency across vector store implementations - Update code references to use the new standardized Builder class names The change establishes a consistent naming convention for builder classes across the vector store implementations, improving code uniformity. Signed-off-by: leijendary <[email protected]>
1 parent e5d3cfb commit a57a7ed

File tree

25 files changed

+263
-267
lines changed

25 files changed

+263
-267
lines changed

‎spring-ai-spring-boot-autoconfigure/src/main/java/org/springframework/ai/autoconfigure/vectorstore/mongo/MongoDBAtlasVectorStoreAutoConfiguration.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ MongoDBAtlasVectorStore vectorStore(MongoTemplate mongoTemplate, EmbeddingModel
6666
ObjectProvider<VectorStoreObservationConvention> customObservationConvention,
6767
BatchingStrategy batchingStrategy) {
6868

69-
MongoDBAtlasVectorStore.MongoDBBuilder builder = MongoDBAtlasVectorStore.builder(mongoTemplate, embeddingModel)
69+
MongoDBAtlasVectorStore.Builder builder = MongoDBAtlasVectorStore.builder(mongoTemplate, embeddingModel)
7070
.initializeSchema(properties.isInitializeSchema())
7171
.observationRegistry(observationRegistry.getIfUnique(() -> ObservationRegistry.NOOP))
7272
.customObservationConvention(customObservationConvention.getIfAvailable(() -> null))

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ public CosmosDBVectorStore(ObservationRegistry observationRegistry,
151151
* create new CosmosDBVectorStore instances.
152152
* @param builder the configured builder instance
153153
*/
154-
protected CosmosDBVectorStore(CosmosDBBuilder builder) {
154+
protected CosmosDBVectorStore(Builder builder) {
155155
super(builder);
156156

157157
Assert.notNull(builder.cosmosClient, "CosmosClient must not be null");
@@ -172,8 +172,8 @@ protected CosmosDBVectorStore(CosmosDBBuilder builder) {
172172
initializeContainer(containerName, databaseName, vectorStoreThroughput, vectorDimensions, partitionKeyPath);
173173
}
174174

175-
public static CosmosDBBuilder builder(CosmosAsyncClient cosmosClient, EmbeddingModel embeddingModel) {
176-
return new CosmosDBBuilder(cosmosClient, embeddingModel);
175+
public static Builder builder(CosmosAsyncClient cosmosClient, EmbeddingModel embeddingModel) {
176+
return new Builder(cosmosClient, embeddingModel);
177177
}
178178

179179
private void initializeContainer(String containerName, String databaseName, int vectorStoreThroughput,
@@ -429,7 +429,7 @@ public VectorStoreObservationContext.Builder createObservationContextBuilder(Str
429429
*
430430
* @since 1.0.0
431431
*/
432-
public static class CosmosDBBuilder extends AbstractVectorStoreBuilder<CosmosDBBuilder> {
432+
public static class Builder extends AbstractVectorStoreBuilder<Builder> {
433433

434434
private final CosmosAsyncClient cosmosClient;
435435

@@ -450,7 +450,7 @@ public static class CosmosDBBuilder extends AbstractVectorStoreBuilder<CosmosDBB
450450

451451
private BatchingStrategy batchingStrategy = new TokenCountBatchingStrategy();
452452

453-
private CosmosDBBuilder(CosmosAsyncClient cosmosClient, EmbeddingModel embeddingModel) {
453+
private Builder(CosmosAsyncClient cosmosClient, EmbeddingModel embeddingModel) {
454454
super(embeddingModel);
455455
Assert.notNull(cosmosClient, "CosmosClient must not be null");
456456
this.cosmosClient = cosmosClient;
@@ -462,7 +462,7 @@ private CosmosDBBuilder(CosmosAsyncClient cosmosClient, EmbeddingModel embedding
462462
* @return the builder instance
463463
* @throws IllegalArgumentException if containerName is null or empty
464464
*/
465-
public CosmosDBBuilder containerName(String containerName) {
465+
public Builder containerName(String containerName) {
466466
Assert.hasText(containerName, "Container name must not be empty");
467467
this.containerName = containerName;
468468
return this;
@@ -474,7 +474,7 @@ public CosmosDBBuilder containerName(String containerName) {
474474
* @return the builder instance
475475
* @throws IllegalArgumentException if databaseName is null or empty
476476
*/
477-
public CosmosDBBuilder databaseName(String databaseName) {
477+
public Builder databaseName(String databaseName) {
478478
Assert.hasText(databaseName, "Database name must not be empty");
479479
this.databaseName = databaseName;
480480
return this;
@@ -486,7 +486,7 @@ public CosmosDBBuilder databaseName(String databaseName) {
486486
* @return the builder instance
487487
* @throws IllegalArgumentException if partitionKeyPath is null or empty
488488
*/
489-
public CosmosDBBuilder partitionKeyPath(String partitionKeyPath) {
489+
public Builder partitionKeyPath(String partitionKeyPath) {
490490
Assert.hasText(partitionKeyPath, "Partition key path must not be empty");
491491
this.partitionKeyPath = partitionKeyPath;
492492
return this;
@@ -498,7 +498,7 @@ public CosmosDBBuilder partitionKeyPath(String partitionKeyPath) {
498498
* @return the builder instance
499499
* @throws IllegalArgumentException if vectorStoreThroughput is not positive
500500
*/
501-
public CosmosDBBuilder vectorStoreThroughput(int vectorStoreThroughput) {
501+
public Builder vectorStoreThroughput(int vectorStoreThroughput) {
502502
Assert.isTrue(vectorStoreThroughput > 0, "Vector store throughput must be positive");
503503
this.vectorStoreThroughput = vectorStoreThroughput;
504504
return this;
@@ -510,7 +510,7 @@ public CosmosDBBuilder vectorStoreThroughput(int vectorStoreThroughput) {
510510
* @return the builder instance
511511
* @throws IllegalArgumentException if vectorDimensions is not positive
512512
*/
513-
public CosmosDBBuilder vectorDimensions(long vectorDimensions) {
513+
public Builder vectorDimensions(long vectorDimensions) {
514514
Assert.isTrue(vectorDimensions > 0, "Vector dimensions must be positive");
515515
this.vectorDimensions = vectorDimensions;
516516
return this;
@@ -521,7 +521,7 @@ public CosmosDBBuilder vectorDimensions(long vectorDimensions) {
521521
* @param metadataFieldsList the list of metadata fields
522522
* @return the builder instance
523523
*/
524-
public CosmosDBBuilder metadataFields(List<String> metadataFieldsList) {
524+
public Builder metadataFields(List<String> metadataFieldsList) {
525525
this.metadataFieldsList = metadataFieldsList != null ? new ArrayList<>(metadataFieldsList)
526526
: new ArrayList<>();
527527
return this;
@@ -533,7 +533,7 @@ public CosmosDBBuilder metadataFields(List<String> metadataFieldsList) {
533533
* @return the builder instance
534534
* @throws IllegalArgumentException if batchingStrategy is null
535535
*/
536-
public CosmosDBBuilder batchingStrategy(BatchingStrategy batchingStrategy) {
536+
public Builder batchingStrategy(BatchingStrategy batchingStrategy) {
537537
Assert.notNull(batchingStrategy, "BatchingStrategy must not be null");
538538
this.batchingStrategy = batchingStrategy;
539539
return this;

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

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ public AzureVectorStore(SearchIndexClient searchIndexClient, EmbeddingModel embe
190190
* create new AzureVectorStore instances.
191191
* @param builder the configured builder instance
192192
*/
193-
protected AzureVectorStore(AzureBuilder builder) {
193+
protected AzureVectorStore(Builder builder) {
194194
super(builder);
195195

196196
Assert.notNull(builder.searchIndexClient, "The search index client cannot be null");
@@ -206,15 +206,15 @@ protected AzureVectorStore(AzureBuilder builder) {
206206
this.filterExpressionConverter = new AzureAiSearchFilterExpressionConverter(filterMetadataFields);
207207
}
208208

209-
public static AzureBuilder builder(SearchIndexClient searchIndexClient, EmbeddingModel embeddingModel) {
210-
return new AzureBuilder(searchIndexClient, embeddingModel);
209+
public static Builder builder(SearchIndexClient searchIndexClient, EmbeddingModel embeddingModel) {
210+
return new Builder(searchIndexClient, embeddingModel);
211211
}
212212

213213
/**
214214
* Change the Index Name.
215215
* @param indexName The Azure VectorStore index name to use.
216216
* @deprecated Since 1.0.0-M5, use {@link #builder(SearchIndexClient, EmbeddingModel)}
217-
* ()} with {@link AzureBuilder#indexName(String)} instead
217+
* ()} with {@link Builder#indexName(String)} instead
218218
*/
219219
@Deprecated(since = "1.0.0-M5", forRemoval = true)
220220
public void setIndexName(String indexName) {
@@ -226,7 +226,7 @@ public void setIndexName(String indexName) {
226226
* Sets the a default maximum number of similar documents returned.
227227
* @param topK The default maximum number of similar documents returned.
228228
* @deprecated Since 1.0.0-M5, use {@link #builder(SearchIndexClient, EmbeddingModel)}
229-
* ()} with {@link AzureBuilder#indexName(String)} instead
229+
* ()} with {@link Builder#indexName(String)} instead
230230
*/
231231
@Deprecated(since = "1.0.0-M5", forRemoval = true)
232232
public void setDefaultTopK(int topK) {
@@ -239,7 +239,7 @@ public void setDefaultTopK(int topK) {
239239
* @param similarityThreshold The a default similarity threshold for returned
240240
* documents.
241241
* @deprecated Since 1.0.0-M5, use {@link #builder(SearchIndexClient, EmbeddingModel)}
242-
* ()} with {@link AzureBuilder#indexName(String)} instead
242+
* ()} with {@link Builder#indexName(String)} instead
243243
*/
244244
@Deprecated(since = "1.0.0-M5", forRemoval = true)
245245
public void setDefaultSimilarityThreshold(Double similarityThreshold) {
@@ -472,7 +472,7 @@ private record AzureSearchDocument(String id, String content, List<Float> embedd
472472
*
473473
* @since 1.0.0
474474
*/
475-
public static class AzureBuilder extends AbstractVectorStoreBuilder<AzureBuilder> {
475+
public static class Builder extends AbstractVectorStoreBuilder<Builder> {
476476

477477
private final SearchIndexClient searchIndexClient;
478478

@@ -488,7 +488,7 @@ public static class AzureBuilder extends AbstractVectorStoreBuilder<AzureBuilder
488488

489489
private String indexName = DEFAULT_INDEX_NAME;
490490

491-
private AzureBuilder(SearchIndexClient searchIndexClient, EmbeddingModel embeddingModel) {
491+
private Builder(SearchIndexClient searchIndexClient, EmbeddingModel embeddingModel) {
492492
super(embeddingModel);
493493
Assert.notNull(searchIndexClient, "SearchIndexClient must not be null");
494494
this.searchIndexClient = searchIndexClient;
@@ -499,7 +499,7 @@ private AzureBuilder(SearchIndexClient searchIndexClient, EmbeddingModel embeddi
499499
* @param initializeSchema true to initialize schema, false otherwise
500500
* @return the builder instance
501501
*/
502-
public AzureBuilder initializeSchema(boolean initializeSchema) {
502+
public Builder initializeSchema(boolean initializeSchema) {
503503
this.initializeSchema = initializeSchema;
504504
return this;
505505
}
@@ -509,7 +509,7 @@ public AzureBuilder initializeSchema(boolean initializeSchema) {
509509
* @param filterMetadataFields the list of metadata fields
510510
* @return the builder instance
511511
*/
512-
public AzureBuilder filterMetadataFields(List<MetadataField> filterMetadataFields) {
512+
public Builder filterMetadataFields(List<MetadataField> filterMetadataFields) {
513513
this.filterMetadataFields = filterMetadataFields != null ? filterMetadataFields : List.of();
514514
return this;
515515
}
@@ -519,7 +519,7 @@ public AzureBuilder filterMetadataFields(List<MetadataField> filterMetadataField
519519
* @param batchingStrategy the strategy to use
520520
* @return the builder instance
521521
*/
522-
public AzureBuilder batchingStrategy(BatchingStrategy batchingStrategy) {
522+
public Builder batchingStrategy(BatchingStrategy batchingStrategy) {
523523
Assert.notNull(batchingStrategy, "BatchingStrategy must not be null");
524524
this.batchingStrategy = batchingStrategy;
525525
return this;
@@ -531,7 +531,7 @@ public AzureBuilder batchingStrategy(BatchingStrategy batchingStrategy) {
531531
* @return the builder instance
532532
* @throws IllegalArgumentException if indexName is null or empty
533533
*/
534-
public AzureBuilder indexName(String indexName) {
534+
public Builder indexName(String indexName) {
535535
Assert.hasText(indexName, "The index name can not be empty.");
536536
this.indexName = indexName;
537537
return this;
@@ -543,7 +543,7 @@ public AzureBuilder indexName(String indexName) {
543543
* @return the builder instance
544544
* @throws IllegalArgumentException if defaultTopK is negative
545545
*/
546-
public AzureBuilder defaultTopK(int defaultTopK) {
546+
public Builder defaultTopK(int defaultTopK) {
547547
Assert.isTrue(defaultTopK >= 0, "The topK should be positive value.");
548548
this.defaultTopK = defaultTopK;
549549
return this;
@@ -557,7 +557,7 @@ public AzureBuilder defaultTopK(int defaultTopK) {
557557
* @throws IllegalArgumentException if defaultSimilarityThreshold is not between
558558
* 0.0 and 1.0
559559
*/
560-
public AzureBuilder defaultSimilarityThreshold(Double defaultSimilarityThreshold) {
560+
public Builder defaultSimilarityThreshold(Double defaultSimilarityThreshold) {
561561
Assert.isTrue(defaultSimilarityThreshold >= 0.0 && defaultSimilarityThreshold <= 1.0,
562562
"The similarity threshold must be in range [0.0:1.00].");
563563
this.defaultSimilarityThreshold = defaultSimilarityThreshold;

0 commit comments

Comments
 (0)