Redis

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

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

Redis 搜索和查询扩展了 Redis OSS 的核心功能，并允许您将 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-transformers-spring-boot-starter</artifactId>
</dependency>

或添加到 Gradle build.gradle 构建文件。

dependencies {
    implementation 'org.springframework.ai:spring-ai-transformers-spring-boot-starter'
}

请参阅依赖项管理部分，将 Spring AI BOM 添加到构建文件中。

请参阅存储库部分，将里程碑和/或快照存储库添加到构建文件中。

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

这是一个重大更改！在 Spring AI 的早期版本中，此架构初始化默认发生。

此外，您将需要一个已配置的 EmbeddingModel Bean。有关更多信息，请参阅EmbeddingModel部分。

以下是所需 Bean 的示例

@Bean
public EmbeddingModel embeddingModel() {
    // Can be any other EmbeddingModel implementation.
    return new OpenAiEmbeddingModel(new OpenAiApi(System.getenv("SPRING_AI_OPENAI_API_KEY")));
}

要连接到 Redis，您需要提供实例的访问详细信息。可以通过 Spring Boot 的 application.properties 提供一个简单的配置，

spring.ai.vectorstore.redis.uri=<your redis instance uri>
spring.ai.vectorstore.redis.index=<your index name>
spring.ai.vectorstore.redis.prefix=<your prefix>

# API key if needed, e.g. OpenAI
spring.ai.openai.api.key=<api-key>

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

现在，您可以在应用程序中自动装配 Redis 向量存储并使用它

@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(List.of(document));

// Retrieve documents similar to a query
List<Document> results = vectorStore.similaritySearch(SearchRequest.query("Spring").withTopK(5));

配置属性

您可以在 Spring Boot 配置中使用以下属性来自定义 Redis 向量存储。

属性说明默认值

属性	说明	默认值
`spring.ai.vectorstore.redis.uri`	服务器连接 URI	`redis://127.0.0.1:6379`
`spring.ai.vectorstore.redis.index`	索引名称	`default-index`
`spring.ai.vectorstore.redis.initialize-schema`	是否初始化必需的架构	`false`
`spring.ai.vectorstore.redis.prefix`	前缀	`default`

spring.ai.vectorstore.redis.uri

服务器连接 URI

redis://127.0.0.1:6379

spring.ai.vectorstore.redis.index

索引名称

default-index

spring.ai.vectorstore.redis.initialize-schema

是否初始化必需的架构

false

spring.ai.vectorstore.redis.prefix

前缀

default

元数据过滤

您还可以将通用、可移植的元数据过滤器与 RedisVectorStore 一起使用。

例如，您可以使用文本表达式语言

vectorStore.similaritySearch(
   SearchRequest
      .query("The World")
      .withTopK(TOP_K)
      .withSimilarityThreshold(SIMILARITY_THRESHOLD)
      .withFilterExpression("country in ['UK', 'NL'] && year >= 2020"));

或使用表达式 DSL 以编程方式

FilterExpressionBuilder b = new FilterExpressionBuilder();

vectorStore.similaritySearch(
   SearchRequest
      .query("The World")
      .withTopK(TOP_K)
      .withSimilarityThreshold(SIMILARITY_THRESHOLD)
      .withFilterExpression(b.and(
         b.in("country", "UK", "NL"),
         b.gte("year", 2020)).build()));

可移植的过滤器表达式会自动转换为Redis 搜索查询。例如，以下可移植过滤器表达式

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

转换为 Redis 查询

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

手动配置

如果您不想使用自动配置，则可以手动配置 Redis 向量存储。添加 Redis 向量存储和 Jedis 依赖项

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

<dependency>
    <groupId>redis.clients</groupId>
    <artifactId>jedis</artifactId>
    <version>5.1.0</version>
</dependency>

请参阅依赖项管理部分，将 Spring AI BOM 添加到构建文件中。

然后，在 Spring 配置中创建一个 RedisVectorStore bean

@Bean
public VectorStore vectorStore(EmbeddingModel embeddingModel) {
  RedisVectorStoreConfig config = RedisVectorStoreConfig.builder()
     .withURI("redis://127.0.0.1:6379")
     // Define the metadata fields to be used
     // in the similarity search filters.
     .withMetadataFields(
        MetadataField.tag("country"),
        MetadataField.numeric("year"))
     .build();

  return new RedisVectorStore(config, embeddingModel);
}

创建 RedisVectorStore 作为 Bean 更方便且更常用。但如果你决定手动创建，则必须在设置属性后、使用客户端之前调用 RedisVectorStore#afterPropertiesSet()。

你必须明确列出所有元数据字段名称和类型（TAG、TEXT 或 NUMERIC），以便在过滤器表达式中使用任何元数据字段。上述 withMetadataFields 注册了可过滤的元数据字段：类型为 TAG 的 country，类型为 NUMERIC 的 year。

然后在你的主代码中创建一些文档

List<Document> documents = List.of(
   new Document("Spring AI rocks!! Spring AI rocks!! Spring AI rocks!! Spring AI rocks!! Spring AI rocks!!", Map.of("country", "UK", "year", 2020)),
   new Document("The World is Big and Salvation Lurks Around the Corner", Map.of()),
   new Document("You walk forward facing the past and you turn back toward the future.", Map.of("country", "NL", "year", 2023)));

现在将文档添加到你的向量存储

vectorStore.add(documents);

最后，检索与查询类似的文档

List<Document> results = vectorStore.similaritySearch(
   SearchRequest
      .query("Spring")
      .withTopK(5));

如果一切顺利，你应该检索到包含文本“Spring AI rocks!!”的文档。