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. 嵌入模型实例用于计算文档嵌入。有几种选择：spring-doc.cadn.net.cn

自动配置

春季AI自动配置、起始模块的工件名称发生了重大变化。 更多信息请参阅升级说明。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>

或者去你的Gradlebuild.gradle构建文件。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-vector-store-redis'
}
请参考依赖管理部分，将Spring AI的物料清单添加到你的构建文件中。
请参阅“遗物仓库”部分，将Maven Central和/或快照仓库添加到你的构建文件中。

向量存储实现可以帮你初始化所需的模式，但你必须通过指定初始化模式在适当的构造函数中进行布尔值，或通过设置…​initialize-schema=true在application.properties文件。spring-doc.cadn.net.cn

这是一个颠覆性的变革！在早期版本的 Spring AI 中，这种模式初始化是默认的。

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

此外，你还需要一个配置嵌入模型豆。 更多信息请参阅嵌入模型部分。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

春季-AI-索引spring-doc.cadn.net.cn

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

Redis 密钥的前缀spring-doc.cadn.net.cn

嵌入：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());

或者程序化地使用滤波。表达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 的搜索查询。

例如，这个可移植的Filter表达式：spring-doc.cadn.net.cn

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

转换为专有的 Redis Filter格式：spring-doc.cadn.net.cn

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

手动配置

你可以手动配置 Redis 向量存储，而不是用 Spring Boot 的自动配置。为此你需要添加春艾重写商店致你的项目：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'
}

创建一个绝地战池豆：spring-doc.cadn.net.cn

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

然后创建RedisVectorStore使用构建图纸的豆子：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")));
}

你必须明确列出所有元数据字段名称和类型（标记,文本或数值的）用于过滤表达式中的任何元数据字段。 这元数据字段上方寄存器可过滤元数据字段：状态类型标记,年类型数值的.spring-doc.cadn.net.cn

访问本地客户端

Redis 向量存储实现提供了对底层原生 Redis 客户端的访问（绝地战池）通过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