跳到主要内容

Redis

DeepSeek V3 中英对照 Redis

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

Redis 是一个开源的（BSD 许可）、内存中的数据结构存储，用作数据库、缓存、消息代理和流处理引擎。Redis 提供了多种数据结构，如字符串（strings）、哈希（hashes）、列表（lists）、集合（sets）、有序集合（sorted sets）支持范围查询、位图（bitmaps）、基数统计（hyperloglogs）、地理空间索引（geospatial indexes）和流（streams）。

Redis 搜索与查询 扩展了 Redis OSS 的核心功能，允许你将 Redis 用作向量数据库：

  • 将向量和相关的元数据存储在哈希或 JSON 文档中

  • 检索向量

  • 执行向量搜索

先决条件​

  1. 一个 Redis Stack 实例

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

    • 如果需要，可以为 EmbeddingModel 提供一个 API 密钥，以生成由 RedisVectorStore 存储的嵌入。

自动配置​

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

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

或者到你的 Gradle build.gradle 构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-redis-store-spring-boot-starter'
}
groovy
提示

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

提示

请参考 Repositories 部分，将 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());
java

配置属性​

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

spring:
  data:
    redis:
      uri: <redis instance uri>
  ai:
    vectorstore:
      redis:
        initialize-schema: true
        index-name: custom-index
        prefix: custom-prefix
        batching-strategy: TOKEN_COUNT # Optional: Controls how documents are batched for embedding
yaml

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

属性描述默认值
spring.ai.vectorstore.redis.initialize-schema是否初始化所需的 schemafalse
spring.ai.vectorstore.redis.index-name存储向量的索引名称spring-ai-index
spring.ai.vectorstore.redis.prefixRedis 键的前缀embedding:
spring.ai.vectorstore.redis.batching-strategy计算嵌入时文档批处理的策略。选项为 TOKEN_COUNT 或 FIXED_SIZETOKEN_COUNT

元数据过滤​

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

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

vectorStore.similaritySearch(SearchRequest.builder()
        .query("The World")
        .topK(TOP_K)
        .similarityThreshold(SIMILARITY_THRESHOLD)
        .filterExpression("country in ['UK', 'NL'] && year >= 2020").build());
java

或者通过编程方式使用 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());
java
备注

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

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

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

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

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

手动配置​

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

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

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

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

创建一个 JedisPooled bean：

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

然后使用构建器模式创建 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")));
}
java

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

访问 Native Client​

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
}
java

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