MariaDB 向量存储

Deepseek 3.2 中英对照 MariaDB Vector Store

本节将指导您如何设置 MariaDBVectorStore，以存储文档嵌入向量并执行相似性搜索。

MariaDB Vector 是 MariaDB 11.7 的一部分，支持存储和搜索由机器学习生成的嵌入向量。它利用向量索引提供高效的向量相似性搜索能力，支持余弦相似度和欧氏距离两种度量方式。

前提条件

• 一个正在运行的 MariaDB (11.7+) 实例。以下选项可用：

  • Docker 镜像

  • MariaDB 服务器

  • MariaDB SkySQL

• 如果需要，需要一个用于 EmbeddingModel 的 API 密钥，以生成由 MariaDBVectorStore 存储的嵌入向量。

自动配置

备注

Spring AI 的自动配置和 starter 模块的 artifact 名称发生了重大变化。更多信息请参考升级说明。

Spring AI为MariaDB向量存储提供了Spring Boot自动配置。要启用此功能，请将以下依赖项添加到项目的Maven pom.xml文件中：

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

或添加到你的Gradle build.gradle 构建文件中。

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

提示

请参考依赖管理章节，将 Spring AI BOM 添加到您的构建文件中。

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

备注

这是一个破坏性变更！在 Spring AI 的早期版本中，此模式初始化默认是开启的。

此外，你需要配置一个 EmbeddingModel bean。更多信息，请参考 EmbeddingModel 章节。

例如，要使用 OpenAI EmbeddingModel，请添加以下依赖项：

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-starter-model-openai</artifactId>
</dependency>

:::提示
请参考制品库章节，将 Maven Central 和/或 Snapshot 仓库添加到您的构建文件中。
:::

现在你可以在应用程序中自动装配 MariaDBVectorStore：

@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 MariaDB
vectorStore.add(documents);

// Retrieve documents similar to a query
List<Document> results = vectorStore.similaritySearch(SearchRequest.builder().query("Spring").topK(5).build());

配置属性

要连接到 MariaDB 并使用 MariaDBVectorStore，你需要提供实例的访问信息。可以通过 Spring Boot 的 application.yml 文件提供一个简单的配置：

spring:
  datasource:
    url: jdbc:mariadb://localhost/db
    username: myUser
    password: myPassword
  ai:
    vectorstore:
      mariadb:
        initialize-schema: true
        distance-type: COSINE
        dimensions: 1536

提示

如果你通过 Docker Compose 或 Testcontainers 将 MariaDB Vector 作为 Spring Boot 开发服务运行，则无需配置 URL、用户名和密码，因为它们已由 Spring Boot 自动配置。

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

属性	描述	默认值
spring.ai.vectorstore.mariadb.initialize-schema	是否初始化所需的数据库架构	false
spring.ai.vectorstore.mariadb.distance-type	搜索距离类型。使用 COSINE（默认）或 EUCLIDEAN。如果向量已归一化为长度 1，使用 EUCLIDEAN 可获得最佳性能。	COSINE
spring.ai.vectorstore.mariadb.dimensions	嵌入向量的维度。如果未明确指定，将从提供的 EmbeddingModel 中检索维度。	1536
spring.ai.vectorstore.mariadb.remove-existing-vector-store-table	启动时是否删除现有的向量存储表。	false
spring.ai.vectorstore.mariadb.schema-name	向量存储的数据库架构名称	null
spring.ai.vectorstore.mariadb.table-name	向量存储的表名称	vector_store
spring.ai.vectorstore.mariadb.schema-validation	启用对数据库架构和表名称的验证，以确保它们是有效且已存在的对象。	false

:::提示
如果您配置了自定义模式（schema）和/或表名，建议通过设置 spring.ai.vectorstore.mariadb.schema-validation=true 来启用模式验证。这可以确保名称的正确性并降低 SQL 注入攻击的风险。
:::

手动配置

除了使用 Spring Boot 的自动配置，你也可以手动配置 MariaDB 向量存储。为此，你需要在项目中添加以下依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>

