Neo4j

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

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

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

先决条件

自动配置

Spring AI 自动配置、starter 模块的 artifact 名称发生了重大变化。请参阅升级注意事项以获取更多信息。

Spring AI 为 Neo4j Vector Store 提供了 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 添加到您的构建文件中。

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

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

向量存储实现可以为您初始化所需的 schema，但您必须通过在相应的构造函数中指定 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
        dimensions: 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.dimensions

向量的维度数量

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")                // 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")));
}

元数据过滤

您也可以在 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 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
}

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