跳到主要内容

Redis

Deepseek 3.2 中英对照 Redis

本节将引导你完成设置 RedisVectorStore 的过程，以存储文档嵌入向量并执行相似性搜索。

Redis 是一款开源（基于 BSD 许可）的内存数据结构存储系统，可用作数据库、缓存、消息代理和流处理引擎。Redis 提供的数据结构包括字符串、哈希、列表、集合、带范围查询的有序集合、位图、基数估计、地理空间索引和流。

Redis Search and Query 扩展了 Redis OSS 的核心功能，允许你将 Redis 用作向量数据库：

  • 在哈希或JSON文档中存储向量及其关联元数据

  • 检索向量

  • 执行向量搜索

先决条件​

  1. 一个 Redis Stack 实例

  2. 一个用于计算文档嵌入的 EmbeddingModel 实例。有多个选项可用：

    • 如果需要，需要一个 EmbeddingModel 的 API 密钥来生成由 RedisVectorStore 存储的嵌入向量。

自动配置​

备注

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

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

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

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

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

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

提示

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

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

:::注意
这是一个重大变更！在早期版本的 Spring AI 中，默认会执行此模式初始化。
:::

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

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

现在你可以在应用程序中自动装配 RedisVectorStore 作为向量存储。

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

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

配置属性​

要连接到 Redis 并使用 RedisVectorStore，您需要提供 Redis 实例的访问信息。可以通过 Spring Boot 的 application.yml 配置文件提供简单的配置，

spring:
  data:
    redis:
      url: <redis instance url>
  ai:
    vectorstore:
      redis:
        initialize-schema: true
        index-name: custom-index
        prefix: custom-prefix

对于Redis连接配置，也可以通过Spring Boot的 application.properties 文件提供简单配置。

spring.data.redis.host=localhost
spring.data.redis.port=6379
spring.data.redis.username=default
spring.data.redis.password=

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

属性描述默认值
spring.ai.vectorstore.redis.initialize-schema是否初始化所需的模式false
spring.ai.vectorstore.redis.index-name用于存储向量的索引名称spring-ai-index
spring.ai.vectorstore.redis.prefixRedis 键的前缀embedding:

元数据过滤​

您也可以利用通用的、可移植的元数据过滤器与 Redis 配合使用。

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

vectorStore.similaritySearch(SearchRequest.builder()
        .query("The World")
        .topK(TOP_K)
        .similarityThreshold(SIMILARITY_THRESHOLD)
        .filterExpression("country in ['UK', 'NL'] && year >= 2020").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("country", "UK", "NL"),
                b.gte("year", 2020)).build()).build());
备注

这些（可移植的）过滤表达式会自动转换为 Redis 搜索查询。

例如，以下便携式过滤器表达式：

country in ['UK', 'NL'] && year >= 2020

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

@country:{UK | NL} @year:[2020 inf]

手动配置​

除了使用Spring Boot的自动配置外，您也可以手动配置Redis向量存储。为此，您需要在项目中添加spring-ai-redis-store依赖：

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

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

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

创建一个 JedisPooled bean：

@Bean
public JedisPooled jedisPooled() {
    return new JedisPooled("<host>", 6379);
}

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

@Bean
public VectorStore vectorStore(JedisPooled jedisPooled, EmbeddingModel embeddingModel) {
    return RedisVectorStore.builder(jedisPooled, embeddingModel)
        .indexName("custom-index")                // Optional: defaults to "spring-ai-index"
        .prefix("custom-prefix")                  // Optional: defaults to "embedding:"
        .metadataFields(                         // Optional: define metadata fields for filtering
            MetadataField.tag("country"),
            MetadataField.numeric("year"))
        .initializeSchema(true)                   // Optional: defaults to false
        .batchingStrategy(new TokenCountBatchingStrategy()) // Optional: defaults to TokenCountBatchingStrategy
        .build();
}

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

你必须明确列出过滤表达式中使用的所有元数据字段的名称和类型（TAG、TEXT 或 NUMERIC）。上面的 metadataFields 注册了可过滤的元数据字段：类型为 TAG 的 country，以及类型为 NUMERIC 的 year。

访问原生客户端​

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

RedisVectorStore vectorStore = context.getBean(RedisVectorStore.class);
Optional<JedisPooled> nativeClient = vectorStore.getNativeClient();

if (nativeClient.isPresent()) {
    JedisPooled jedis = nativeClient.get();
    // Use the native client for Redis-specific operations
}

原生客户端让你能够访问Redis特有的功能和操作，这些可能无法通过VectorStore接口实现。