Redis

このセクションでは、ドキュメントの埋め込みを保存し、類似性検索を実行するための RedisVectorStore のセットアップについて説明します。

Redis (英語) は、データベース、キャッシュ、メッセージブローカー、ストリーミングエンジンとして使用されるオープンソース (BSD ライセンス) のインメモリデータ構造ストアです。Redis は、文字列、ハッシュ、リスト、セット、範囲クエリを備えたソートセット、ビットマップ、ハイパーログログ、地理空間インデックス、ストリームなどのデータ構造を提供します。

Redis 検索とクエリ (英語) は、Redis OSS のコア機能を継承し、Redis をベクトルデータベースとして使用できるようにします。

ベクトルと関連するメタデータをハッシュまたは JSON ドキュメント内に保存します
ベクトルの取得
ベクトル検索を実行する

前提条件

Redis スタックインスタンス
- Redis クラウド (英語) (推奨)
- Docker (英語) イメージ redis/redis スタック: 最新
EmbeddingModel インスタンスを使用してドキュメントの埋め込みを計算します。いくつかのオプションが利用可能です:
- 必要に応じて、EmbeddingModel が RedisVectorStore によって保存される埋め込みを生成するための API キー。

自動構成

Spring AI は、Redis ベクトルストア用の Spring Boot 自動構成を提供します。これを有効にするには、プロジェクトの Maven pom.xml ファイルに次の依存関係を追加します。

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

または、Gradle build.gradle ビルドファイルに保存します。

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

Spring AI BOM をビルドファイルに追加するには、"依存関係管理" セクションを参照してください。

マイルストーンおよび / またはスナップショットリポジトリをビルドファイルに追加するには、リポジトリセクションを参照してください。

ベクトルストアの実装では必要なスキーマを初期化できますが、適切なコンストラクターで initializeSchema ブール値を指定するか、application.properties ファイルで …initialize-schema=true を設定することによってオプトインする必要があります。

これは重大な変更です。Spring AI の以前のバージョンでは、このスキーマの初期化はデフォルトで行われていました。

デフォルト値と構成オプションについては、ベクトルストアの構成パラメーターのリストを参照してください。

さらに、設定済みの 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:
      uri: <redis instance uri>
  ai:
    vectorstore:
      redis:
        initialize-schema: true
        index-name: custom-index
        prefix: custom-prefix
        batching-strategy: TOKEN_COUNT # Optional: Controls how documents are batched for embedding

spring.ai.vectorstore.redis.* で始まるプロパティは、RedisVectorStore を構成するために使用されます。

プロパティ説明デフォルト値

プロパティ	説明	デフォルト値
`spring.ai.vectorstore.redis.initialize-schema`	必要なスキーマを初期化するかどうか	`false`
`spring.ai.vectorstore.redis.index-name`	ベクトルを格納するインデックスの名前	`spring-ai-index`
`spring.ai.vectorstore.redis.prefix`	Redis キーのプレフィックス	`embedding:`
`spring.ai.vectorstore.redis.batching-strategy`	埋め込みを計算するときにドキュメントをバッチ処理する戦略。オプションは `TOKEN_COUNT` または `FIXED_SIZE` です	`TOKEN_COUNT`

spring.ai.vectorstore.redis.initialize-schema

必要なスキーマを初期化するかどうか

false

spring.ai.vectorstore.redis.index-name

ベクトルを格納するインデックスの名前

spring-ai-index

spring.ai.vectorstore.redis.prefix

Redis キーのプレフィックス

embedding:

spring.ai.vectorstore.redis.batching-strategy

埋め込みを計算するときにドキュメントをバッチ処理する戦略。オプションは TOKEN_COUNT または FIXED_SIZE です

TOKEN_COUNT

メタデータフィルタリング

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 ) を登録します。