12.4 MariaDB 向量存储

吴祖贤
5 阅读5分钟

MariaDB 向量存储

概述

本节将指导您完成设置 MariaDBVectorStore 来存储文档嵌入并使用 MariaDB 执行相似性搜索。

MariaDB 是一个使用关系数据库进行向量存储和搜索的社区开发的开源关系数据库管理系统。

前提条件

运行 MariaDB 11.7.0 或更高版本的 MariaDB 实例。有以下选项可用：

自动配置

注意

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

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

Maven

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

或者添加到您的 Gradle build.gradle 构建文件中：

Gradle

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

提示

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

提示

请参考工件仓库部分，将 Maven Central 和/或 Snapshot 仓库添加到您的构建文件中。

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

注意

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

请查看向量存储的配置参数列表，了解默认值和配置选项。

此外，您需要一个配置的 EmbeddingModel bean。有关更多信息，请参阅 EmbeddingModel 部分。

现在您可以在应用程序中自动装配 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 = this.vectorStore.similaritySearch(SearchRequest.builder().query("Spring").topK(5).build());

配置属性

要连接到 MariaDB 并使用 MariaDBVectorStore，您需要为实例提供访问详细信息。可以通过 Spring Boot 的 application.yml 提供简单配置：

spring:
  datasource:
    url: jdbc:mariadb://localhost:3306/mydb
    username: <your mariadb username>
    password: <your mariadb password>
  ai:
    vectorstore:
      mariadb:
        initialize-schema: true
        index-name: custom-index
        dimensions: 1536
        similarity: cosine

以 spring.datasource.* 开头的 Spring Boot 属性用于配置 MariaDB 数据源连接：

属性描述默认值
spring.datasource.url数据库连接的 JDBC URLjdbc:mariadb://localhost:3306/database
spring.datasource.username数据库登录用户名-
spring.datasource.password数据库登录密码-
spring.datasource.driver-class-nameJDBC 驱动程序的完全限定名称org.mariadb.jdbc.Driver

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

属性描述默认值
spring.ai.vectorstore.mariadb.initialize-schema是否初始化所需模式false
spring.ai.vectorstore.mariadb.table-name用于存储向量的表名称vector_store
spring.ai.vectorstore.mariadb.dimensions向量中的维度数1536
spring.ai.vectorstore.mariadb.similarity要使用的相似度函数cosine
spring.ai.vectorstore.mariadb.remove-existing-vector-store-table在初始化之前删除现有的向量存储表false

以下相似度函数可用：

  • cosine - 默认值，适用于大多数用例。测量向量之间的余弦相似度。
  • l2_norm - 向量之间的欧几里得距离。较低的值表示较高的相似度。
  • dot_product - 对于归一化向量（如 OpenAI 嵌入）具有最佳性能。

有关每种函数的更多详细信息，请参阅 MariaDB 文档关于向量距离函数的内容。

手动配置

不使用 Spring Boot 自动配置，您可以手动配置 MariaDB 向量存储。为此，您需要将 spring-ai-mariadb-store 添加到您的项目中：

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

或者添加到您的 Gradle build.gradle 构建文件中：

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

创建 MariaDB DataSource bean。阅读 Spring Boot 数据源配置文档获取有关自定义数据源配置的更深入信息。

@Bean
public DataSource mariaDbDataSource() {
    return new HikariDataSource();
}

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

@Bean
public VectorStore vectorStore(DataSource dataSource, EmbeddingModel embeddingModel) {
    return MariaDBVectorStore.builder(dataSource, embeddingModel)
        .initializeSchema(true)               // 可选：默认为 false
        .indexName("custom-index")            // 可选：默认为 "spring-ai-document-index"
        .similarityEngine(COSINE)             // 可选：默认为 COSINE
        .dimensions(1536)                     // 可选：默认为模型维度或 1536
        .distanceType(DistanceType.COSINE)    // 可选：默认为 COSINE
        .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 路径表达式。

例如，这个可移植的过滤器表达式：

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

被转换为专有的 MariaDB 过滤器格式：

JSON_SEARCH(metadata, 'one', '$[*] ? (@.author == "john" || @.author == "jill")') IS NOT NULL
 AND JSON_SEARCH(metadata, 'one', '$[*] ? (@.article_type == "blog")') IS NOT NULL

相似度得分

MariaDB 向量存储也允许访问返回的文档的相似度得分。

例如：

List<Document> documents = List.of(
    new Document("hello", Map.of("id", "123")),
    new Document("hi", Map.of("id", "456")));

vectorStore.add(documents);

List<Document> results = vectorStore.similaritySearch("hello");
Document resultDoc = results.get(0);

Double distance = (Double) resultDoc.getMetadata().get("distance");

上面，距离得分存储在元数据映射中。此得分表示文档内容与查询向量的距离，范围在 [0, 1] 之间，其中 0 表示完全相似。

相似度得分是通过将原始距离值缩放到 [0, 1] 范围来计算的，使用以下公式：

  • 对于 cosine 相似度：similarity = 1 - cosine_distance
  • 对于 dot_product 相似度：similarity = 1 - dot_product_distance
  • 对于 l2_norm 相似度：similarity = 1 - l2_norm_distance

有关距离函数的更多详细信息，请参阅 MariaDB 文档。

访问原生客户端

MariaDB 向量存储实现通过 getNativeClient() 方法提供对底层原生 JdbcTemplate 客户端的访问：

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

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

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

avatar
文章
阅读
粉丝