Neo4j
本节将指导您配置 Neo4jVectorStore,以存储文档嵌入并执行相似度搜索。
Neo4j 是一款开源的 NoSQL 图数据库。它是一个完全支持事务(ACID)的数据库,存储的数据结构为由节点和关系连接而成的图。受现实世界结构的启发,它在处理复杂数据时能够提供高查询性能,同时对开发者而言既直观又简单。
Neo4j 的向量搜索 允许用户从大规模数据集中查询向量嵌入。嵌入是数据对象(如文本、图像、音频或文档)的数值表示形式。嵌入可以存储在 Node 属性中,并可使用 db.index.vector.queryNodes() 函数进行查询。这些索引基于 Lucene,并使用分层可导航小世界图(HNSW)对向量字段执行 k 近似最近邻(k-ANN)查询。
先决条件
-
正在运行的 Neo4j(5.15+)实例。可用选项包括:
-
如需要,一个用于 EmbeddingModel 生成由
Neo4jVectorStore存储的 embeddings 的 API key。
自动配置
Spring AI 的自动配置和 starter 模块的构件名称发生了重大变更。更多信息请参阅 升级说明。
Spring AI 为 Neo4j 向量存储提供了 Spring Boot 自动配置。要启用它,请将以下依赖项添加到项目的 Maven pom.xml 文件中:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-vector-store-neo4j</artifactId>
</dependency>
或在 Gradle 的 build.gradle 构建文件中。
dependencies {
implementation 'org.springframework.ai:spring-ai-starter-vector-store-neo4j'
}
请参考 依赖管理 章节,将 Spring AI BOM 添加到你的构建文件中。
请查看向量存储器的配置属性列表,以了解默认值和配置选项。
请参见 Artifact Repositories 部分,将 Maven Central 和/或 Snapshot 仓库添加到您的构建文件中。
向量存储实现可以为您初始化所需的模式,但您需要选择启用该功能:通过在合适的构造函数中指定 initializeSchema 布尔值,或在 application.properties 文件中设置 …initialize-schema=true。
这是一个破坏性变更!在 Spring AI 的早期版本中,此 schema 初始化操作默认会执行。
此外,你需要一个已配置的 EmbeddingModel Bean。有关更多信息,请参阅 EmbeddingModel 部分。
现在你可以在应用中自动装配 Neo4jVectorStore 作为向量存储。
@Autowired VectorStore vectorStore;
// ...
List<Document> documents = List.of(
new Document("Spring AI rocks!! Spring AI rocks!! Spring AI rocks!! Spring AI rocks!! Spring AI rocks!!", Map.of("meta1", "meta1")),
new Document("The World is Big and Salvation Lurks Around the Corner"),
new Document("You walk forward facing the past and you turn back toward the future.", Map.of("meta2", "meta2")));
// Add the documents to Neo4j
vectorStore.add(documents);
// Retrieve documents similar to a query
List<Document> results = vectorStore.similaritySearch(SearchRequest.builder().query("Spring").topK(5).build());
配置属性
要连接到 Neo4j 并使用 Neo4jVectorStore,您需要提供实例的访问信息。可以通过 Spring Boot 的 application.yml 提供简单的配置:
spring:
neo4j:
uri: <neo4j instance URI>
authentication:
username: <neo4j username>
password: <neo4j password>
ai:
vectorstore:
neo4j:
initialize-schema: true
database-name: neo4j
index-name: custom-index
embedding-dimension: 1536
distance-type: cosine
以 spring.neo4j.* 开头的 Spring Boot 属性用于配置 Neo4j 客户端:
| 属性 | 描述 | 默认值 |
|---|---|---|
spring.neo4j.uri | 用于连接 Neo4j 实例的 URI | neo4j://localhost:7687 |
spring.neo4j.authentication.username | 用于 Neo4j 身份验证的用户名 | neo4j |
spring.neo4j.authentication.password | 用于 Neo4j 身份验证的密码 | - |
以 spring.ai.vectorstore.neo4j.* 开头的属性用于配置 Neo4jVectorStore:
| 属性 | 描述 | 默认值 |
|---|---|---|
spring.ai.vectorstore.neo4j.initialize-schema | 是否初始化所需的 schema | false |
spring.ai.vectorstore.neo4j.database-name | 要使用的 Neo4j 数据库名称 | neo4j |
spring.ai.vectorstore.neo4j.index-name | 用于存储向量的索引名称 | spring-ai-document-index |
spring.ai.vectorstore.neo4j.embedding-dimension | 向量的维度数 | 1536 |
spring.ai.vectorstore.neo4j.distance-type | 使用的距离函数 | cosine |
spring.ai.vectorstore.neo4j.label | 文档节点使用的标签 | Document |
spring.ai.vectorstore.neo4j.embedding-property | 用于存储 embedding 的属性名 | embedding |
以下距离函数可用:
cosine- 默认值,适用于大多数使用场景。衡量向量之间的余弦相似度。euclidean- 向量之间的欧氏距离。值越低表示相似度越高。
手动配置
与其使用 Spring Boot 自动配置,您可以手动配置 Neo4j 向量存储。为此,您需要将 spring-ai-neo4j-store 添加到项目中:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-neo4j-store</artifactId>
</dependency>
或添加到 Gradle 的 build.gradle 构建文件中。
dependencies {
implementation 'org.springframework.ai:spring-ai-neo4j-store'
}
请参阅 Dependency Management 章节,将 Spring AI BOM 添加到构建文件中。
创建 Neo4j Driver bean。有关自定义 Driver 配置的更深入信息,请阅读 Neo4j 文档。
@Bean
public Driver driver() {
return GraphDatabase.driver("neo4j://<host>:<bolt-port>",
AuthTokens.basic("<username>", "<password>"));
}
然后使用建造者模式创建 Neo4jVectorStore Bean:
@Bean
public VectorStore vectorStore(Driver driver, EmbeddingModel embeddingModel) {
return Neo4jVectorStore.builder(driver, embeddingModel)
.databaseName("neo4j") // Optional: defaults to "neo4j"
.distanceType(Neo4jDistanceType.COSINE) // Optional: defaults to COSINE
.embeddingDimension(1536) // Optional: defaults to 1536
.label("Document") // Optional: defaults to "Document"
.embeddingProperty("embedding") // Optional: defaults to "embedding"
.indexName("custom-index") // Optional: defaults to "spring-ai-document-index"
.initializeSchema(true) // Optional: defaults to false
.batchingStrategy(new TokenCountBatchingStrategy()) // Optional: defaults to TokenCountBatchingStrategy
.build();
}
// This can be any EmbeddingModel implementation
@Bean
public EmbeddingModel embeddingModel() {
return new OpenAiEmbeddingModel(OpenAiEmbeddingOptions.builder().apiKey(System.getenv("OPENAI_API_KEY")).build());
}
元数据筛选
您还可以在 Neo4j 存储中利用通用的、可移植的元数据过滤器。
例如,你可以使用文本表达式语言:
vectorStore.similaritySearch(
SearchRequest.builder()
.query("The World")
.topK(TOP_K)
.similarityThreshold(SIMILARITY_THRESHOLD)
.filterExpression("author in ['john', 'jill'] && 'article_type' == 'blog'").build());
或通过使用 Filter.Expression DSL 以编程方式实现:
FilterExpressionBuilder b = new FilterExpressionBuilder();
vectorStore.similaritySearch(SearchRequest.builder()
.query("The World")
.topK(TOP_K)
.similarityThreshold(SIMILARITY_THRESHOLD)
.filterExpression(b.and(
b.in("author", "john", "jill"),
b.eq("article_type", "blog")).build()).build());
这些(可移植的)过滤表达式会自动转换为 Neo4j 专有的 WHERE 过滤表达式。
例如,以下可移植过滤表达式:
author in ['john', 'jill'] && 'article_type' == 'blog'
is converted into the proprietary Neo4j filter format:
node.`metadata.author` IN ["john","jill"] AND node.`metadata.'article_type'` = "blog"
访问原生客户端
Neo4j Vector Store 实现通过 getNativeClient() 方法提供了对底层原生 Neo4j 客户端(Driver)的访问:
Neo4jVectorStore vectorStore = context.getBean(Neo4jVectorStore.class);
Optional<Driver> nativeClient = vectorStore.getNativeClient();
if (nativeClient.isPresent()) {
Driver driver = nativeClient.get();
// Use the native client for Neo4j-specific operations
}
原生客户端使您可以访问 VectorStore 接口可能未暴露的 Neo4j 特定功能和操作。