Spring/spring-ai
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Use the new vector index creation syntax for Neo4j.

Browse Source 
To make the Neo4j module more future-proof, this commit
replaces the old vector index creation syntax with the new style.
Also, the new pattern is in line with the standard Neo4j index creation
and supports the _IF NOT EXISTS_ clause to run idempotent.
This allows us to remove the preceding call to check if the index exists.

As a consequent, the module will require Neo4j to be at least on version 5.15.
This commit is contained in:
Gerrit Meier
2024-02-16 05:53:41 +01:00
committed by Christian Tzolov
parent 05ce9ff398
commit e62543c761
4 changed files with 18 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/neo4j.adoc
View File

@@ -13,7 +13,7 @@ Those indexes are powered by Lucene using a Hierarchical Navigable Small World G
== Prerequisites
* A running Neo4j (5.13+) instance. The following options are available:
* A running Neo4j (5.15+) instance. The following options are available:
** link:https://hub.docker.com/_/neo4j[Docker] image
** link:https://neo4j.com/download/[Neo4j Desktop]
** link:https://neo4j.com/cloud/aura-free/[Neo4j Aura]

4
spring-ai-spring-boot-autoconfigure/src/test/java/org/springframework/ai/autoconfigure/vectorstore/neo4j/Neo4jVectorStoreAutoConfigurationIT.java
View File

@@ -45,10 +45,10 @@ import static org.assertj.core.api.Assertions.assertThat;
@Testcontainers
public class Neo4jVectorStoreAutoConfigurationIT {
// Needs to be Neo4j 5.13+, because Neo4j 5.13 deprecated the used embedding storing
// Needs to be Neo4j 5.15+, because Neo4j 5.15 deprecated the used embedding storing
// function.
@Container
static Neo4jContainer<?> neo4jContainer = new Neo4jContainer<>(DockerImageName.parse("neo4j:5.14"))
static Neo4jContainer<?> neo4jContainer = new Neo4jContainer<>(DockerImageName.parse("neo4j:5.15"))
.withRandomPassword();
List<Document> documents = List.of(

29
vector-stores/spring-ai-neo4j-store/src/main/java/org/springframework/ai/vectorstore/Neo4jVectorStore.java
View File

@@ -311,26 +311,21 @@ public class Neo4jVectorStore implements VectorStore, InitializingBean {
try (var session = this.driver.session(this.config.sessionConfig)) {
session
.run("CREATE CONSTRAINT %s_unique_idx IF NOT EXISTS FOR (n:%s) REQUIRE n.id IS UNIQUE".formatted(
.run("CREATE CONSTRAINT %s IF NOT EXISTS FOR (n:%s) REQUIRE n.id IS UNIQUE".formatted(
SchemaNames.sanitize(this.config.label + "_unique_idx").orElseThrow(), this.config.quotedLabel))
.consume();
var vectorIndexExists = session
.run("SHOW INDEXES YIELD name WHERE name = $name RETURN count(*) > 0",
Map.of("name", this.config.indexName))
.single()
.get(0)
.asBoolean();
if (!vectorIndexExists) {
var statement = "CALL db.index.vector.createNodeIndex($indexName, $label, $embeddingProperty, $embeddingDimension, $distanceType)";
session.run(statement,
Map.of("indexName", this.config.indexName, "label", this.config.label, "embeddingProperty",
this.config.embeddingProperty, "embeddingDimension", this.config.embeddingDimension,
"distanceType", this.config.distanceType.name))
.consume();
session.run("CALL db.awaitIndexes()").consume();
}
var statement = """
CREATE VECTOR INDEX %s IF NOT EXISTS FOR (n:%s) ON (n.%s)
OPTIONS {indexConfig: {
`vector.dimensions`: %d,
`vector.similarity_function`: '%s'
}}
""".formatted(SchemaNames.sanitize(this.config.indexName, true).orElseThrow(),
this.config.quotedLabel, this.config.embeddingProperty, this.config.embeddingDimension,
this.config.distanceType.name);
session.run(statement).consume();
session.run("CALL db.awaitIndexes()").consume();
}
}

5
vector-stores/spring-ai-neo4j-store/src/test/java/org/springframework/ai/vectorstore/Neo4jVectorStoreIT.java
View File

@@ -39,10 +39,11 @@ import static org.assertj.core.api.Assertions.assertThat;
@EnabledIfEnvironmentVariable(named = "OPENAI_API_KEY", matches = ".+")
class Neo4jVectorStoreIT {
// Needs to be Neo4j 5.13+, because Neo4j 5.13 deprecated the used embedding storing
// Needs to be Neo4j 5.15+, because Neo4j 5.15 deprecated the old vector index
// creation
// function.
@Container
static Neo4jContainer<?> neo4jContainer = new Neo4jContainer<>(DockerImageName.parse("neo4j:5.14"))
static Neo4jContainer<?> neo4jContainer = new Neo4jContainer<>(DockerImageName.parse("neo4j:5.15"))
.withRandomPassword();
List<Document> documents = List.of(