Redis

本节将引导您设置 RedisVectorStore 以存储文档嵌入并执行相似性搜索。 Redis 是一个开源（BSD 许可）、内存中的数据结构存储，用作数据库、缓存、消息代理和流引擎。Redis 提供了字符串、哈希、列表、集合、带范围查询的有序集合、位图、HyperLogLog、地理空间索引和流等数据结构。 Redis 搜索和查询 扩展了 Redis OSS 的核心功能，允许您将 Redis 用作向量数据库：

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

  • 检索向量

  • 执行向量搜索

先决条件

  1. 一个 Redis Stack 实例

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

    • 如果需要，EmbeddingModel 的 API 密钥，用于生成由 RedisVectorStore 存储的嵌入。

自动配置

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

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 和/或快照仓库添加到您的构建文件中。

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

这是一个重大更改！在早期版本的 Spring AI 中，此模式初始化是默认发生的。

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

此外，您还需要一个已配置的 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，您需要提供实例的访问详细信息。 一个简单的配置可以通过 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.prefix

Redis 键的前缀

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 向量存储实现通过 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
}

原生客户端允许您访问 VectorStore 接口可能未公开的 Redis 特定功能和操作。