跳到主要内容

Neo4j

DeepSeek V3 中英对照 Neo4j

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

Neo4j 是一个开源的 NoSQL 图数据库。它是一个完全事务性的数据库（ACID），将数据存储为由节点组成的图结构，节点之间通过关系连接。受现实世界结构的启发，它能够在复杂数据上实现高性能查询，同时对开发人员保持直观和简单。

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

先决条件​

自动配置​

Spring AI 为 Neo4j Vector Store 提供了 Spring Boot 自动配置。要启用它，请将以下依赖项添加到项目的 Maven pom.xml 文件中：

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-neo4j-store-spring-boot-starter</artifactId>
</dependency>
xml

或者添加到你的 Gradle build.gradle 构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-neo4j-store-spring-boot-starter'
}
groovy
提示

请参考 依赖管理 部分，将 Spring AI BOM 添加到你的构建文件中。

请查看向量存储的配置参数列表，以了解默认值和配置选项。

:::提示
请参考 Repositories 部分，将 Maven Central 和/或 Snapshot Repositories 添加到你的构建文件中。
:::

向量存储实现可以为你初始化所需的模式，但你必须通过在适当的构造函数中指定 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());
java

配置属性​

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

spring:
  data:
    neo4j:
      uri: bolt://localhost:7687
      authentication:
        username: neo4j
        password: password
yaml
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
        dimensions: 1536
        distance-type: cosine
        batching-strategy: TOKEN_COUNT # Optional: Controls how documents are batched for embedding
yaml

以 spring.neo4j.* 开头的 Spring Boot 属性用于配置 Neo4j 客户端：

属性描述默认值
spring.neo4j.uri用于连接到 Neo4j 实例的 URIneo4j://localhost:7687
spring.neo4j.authentication.username用于 Neo4j 认证的用户名neo4j
spring.neo4j.authentication.password用于 Neo4j 认证的密码-

以 spring.ai.vectorstore.neo4j.* 开头的属性用于配置 Neo4jVectorStore：

属性描述默认值
spring.ai.vectorstore.neo4j.initialize-schema是否初始化所需的 schemafalse
spring.ai.vectorstore.neo4j.database-name使用的 Neo4j 数据库名称neo4j
spring.ai.vectorstore.neo4j.index-name存储向量的索引名称spring-ai-document-index
spring.ai.vectorstore.neo4j.dimensions向量的维度数1536
spring.ai.vectorstore.neo4j.distance-type使用的距离函数cosine
spring.ai.vectorstore.neo4j.label用于文档节点的标签Document
spring.ai.vectorstore.neo4j.embedding-property用于存储嵌入的属性名称embedding
spring.ai.vectorstore.neo4j.batching-strategy计算嵌入时的文档批处理策略。选项为 TOKEN_COUNT 或 FIXED_SIZETOKEN_COUNT

以下距离函数可用：

  • cosine - 默认选项，适用于大多数用例。测量向量之间的余弦相似度。

  • euclidean - 向量之间的欧几里得距离。值越小表示相似度越高。

手动配置​

除了使用 Spring Boot 自动配置外，你还可以手动配置 Neo4j 向量存储。为此，你需要在项目中添加 spring-ai-neo4j-store 依赖：

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-neo4j-store</artifactId>
</dependency>
xml

或者到你的 Gradle build.gradle 构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-neo4j-store'
}
groovy
提示

请参考 依赖管理 部分，将 Spring AI BOM 添加到你的构建文件中。

创建一个 Neo4j Driver bean。有关自定义驱动程序的配置的更多详细信息，请阅读 Neo4j 文档。

@Bean
public Driver driver() {
    return GraphDatabase.driver("neo4j://<host>:<bolt-port>",
            AuthTokens.basic("<username>", "<password>"));
}
java

然后使用构建器模式创建 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
        .dimensions(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")));
}
java

元数据过滤​

你可以利用通用的、可移植的元数据过滤器与 Neo4j 存储一起使用。

例如，你可以使用文本表达式语言：

vectorStore.similaritySearch(
    SearchRequest.builder()
        .query("The World")
        .topK(TOP_K)
        .similarityThreshold(SIMILARITY_THRESHOLD)
        .filterExpression("author in ['john', 'jill'] && 'article_type' == 'blog'").build());
java

或者通过编程方式使用 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());
java
备注

这些（可移植的）过滤表达式会自动转换为 Neo4j 专有的 WHERE 过滤表达式。

例如，这个便携式过滤器表达式：

author in ['john', 'jill'] && 'article_type' == 'blog'
sql

被转换为专有的 Neo4j 过滤器格式：

node.`metadata.author` IN ["john","jill"] AND node.`metadata.'article_type'` = "blog"
text

访问 Native Client​

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

原生客户端使您能够访问可能未通过 VectorStore 接口公开的 Neo4j 特定功能和操作。