<dependency>
    <groupId>org.mariadb.jdbc</groupId>
    <artifactId>mariadb-java-client</artifactId>
    <scope>runtime</scope>
</dependency>

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

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

然后使用构建器模式创建 MariaDBVectorStore 实例：

@Bean
public VectorStore vectorStore(JdbcTemplate jdbcTemplate, EmbeddingModel embeddingModel) {
    return MariaDBVectorStore.builder(jdbcTemplate, embeddingModel)
        .dimensions(1536)                      // Optional: defaults to 1536
        .distanceType(MariaDBDistanceType.COSINE) // Optional: defaults to COSINE
        .schemaName("mydb")                    // Optional: defaults to null
        .vectorTableName("custom_vectors")     // Optional: defaults to "vector_store"
        .contentFieldName("text")             // Optional: defaults to "content"
        .embeddingFieldName("embedding")      // Optional: defaults to "embedding"
        .idFieldName("doc_id")                // Optional: defaults to "id"
        .metadataFieldName("meta")           // Optional: defaults to "metadata"
        .initializeSchema(true)               // Optional: defaults to false
        .schemaValidation(true)              // Optional: defaults to false
        .removeExistingVectorStoreTable(false) // Optional: defaults to false
        .maxDocumentBatchSize(10000)         // Optional: defaults to 10000
        .build();
}

// This can be any EmbeddingModel implementation
@Bean
public EmbeddingModel embeddingModel() {
    return new OpenAiEmbeddingModel(new OpenAiApi(System.getenv("OPENAI_API_KEY")));
}

元数据过滤

你可以利用通用的、可移植的元数据过滤器与 MariaDB Vector 存储。

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

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

备注

这些筛选表达式会自动转换为等效的 MariaDB JSON 路径表达式。

相似度分数

MariaDB Vector Store 会自动计算相似性搜索返回文档的相似度分数。这些分数提供了一个标准化的衡量指标，用以评估每个文档与您的搜索查询的匹配程度。

分数计算

相似度分数使用公式 score = 1.0 - distance 计算，其中：

• 分数：一个介于 0.0 和 1.0 之间的值，其中 1.0 表示完全相似，0.0 表示完全不相似
• 距离：使用配置的距离类型（COSINE 或 EUCLIDEAN）计算出的原始距离值

这意味着文档之间的距离越小（越相似），其得分就越高，从而使结果更直观易懂。

访问分数

您可以通过 getScore() 方法获取每个文档的相似度得分：

List<Document> results = vectorStore.similaritySearch(
    SearchRequest.builder()
        .query("Spring AI")
        .topK(5)
        .build());

for (Document doc : results) {
    double score = doc.getScore();  // Value between 0.0 and 1.0
    System.out.println("Document: " + doc.getText());
    System.out.println("Similarity Score: " + score);
}

搜索结果排序

搜索结果会自动按照相似度分数降序排列（最高分优先）。这确保了最相关的文档出现在您结果列表的顶部。

距离元数据

除了相似度得分外，文档元数据中仍可获取原始距离值：

for (Document doc : results) {
    double score = doc.getScore();
    float distance = (Float) doc.getMetadata().get("distance");

    System.out.println("Score: " + score + ", Distance: " + distance);
}

相似度阈值

在搜索请求中使用相似度阈值时，请将阈值指定为分值（0.0 到 1.0），而非距离：

List<Document> results = vectorStore.similaritySearch(
    SearchRequest.builder()
        .query("Spring AI")
        .topK(10)
        .similarityThreshold(0.8)  // Only return documents with score >= 0.8
        .build());

这使得阈值设定变得一致且直观——更高的数值意味着更严格的搜索，仅返回高度相似的文档。

访问原生客户端

MariaDB Vector Store 实现通过 getNativeClient() 方法提供对底层原生 JDBC 客户端 (JdbcTemplate) 的访问：

MariaDBVectorStore vectorStore = context.getBean(MariaDBVectorStore.class);
Optional<JdbcTemplate> nativeClient = vectorStore.getNativeClient();

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

原生客户端让你能够访问特定于MariaDB的功能和操作，这些可能不会通过VectorStore接口暴露出来。