如需最新的快照版本，请使用 Spring AI 1.1.3！spring-doc.cadn.net.cn

Redis

本节将指导您设置 RedisVectorStore 以存储文档嵌入并执行相似性搜索。spring-doc.cadn.net.cn

Redis 是一个开源（BSD许可）、内存中的数据结构存储系统，可用作数据库、缓存、消息代理和流引擎。Redis提供了诸如字符串、哈希、列表、集合、带范围查询的有序集合、位图、超日志、地理空间索引和流等数据结构。spring-doc.cadn.net.cn

Redis 搜索与查询 扩展了 Redis OSS 的核心功能，并允许您将 Redis 用作向量数据库：spring-doc.cadn.net.cn

前置条件

  1. 一个 Redis Stack 实例spring-doc.cadn.net.cn

  2. EmbeddingModel 实例用于计算文档嵌入。有几种选项可供选择：spring-doc.cadn.net.cn

Auto-configuration

Spring AI自动配置和starter模块的artifact名称有了重大变化。 请参阅升级说明获取更多信息。spring-doc.cadn.net.cn

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

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

请将以下内容添加到您的Gradle build.gradle 构建文件中。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-vector-store-redis'
}
请参阅依赖管理部分，将Spring AI BOM添加到您的构建文件中。
请参阅 构件仓库 部分，将 Maven 中央仓库和/或快照仓库添加到您的构建文件中。

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

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

请查看 向量存储的配置参数 列表，以了解默认值和配置选项。spring-doc.cadn.net.cn

此外，您还需要一个已配置的 EmbeddingModel bean。有关更多信息，请参阅 EmbeddingModel 部分。spring-doc.cadn.net.cn

现在你可以在你的应用程序中自动装配RedisVectorStore作为向量存储。spring-doc.cadn.net.cn

@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-doc.cadn.net.cn

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-doc.cadn.net.cn

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-doc.cadn.net.cn

<property> </property> <description> </description> 默认值

spring.ai.vectorstore.redis.initialize-schemaspring-doc.cadn.net.cn

是否初始化所需的模式spring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

spring.ai.vectorstore.redis.index-namespring-doc.cadn.net.cn

用于存储向量的索引名称spring-doc.cadn.net.cn

spring-ai-indexspring-doc.cadn.net.cn

spring.ai.vectorstore.redis.prefixspring-doc.cadn.net.cn

Redis 键的前缀spring-doc.cadn.net.cn

embedding:spring-doc.cadn.net.cn

元数据过滤

您也可以利用通用的、可移植的 元数据过滤器 与 Redis 一起使用。spring-doc.cadn.net.cn

例如，您可以使用文本表达式语言：spring-doc.cadn.net.cn

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

或以编程方式使用 Filter.Expression DSL：spring-doc.cadn.net.cn

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 搜索查询。

例如，此可移植的过滤器表达式：spring-doc.cadn.net.cn

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

被转换为专有的 Redis 过滤器格式：spring-doc.cadn.net.cn

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

手动配置

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

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

请将以下内容添加到您的Gradle build.gradle 构建文件中。spring-doc.cadn.net.cn

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

创建一个 JedisPooled bean：spring-doc.cadn.net.cn

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

然后使用构建器模式创建 RedisVectorStore bean：spring-doc.cadn.net.cn

@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。spring-doc.cadn.net.cn

访问原生客户端

Redis 向量存储实现通过 JedisPooled 方法提供对底层原生 Redis 客户端（JedisPooled）的访问：spring-doc.cadn.net.cn

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 特定功能和操作。spring-doc.cadn.net.cn