Redis（开源）

Redis

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

Redis 是什么？

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

Redis Vector Search 是什么？

Redis Search and Query 扩展了 Redis 开源版的核心功能，使您能够将 Redis 用作向量数据库：

• 将向量及其关联元数据存储在哈希或 JSON 文档中
• 检索向量
• 执行向量搜索

先决条件

• 一个 Redis Stack 实例
  • Redis Cloud (推荐)
  • Docker 镜像 ： redis/redis-stack:latest
• 用于计算文档嵌入的 EmbeddingModel 实例。有多种选项可供选择：
  如需要，可为 EmbeddingModel 提供 API 密钥，以生成由 RedisVectorStore 存储的嵌入向量。

自动配置

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

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

此外，您还需要一个配置好的 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：

元数据过滤

您同样可以利用 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());

例如，此便携式筛选表达式：

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")));
}

访问原生客户端

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
}

原生客户端让您能够访问 Redis 特有的功能和操作，这些可能未通过 VectorStore 接口公开。