Redis

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

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

Redis Search and Query 扩展了 Redis OSS 的核心特性，允许您将 Redis 用作向量数据库：spring-doc.cadn.net.cn

前提条件

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

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

自动配置

Spring AI 自动配置、入门模块的工件名称发生了重大变化。 有关更多信息，请参阅升级说明。spring-doc.cadn.net.cn

Spring AI 为 Redis Vector Store 提供 Spring Boot 自动配置。 要启用它，请将以下依赖项添加到项目的 Mavenpom.xml文件：spring-doc.cadn.net.cn

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

或 Gradlebuild.gradle构建文件。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-vector-store-redis'
}
请参阅依赖项管理部分，将 Spring AI BOM 添加到构建文件中。
请参阅 Artifact Repositories 部分，将 Maven Central 和/或 Snapshot Repositories 添加到构建文件中。

矢量存储实现可以为您初始化必要的架构，但您必须通过指定initializeSchema布尔值或通过…​initialize-schema=true在application.properties文件。spring-doc.cadn.net.cn

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

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

此外，您还需要配置一个EmbeddingModel豆。有关详细信息，请参阅 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

属性 描述 默认值

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.ExpressionDSL：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]

手动配置

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

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

或 Gradlebuild.gradle构建文件。spring-doc.cadn.net.cn

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

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

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

然后创建RedisVectorStorebean 使用构建器模式：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上面寄存器可过滤的元数据字段：country类型TAG,year类型NUMERIC.spring-doc.cadn.net.cn

访问本机客户端

Redis 向量存储实现提供对底层本机 Redis 客户端 （JedisPooled） 通过getNativeClient()方法：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
}

本机客户端允许您访问特定于 Redis 的功能和作，这些功能和作可能不会通过VectorStore接口。spring-doc.cadn.net.cn