MariaDB（开源）

MariaDB Vector Store

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

MariaDB Vector 作为 MariaDB 11.7 的一部分，支持存储和搜索由机器学习生成的嵌入向量。它利用向量索引提供了高效的最近邻搜索功能，同时支持余弦距离和欧几里得度量两种计算方式。

先决条件

• 正在运行的 MariaDB（11.7 及以上版本）实例。以下选项可供选择：
  • Docker 镜像
  • MariaDB 服务器
  • MariaDB SkySQL
• 如有需要，可为 EmbeddingModel 提供 API 密钥，以生成由 MariaDBVectorStore 存储的嵌入向量。

自动配置

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>

请参阅 Artifact Repositories 部分，将 Maven 中央仓库和 / 或快照仓库添加到您的构建文件中。

现在，您可以在应用程序中自动装配 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 以 Spring Boot 开发服务的形式运行 MariaDB Vector，则无需配置 URL、用户名和密码，因为这些信息将由 Spring Boot 自动配置。

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

若您配置了自定义模式及 / 或表名，建议通过设置 ‘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)                      // 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 向量存储。

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

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();
    // Use the native client for MariaDB-specific operations
}

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