Neo4j

本节引导你设置 Neo4jVectorStore 以存储文档嵌入并执行相似度搜索。

Neo4j 是一个开源的 NoSQL 图数据库。 它是一个完全事务型（ACID）的数据库，把数据存储为由节点以及连接它们的 relationships 构成的图。 它受真实世界结构的启发，在处理复杂数据时既保持高查询性能，又对开发者保持直观简洁。

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

前置条件

• 一个正在运行的 Neo4j（5.15+）实例。有以下可选方案：
  • Docker 镜像
  • Neo4j Desktop
  • Neo4j Aura
  • Neo4j Server 实例
• 如有需要，为 EmbeddingModel 配置一个 API 密钥，以生成 Neo4jVectorStore 所存储的嵌入。

自动配置

NOTE

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'
}

TIP

参见 依赖管理 一节，把 Spring AI BOM 添加到你的构建文件。

请查看该向量库的 配置属性 列表，了解默认值和配置选项。

TIP

参见 制品仓库 一节，把 Maven Central 和/或 Snapshot 仓库添加到你的构建文件。

向量库实现可以为你初始化所需的模式，但你必须显式开启——在相应的构造器中指定 initializeSchema 布尔值，或在 application.properties 文件中设置 ...initialize-schema=true。

NOTE

这是一处破坏性变更！在较早的 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 客户端：

属性	描述	默认值
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'
}

TIP

参见 依赖管理 一节，把 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());

NOTE

这些（可移植的）过滤表达式会被自动转换为 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();
    // Use the native client for Neo4j-specific operations
}

原生客户端让你得以访问那些可能未通过 VectorStore 接口暴露的 Neo4j 特定功能与操作。