Neo4j（开源）

Neo4j

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

Neo4j 是一款开源的 NoSQL 图数据库。 作为一个完全支持事务（ACID）的数据库，它以图的形式存储数据，这些图由节点组成，并通过关系相连。 其设计灵感源自现实世界的结构，使得在处理复杂数据时能够保持高效的查询性能，同时对开发者而言直观且易于上手。

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

先决条件

• 正在运行的 Neo4j（5.15+）实例。以下选项可供选择：
  • Docker 镜像
  • Neo4j 桌面客户端
  • Neo4j Aura
  • Neo4j Server 实例
• 如需要，可为 EmbeddingModel 提供 API 密钥，以生成由 Neo4jVectorStore 存储的嵌入。

自动配置

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

向量存储的实现可以为您初始化所需的架构，但您必须通过指定构造函数中的 initializeSchema 布尔值或在 application.properties 文件中设置...initialize-schema=true 来选择启用。

此外，您还需要一个配置好的 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.ai.vectorstore.neo4j.* 开头的属性用于配置 Neo4jVectorStore：

以下距离函数可供选择：

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

创建一个 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());

例如，这个可移植的过滤表达式：

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 特定功能和操作。