Neo4j

本节将指导您如何设置 Neo4jVectorStore 来存储文档嵌入并执行相似性搜索。

Neo4j 是一个开源的 NoSQL 图数据库。 它是一个完全事务性的数据库（ACID），将数据存储为由节点和关系组成的图结构。 受现实世界结构的启发，它允许在复杂数据上进行高性能查询，同时对开发人员来说仍然直观且简单。

Neo4j 的向量搜索 允许用户从大型数据集中查询向量嵌入。 嵌入是数据对象（如文本、图像、音频或文档）的数值表示。 嵌入可以存储在 Node 属性上，并可以使用 db.index.vector.queryNodes() 函数进行查询。 这些索引由 Lucene 提供支持，使用分层可导航小世界图（HNSW）在向量字段上执行 k 近似最近邻（k-ANN）查询。

前提条件

自动配置

Spring AI 的自动配置和启动器模块的构件名称发生了重大变化。 请参阅 升级说明 了解更多信息。

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 Central 和/或 Snapshot 仓库添加到您的构建文件中。

向量存储实现可以为您初始化所需的模式，但您必须通过指定 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")));

// 将文档添加到 Neo4j
vectorStore.add(documents);

// 检索与查询相似的文档
List<Document> results = vectorStore.similaritySearch(SearchRequest.builder().query("Spring").topK(5).build());

配置属性

要连接到 Neo4j 并使用 Neo4jVectorStore，您需要提供实例的访问详细信息。 可以通过 Spring Boot 的 application.yml 提供简单配置：

spring:
  neo4j:
    uri: <neo4j 实例 URI>
    authentication:
      username: <neo4j 用户名>
      password: <neo4j 密码>
  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

是否初始化所需的模式

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

以下距离函数可用：

  • 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")                // 可选：默认为 "neo4j"
        .distanceType(Neo4jDistanceType.COSINE) // 可选：默认为 COSINE
        .embeddingDimension(1536)                      // 可选：默认为 1536
        .label("Document")                     // 可选：默认为 "Document"
        .embeddingProperty("embedding")        // 可选：默认为 "embedding"
        .indexName("custom-index")             // 可选：默认为 "spring-ai-document-index"
        .initializeSchema(true)                // 可选：默认为 false
        .batchingStrategy(new TokenCountBatchingStrategy()) // 可选：默认为 TokenCountBatchingStrategy
        .build();
}

// 这可以是任何 EmbeddingModel 实现
@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"

访问原生客户端

Neo4j 向量存储实现通过 getNativeClient() 方法提供对底层原生 Neo4j 客户端（Driver）的访问：

Neo4jVectorStore vectorStore = context.getBean(Neo4jVectorStore.class);
Optional<Driver> nativeClient = vectorStore.getNativeClient();

if (nativeClient.isPresent()) {
    Driver driver = nativeClient.get();
    // 使用原生客户端进行 Neo4j 特定的操作
}

原生客户端让您可以访问可能未通过 VectorStore 接口暴露的 Neo4j 特定功能和操作。