MariaDB 向量存储

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

MariaDB Vector 是 MariaDB 11.7 的一部分，支持存储和搜索机器学习生成的嵌入。 它使用向量索引提供高效的向量相似性搜索功能，支持余弦相似度和欧几里得距离度量。

前提条件

自动配置

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

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

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

// 检索与查询相似的文档
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

提示：如果您配置了自定义模式和/或表名，请考虑通过设置 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：

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

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

元数据过滤

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

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

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 向量存储实现通过 getNativeClient() 方法提供对底层原生 JDBC 客户端（JdbcTemplate）的访问：

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

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

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