Skip to content

Neo4j module: Determine default embedding dimension from model. #2072

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 1 commit into from
Closed

Neo4j module: Determine default embedding dimension from model. #2072

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion ...springframework/ai/autoconfigure/vectorstore/neo4j/Neo4jVectorStoreAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,8 @@ public Neo4jVectorStore vectorStore(Driver driver, EmbeddingModel embeddingModel
.customObservationConvention(customObservationConvention.getIfAvailable(() -> null))
.batchingStrategy(batchingStrategy)
.databaseName(properties.getDatabaseName())
.embeddingDimension(properties.getEmbeddingDimension())
.embeddingDimension(properties.getEmbeddingDimension() != null ? properties.getEmbeddingDimension()
: embeddingModel.dimensions())
.distanceType(properties.getDistanceType())
.label(properties.getLabel())
.embeddingProperty(properties.getEmbeddingProperty())
Expand Down
4 changes: 2 additions & 2 deletions ...va/org/springframework/ai/autoconfigure/vectorstore/neo4j/Neo4jVectorStoreProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public class Neo4jVectorStoreProperties extends CommonVectorStoreProperties {

private String databaseName;

private int embeddingDimension = Neo4jVectorStore.DEFAULT_EMBEDDING_DIMENSION;
private Integer embeddingDimension;

private Neo4jVectorStore.Neo4jDistanceType distanceType = Neo4jVectorStore.Neo4jDistanceType.COSINE;

Expand All @@ -55,7 +55,7 @@ public void setDatabaseName(String databaseName) {
this.databaseName = databaseName;
}

public int getEmbeddingDimension() {
public Integer getEmbeddingDimension() {
return this.embeddingDimension;
}

Expand Down
7 changes: 4 additions & 3 deletions ...-neo4j-store/src/main/java/org/springframework/ai/vectorstore/neo4j/Neo4jVectorStore.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@
*/
public class Neo4jVectorStore extends AbstractObservationVectorStore implements InitializingBean {

@Deprecated(forRemoval = true)
public static final int DEFAULT_EMBEDDING_DIMENSION = 1536;

public static final int DEFAULT_TRANSACTION_SIZE = 10_000;
Expand Down Expand Up @@ -182,7 +183,7 @@ protected Neo4jVectorStore(Builder builder) {

this.driver = builder.driver;
this.sessionConfig = builder.sessionConfig;
this.embeddingDimension = builder.embeddingDimension;
this.embeddingDimension = builder.embeddingDimension.orElseGet(() -> builder.getEmbeddingModel().dimensions());
this.distanceType = builder.distanceType;
this.embeddingProperty = SchemaNames.sanitize(builder.embeddingProperty).orElseThrow();
this.label = SchemaNames.sanitize(builder.label).orElseThrow();
Expand Down Expand Up @@ -372,7 +373,7 @@ public static class Builder extends AbstractVectorStoreBuilder<Builder> {

private SessionConfig sessionConfig = SessionConfig.defaultConfig();

private int embeddingDimension = DEFAULT_EMBEDDING_DIMENSION;
private Optional<Integer> embeddingDimension = Optional.empty();

private Neo4jDistanceType distanceType = Neo4jDistanceType.COSINE;

Expand Down Expand Up @@ -425,7 +426,7 @@ public Builder sessionConfig(SessionConfig sessionConfig) {
*/
public Builder embeddingDimension(int dimension) {
Assert.isTrue(dimension >= 1, "Dimension has to be positive");
this.embeddingDimension = dimension;
this.embeddingDimension = Optional.of(dimension);
return this;
}

Expand Down
28 changes: 28 additions & 0 deletions ...eo4j-store/src/test/java/org/springframework/ai/vectorstore/neo4j/Neo4jVectorStoreIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import org.neo4j.driver.AuthTokens;
import org.neo4j.driver.Driver;
import org.neo4j.driver.GraphDatabase;
import org.springframework.context.annotation.Primary;
import org.testcontainers.containers.Neo4jContainer;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;
Expand Down Expand Up @@ -301,16 +302,43 @@ void ensureIdIndexGetsCreated() {
.isTrue());
}

@Test
void vectorIndexDimensionsDefaultAndOverwriteWorks() {
this.contextRunner.run(context -> {
var result = context.getBean(Driver.class)
.executableQuery(
"SHOW VECTOR INDEXES yield name, options return name, options['indexConfig']['vector.dimensions'] as dimensions")
.execute()
.records()
.stream()
.map(r -> r.get("name").asString() + r.get("dimensions").asInt())
.toList();
assertThat(result).containsExactlyInAnyOrder("secondIndex123", "spring-ai-document-index1536");
});
}

@SpringBootConfiguration
@EnableAutoConfiguration(exclude = { DataSourceAutoConfiguration.class })
public static class TestApplication {

@Bean
@Primary
public VectorStore vectorStore(Driver driver, EmbeddingModel embeddingModel) {

return Neo4jVectorStore.builder(driver, embeddingModel).initializeSchema(true).build();
}

@Bean
public VectorStore vectorStoreWithCustomDimension(Driver driver, EmbeddingModel embeddingModel) {

return Neo4jVectorStore.builder(driver, embeddingModel)
.initializeSchema(true)
.indexName("secondIndex")
.embeddingProperty("somethingElse")
.embeddingDimension(123)
.build();
}

@Bean
public Driver driver() {
return GraphDatabase.driver(neo4jContainer.getBoltUrl(),
Expand Down
Loading