Skip to content

Commit b206b37

Browse files
sobychackomarkpollack
authored andcommitted
Consistent vector store property prefix for Chroma store
* The Chroma vector store config property prefix uses .store at the end which is not consistent with the other vector stores - fixing this. * Update the upgrade-notes.adoc
1 parent 0f93828 commit b206b37

File tree

4 files changed

+10
-5
lines changed

4 files changed

+10
-5
lines changed

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/chroma.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ spring.ai.vectorstore.chroma.client.username=<your username (if configure)>
7474
spring.ai.vectorstore.chroma.client.password=<your password (if configure)>
7575
7676
# Chroma Vector Store collection properties
77-
spring.ai.vectorstore.chroma.store.collection-name=<your collection name>
77+
spring.ai.vectorstore.chroma.collection-name=<your collection name>
7878
7979
# Chroma Vector Store configuration properties
8080
@@ -116,7 +116,7 @@ You can use the following properties in your Spring Boot configuration to custom
116116
|`spring.ai.vectorstore.chroma.client.key-token`| Access token (if configured) | -
117117
|`spring.ai.vectorstore.chroma.client.username`| Access username (if configured) | -
118118
|`spring.ai.vectorstore.chroma.client.password`| Access password (if configured) | -
119-
|`spring.ai.vectorstore.chroma.store.collection-name`| Collection name | `SpringAiCollection`
119+
|`spring.ai.vectorstore.chroma.collection-name`| Collection name | `SpringAiCollection`
120120
|===
121121

122122
[NOTE]

spring-ai-docs/src/main/antora/modules/ROOT/pages/upgrade-notes.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
[[upgrade-notes]]
22
= Upgrading Notes
33

4+
== Upgrading to 1.0.0.M2
5+
6+
* The configuration prefix for the Chroma Vector Store has been changes from `spring.ai.vectorstore.chroma.store` to `spring.ai.vectorstore.chroma` in order to align with the naming conventions of other vector stores.
7+
48
== Upgrading to 1.0.0.M1
59

610
On our march to release 1.0.0 M1 we have made several breaking changes. Apologies, it is for the best!

spring-ai-spring-boot-autoconfigure/src/main/java/org/springframework/ai/autoconfigure/vectorstore/chroma/ChromaVectorStoreProperties.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2023 - 2024 the original author or authors.
2+
* Copyright 2023-2024 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -21,11 +21,12 @@
2121

2222
/**
2323
* @author Christian Tzolov
24+
* @author Soby Chacko
2425
*/
2526
@ConfigurationProperties(ChromaVectorStoreProperties.CONFIG_PREFIX)
2627
public class ChromaVectorStoreProperties extends CommonVectorStoreProperties {
2728

28-
public static final String CONFIG_PREFIX = "spring.ai.vectorstore.chroma.store";
29+
public static final String CONFIG_PREFIX = "spring.ai.vectorstore.chroma";
2930

3031
private String collectionName = ChromaVectorStore.DEFAULT_COLLECTION_NAME;
3132

spring-ai-spring-boot-autoconfigure/src/test/java/org/springframework/ai/autoconfigure/vectorstore/chroma/ChromaVectorStoreAutoConfigurationIT.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ public class ChromaVectorStoreAutoConfigurationIT {
5050
.withUserConfiguration(Config.class)
5151
.withPropertyValues("spring.ai.vectorstore.chroma.client.host=http://" + chroma.getHost(),
5252
"spring.ai.vectorstore.chroma.client.port=" + chroma.getMappedPort(8000),
53-
"spring.ai.vectorstore.chroma.store.collectionName=TestCollection");
53+
"spring.ai.vectorstore.chroma.collectionName=TestCollection");
5454

5555
@Test
5656
public void addAndSearchWithFilters() {

0 commit comments

Comments
 (0)