跳到主要内容

MongoDB Atlas

DeepSeek V3 中英对照 MongoDB Atlas

本节将引导你设置 MongoDB Atlas 作为与 Spring AI 一起使用的向量存储。

什么是 MongoDB Atlas？​

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

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

先决条件​

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

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

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

  • 包含 id（字符串）、content（字符串）、metadata（文档）和 embedding（向量）字段的集合模式

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

自动配置​

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

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

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

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

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

提示

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

向量存储实现可以为你初始化必要的模式，但你必须通过在 application.properties 文件中设置 spring.ai.vectorstore.mongodb.initialize-schema=true 来选择启用。或者，你可以选择不进行初始化，并使用 MongoDB Atlas UI、Atlas 管理 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")));

// 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());
java

配置属性​

要连接到 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
        vector-index-name: custom_vector_index
        path-name: custom_embedding
        metadata-fields-to-filter: author,year
yaml

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

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

手动配置​

你可以手动配置 MongoDB Atlas 向量存储，而不使用 Spring Boot 的自动配置。为此，你需要在项目中添加 spring-ai-mongodb-atlas-store 依赖：

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

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

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

创建一个 MongoTemplate bean：

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

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

元数据过滤​

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

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

vectorStore.similaritySearch(SearchRequest.builder()
        .query("The World")
        .topK(5)
        .similarityThreshold(0.7)
        .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(5)
        .similarityThreshold(0.7)
        .filterExpression(b.and(
                b.in("author", "john", "jill"),
                b.eq("article_type", "blog")).build()).build());
java
备注

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

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

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

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

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

教程和代码示例​

要开始使用 Spring AI 和 MongoDB：

访问原生客户端​

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

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