MariaDB Vector Store

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

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

先决条件

自动配置

Spring AI 自动配置、starter 模块的 artifact 名称发生了重大变化。请参阅升级注意事项了解更多信息。

Spring AI 为 MariaDB Vector Store 提供了 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 添加到您的构建文件。

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

这是一项破坏性变更！在早期版本的 Spring AI 中，此 schema 初始化是默认发生的。

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

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

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-starter-model-openai</artifactId>
</dependency>
请参考Repositories部分将 Maven Central 和/或 Snapshot Repositories 添加到您的构建文件。

现在您可以在您的应用程序中自动注入 (auto-wire) 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

是否初始化所需的 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

向量存储 schema 名称

null

spring.ai.vectorstore.mariadb.table-name

向量存储表名称

vector_store

spring.ai.vectorstore.mariadb.schema-validation

启用 schema 和表名称验证，以确保它们是有效且存在的对象。

false
如果您配置了自定义 schema 和/或表名，请考虑通过设置 spring.ai.vectorstore.mariadb.schema-validation=true 来启用 schema 验证。这可以确保名称的正确性并降低 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 添加到您的构建文件。

然后使用 builder 模式创建 MariaDBVectorStore bean

@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 store 使用。

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

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 path 表达式。

访问原生客户端

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
}

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