|
此版本仍在开发中，尚未被视为稳定版。如需最新的快照版本，请使用 Spring AI 1.1.3！ |
Neo4J
本节将指导您设置 Neo4jVectorStore 以存储文档嵌入并执行相似性搜索。
Neo4j 是一个开源的 NoSQL 图形数据库。 它是一个完全事务性的数据库（ACID），以由节点和关系连接组成的图形结构存储数据。 受现实世界结构的启发，它在复杂数据上提供高查询性能，同时对开发者来说保持直观和简单。
Neo4j 的向量搜索 允许用户从大型数据集中查询向量嵌入。
嵌入是数据对象的数值表示，例如文本、图像、音频或文档。
嵌入可以存储在 节点 属性上，并可以使用 db.index.vector.queryNodes() 函数进行查询。
这些索引由 Lucene 提供支持，使用分层导航小世界图（HNSW）在向量字段上执行 k 近似最近邻（k-ANN）查询。
前置条件
-
一个运行中的 Neo4j (5.15+) 实例。有以下选项可用：
-
如果需要，为EmbeddingModel提供一个API密钥，用于生成由
Neo4jVectorStore存储的嵌入向量。
Auto-configuration
|
Spring AI自动配置和starter模块的artifact名称有了重大变化。 请参阅升级说明获取更多信息。 |
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添加到您的构建文件中。 |
请查看 向量存储的配置属性 列表，以了解默认值和配置选项。
| 请参阅 构件仓库 部分，将 Maven 中央仓库和/或快照仓库添加到您的构建文件中。 |
向量存储实现可以为您初始化所需的架构，但您必须通过在适当的构造函数中指定 initializeSchema 布尔值或在 application.properties 文件中设置 …initialize-schema=true 来选择加入。
| 这是一个破坏性变更！在早期版本的 Spring AI 中，此架构初始化是默认发生的。 |
此外，您还需要一个已配置的 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 客户端：
| <property> </property> | <description> </description> | 默认值 |
|---|---|---|
|
用于连接到 Neo4j 实例的 URI |
|
|
用于通过 Neo4j 进行身份验证的用户名 |
|
|
用于与 Neo4j 进行身份验证的密码 |
- |
以 spring.ai.vectorstore.neo4j.* 开头的属性用于配置 Neo4jVectorStore：
| <property> </property> | <description> </description> | 默认值 |
|---|---|---|
|
是否初始化所需的模式 |
|
|
要使用的 Neo4j 数据库的名称 |
|
|
用于存储向量的索引名称 |
|
|
向量中的维度数量 |
|
|
要使用的距离函数 |
|
|
用于文档节点的标签 |
|
|
用于存储嵌入的属性名称 |
|
以下距离函数可用：
-
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'
}| 请参阅依赖管理部分，将Spring AI BOM添加到您的构建文件中。 |
创建一个 Neo4j Driver bean。
阅读 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(new OpenAiApi(System.getenv("OPENAI_API_KEY")));
}元数据过滤
您也可以在 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'转换为专有的 Neo4j 过滤器格式：
node.`metadata.author` IN ["john","jill"] AND node.`metadata.'article_type'` = "blog"访问原生客户端
The 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 特定功能和操作。