Redis

本节将引导您设置 RedisVectorStore 来存储文档 embedding 并执行相似度搜索。

Redis 是一个开源的（BSD 许可证）、内存数据结构存储，用作数据库、缓存、消息代理和流处理引擎。Redis 提供字符串、哈希、列表、集合、有序集合（带范围查询）、位图、HyperLogLogs、地理空间索引和流等数据结构。

Redis Search and Query 扩展了 Redis OSS 的核心功能，允许您将 Redis 用作向量数据库

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

先决条件

Redis Stack 实例
- Redis Cloud (推荐)
- Docker 镜像 redis/redis-stack:latest
EmbeddingModel 实例，用于计算文档 embedding。有多种选项可用
- 如果需要，EmbeddingModel 的 API 密钥，用于生成由 RedisVectorStore 存储的 embedding。

自动配置

Spring AI 自动配置、starter 模块的 artifact 名称发生了重大变化。请参阅升级注意事项以获取更多信息。

Spring AI 为 Redis Vector Store 提供了 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 和/或 Snapshot 仓库添加到您的构建文件。

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

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

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

此外，您还需要一个配置好的 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`	是否初始化所需的 schema	`false`
`spring.ai.vectorstore.redis.index-name`	存储向量的索引名称	`spring-ai-index`
`spring.ai.vectorstore.redis.prefix`	Redis 键的前缀	`embedding`

spring.ai.vectorstore.redis.initialize-schema

是否初始化所需的 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 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
}

原生客户端允许您访问 Redis 特有的功能和操作，这些功能和操作可能不会通过 VectorStore 接口暴露。