跳到主要内容
版本：2.0.1

MongoDB Atlas

QWen 3.8 中英对照 MongoDB Atlas

本节将指导您如何配置 MongoDB Atlas 作为向量存储，以便与 Spring AI 配合使用。

什么是 MongoDB Atlas？​

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

MongoDB Atlas 向量搜索 允许你将嵌入存储在 MongoDB 文档中，创建向量搜索索引，并使用近似最近邻算法（Hierarchical Navigable Small Worlds）执行 KNN 搜索。你可以使用 $vectorSearch 聚合操作符在 MongoDB 聚合阶段中对向量嵌入执行搜索。

先决条件​

  • 运行 MongoDB 版本 6.0.11、7.0.2 或更高版本的 Atlas 集群。如需开始使用 MongoDB Atlas，您可以按照 此处 的说明进行操作。请确保您的 IP 地址已包含在 Atlas 项目的 访问列表 中。

  • 一个已启用 Vector Search 的运行中的 MongoDB Atlas 实例

  • 已配置向量搜索索引的集合

  • 集合架构中包含 id（字符串）、content（字符串）、metadata（文档）和 embedding（向量）字段

  • 适当的索引和集合操作访问权限

自动配置​

备注

Spring AI 自动配置和 starter 模块的构件名称（artifact names）已发生重大变更。有关更多详细信息，请参阅升级说明。

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 添加到您的构建文件中。

提示

请参阅 Artifact Repositories 部分，以向您的构建文件中添加 Maven Central 和/或 Snapshot Repositories。

向量存储（Vector Store）实现可以为你初始化所需的模式（Schema），但你必须通过在 application.properties 文件中设置 spring.ai.vectorstore.mongodb.initialize-schema=true 来显式启用该功能。或者，你可以选择禁用自动初始化，并使用 MongoDB Atlas UI、Atlas 管理 API 或 Atlas CLI 手动创建索引，当索引需要高级映射或额外配置时，这种方式会非常有用。

备注

这是一项破坏性变更！在 Spring AI 的早期版本中，该 schema 初始化默认会执行。

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

此外，还需要一个已配置的 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")));

// Add the documents to MongoDB Atlas
vectorStore.add(documents);

// Retrieve documents similar to a query
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是否初始化所需的 schemafalse
spring.ai.vectorstore.mongodb.collection-name用于存储向量的 collection 名称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")           // Optional: defaults to "vector_store"
        .vectorIndexName("custom_vector_index")          // Optional: defaults to "vector_index"
        .pathName("custom_embedding")                    // Optional: defaults to "embedding"
        .numCandidates(500)                             // Optional: defaults to 200
        .metadataFieldsToFilter(List.of("author", "year")) // Optional: defaults to empty list
        .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());
}

元数据过滤​

你还可以在 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：

访问 Native Client​

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

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

if (nativeClient.isPresent()) {
    MongoClient client = nativeClient.get();
    // Use the native client for MongoDB-specific operations
}

原生客户端可让你访问 MongoDB 特有的功能和操作，而这些功能和操作可能不会通过 VectorStore 接口暴露。