MongoDB Atlas

本节将指导您如何设置 MongoDB Atlas 作为向量存储以与 Spring AI 一起使用。

什么是 MongoDB Atlas？

MongoDB Atlas 是 MongoDB 提供的完全托管的云数据库，可在 AWS、Azure 和 GCP 中使用。 Atlas 支持对 MongoDB 文档数据进行原生向量搜索和全文搜索。

MongoDB Atlas Vector Search 允许您在 MongoDB 文档中存储嵌入，创建向量搜索索引，并使用近似最近邻算法（分层可导航小世界）执行 KNN 搜索。您可以在 MongoDB 聚合阶段中使用 $vectorSearch 聚合运算符对向量嵌入执行搜索。

前提条件

运行 MongoDB 6.0.11、7.0.2 或更高版本的 Atlas 集群。要开始使用 MongoDB Atlas，您可以按照这里的说明进行操作。确保您的 IP 地址已包含在 Atlas 项目的访问列表中。
启用了向量搜索的运行中的 MongoDB Atlas 实例
配置了向量搜索索引的集合
具有 id（字符串）、content（字符串）、metadata（文档）和 embedding（向量）字段的集合模式
适当的索引和集合操作访问权限

自动配置

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

Spring AI 为 MongoDB Atlas 向量存储提供了 Spring Boot 自动配置。要启用它，请在项目的 Maven pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-starter-vector-store-mongodb-atlas</artifactId>
</dependency>

或添加到 Gradle build.gradle 构建文件中：

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-vector-store-mongodb-atlas'
}

提示：请参阅依赖管理部分，将 Spring AI BOM 添加到您的构建文件中。

提示：请参阅构件仓库部分，将 Maven Central 和/或 Snapshot 仓库添加到您的构建文件中。

向量存储实现可以为您初始化所需的模式，但您必须通过在 application.properties 文件中设置 spring.ai.vectorstore.mongodb.initialize-schema=true 来选择加入。或者，您可以选择退出初始化，并使用 MongoDB Atlas UI、Atlas Administration API 或 Atlas CLI 手动创建索引，这在索引需要高级映射或额外配置时很有用。

注意：这是一个破坏性更改！在 Spring AI 的早期版本中，这种模式初始化是默认发生的。

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

此外，您还需要一个配置好的 EmbeddingModel bean。请参阅 EmbeddingModel 部分了解更多信息。

现在您可以在应用程序中自动装配 MongoDBAtlasVectorStore 作为向量存储：

@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")));

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

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

配置属性

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

spring:
  data:
    mongodb:
      uri: <mongodb atlas connection string>
      database: <database name>
  ai:
    vectorstore:
      mongodb:
        initialize-schema: true
        collection-name: custom_vector_store
        index-name: custom_vector_index
        path-name: custom_embedding
        metadata-fields-to-filter: author,year

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

属性描述默认值

属性	描述	默认值
`spring.ai.vectorstore.mongodb.initialize-schema`	是否初始化所需的模式	`false`
`spring.ai.vectorstore.mongodb.collection-name`	存储向量的集合名称	`vector_store`
`spring.ai.vectorstore.mongodb.index-name`	向量搜索索引的名称	`vector_index`
`spring.ai.vectorstore.mongodb.path-name`	存储向量的路径	`embedding`
`spring.ai.vectorstore.mongodb.metadata-fields-to-filter`	可用于过滤的元数据字段的逗号分隔列表	空列表

spring.ai.vectorstore.mongodb.initialize-schema

是否初始化所需的模式

false

spring.ai.vectorstore.mongodb.collection-name

存储向量的集合名称

vector_store

spring.ai.vectorstore.mongodb.index-name

向量搜索索引的名称

vector_index

spring.ai.vectorstore.mongodb.path-name

存储向量的路径

embedding

spring.ai.vectorstore.mongodb.metadata-fields-to-filter

可用于过滤的元数据字段的逗号分隔列表

空列表

手动配置

除了使用 Spring Boot 自动配置外，您还可以手动配置 MongoDB Atlas 向量存储。为此，您需要在项目中添加 spring-ai-mongodb-atlas-store：

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-mongodb-atlas-store</artifactId>
</dependency>

或添加到 Gradle build.gradle 构建文件中：

dependencies {
    implementation 'org.springframework.ai:spring-ai-mongodb-atlas-store'
}

创建 MongoTemplate bean：

@Bean
public MongoTemplate mongoTemplate() {
    return new MongoTemplate(MongoClients.create("<mongodb atlas connection string>"), "<database name>");
}

然后使用构建器模式创建 MongoDBAtlasVectorStore bean：

@Bean
public VectorStore vectorStore(MongoTemplate mongoTemplate, EmbeddingModel embeddingModel) {
    return MongoDBAtlasVectorStore.builder(mongoTemplate, embeddingModel)
        .collectionName("custom_vector_store")           // 可选：默认为 "vector_store"
        .vectorIndexName("custom_vector_index")          // 可选：默认为 "vector_index"
        .pathName("custom_embedding")                    // 可选：默认为 "embedding"
        .numCandidates(500)                             // 可选：默认为 200
        .metadataFieldsToFilter(List.of("author", "year")) // 可选：默认为空列表
        .initializeSchema(true)                         // 可选：默认为 false
        .batchingStrategy(new TokenCountBatchingStrategy()) // 可选：默认为 TokenCountBatchingStrategy
        .build();
}

// 这可以是任何 EmbeddingModel 实现
@Bean
public EmbeddingModel embeddingModel() {
    return new OpenAiEmbeddingModel(new OpenAiApi(System.getenv("OPENAI_API_KEY")));
}

元数据过滤

您也可以利用通用的、可移植的元数据过滤器与 MongoDB Atlas。

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

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

或使用 Filter.Expression DSL 以编程方式：

FilterExpressionBuilder b = new FilterExpressionBuilder();

vectorStore.similaritySearch(SearchRequest.builder()
        .query("The World")
        .topK(5)
        .similarityThreshold(0.7)
        .filterExpression(b.and(
                b.in("author", "john", "jill"),
                b.eq("article_type", "blog")).build()).build());

注意：这些（可移植的）过滤器表达式会自动转换为专有的 MongoDB Atlas 过滤器表达式。

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

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

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

{
  "$and": [
    {
      "$or": [
        { "metadata.author": "john" },
        { "metadata.author": "jill" }
      ]
    },
    {
      "metadata.article_type": "blog"
    }
  ]
}

教程和代码示例

要开始使用 Spring AI 和 MongoDB：

查看 Spring AI 集成入门指南。
有关使用 Spring AI 和 MongoDB 演示检索增强生成（RAG）的完整代码示例，请参阅这个详细教程。

访问原生客户端

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

MongoDBAtlasVectorStore vectorStore = context.getBean(MongoDBAtlasVectorStore.class);
Optional<MongoClient> nativeClient = vectorStore.getNativeClient();

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

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